1. 配置環境
Redis 4 安裝教程自行google
Spring 5.0.9
Mybatis 3.4.6
2. 依賴
注意:
- 默認你配置好了SSM的依賴環境,我只說在SSM配好過后怎么把redis加進去
- 我用的依賴是如下的版本,基本都沒有最新jar包的教程,網上的老教程千奇百怪,真的是痛心。
- 如果你不是用的spring-data-redis的2.X的版本你可以不用看了,看了也沒用。
</properties>
<jedis.version>2.9.0</jedis.version>
<redis.version>2.1.0.RELEASE</redis.version>
</properties>
<!--Redis支持-->
<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
<version>${jedis.version}</version>
</dependency>
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-redis</artifactId>
<version>${redis.version}</version>
</dependency>
3.配置
首先是redisConfig.java,哇,這個是真的一個巨坑,改動賊多。老教程根本無法使用。作為一個新手瑟瑟發抖。不多說了,先貼代碼,再解釋
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
import org.springframework.data.redis.cache.RedisCacheManager;
import org.springframework.data.redis.connection.*;
import org.springframework.data.redis.connection.jedis.JedisClientConfiguration;
import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.JdkSerializationRedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;
import redis.clients.jedis.JedisPool;
import redis.clients.jedis.JedisPoolConfig;
@Configuration
@PropertySource("classpath:config/redis.properties")
@EnableCaching
public class RedisConfig {
@Value("${redis.maxTotal}")
private int maxTotal;
@Value("${redis.maxIdle}")
private int maxIdle;
@Value("${redis.maxWaitMillis}")
private long maxWaitMillis;
@Value("${redis.testOnBorrow}")
private boolean testOnBorrow;
@Value("${redis.host}")
private String host;
@Value("${redis.port}")
private int port;
@Value("${redis.timeout}")
private int timeout;
@Value("${redis.password}")
private String password;
@Value("${redis.database}")
private int database;
@Value("${redis.minEvictableIdleTimeMillis}")
private int minEvictableIdleTimeMillis;
@Value("${redis.softMinEvictableIdleTimeMillis}")
private int softMinEvictableIdleTimeMillis;
@Value("${redis.timeBetweenEvictionRunsMillis}")
private int timeBetweenEvictionRunsMillis;
@Value("${redis.numTestsPerEvictionRun}")
private int numTestsPerEvictionRun;
@Value("${redis.blockWhenExhausted}")
private boolean blockWhenExhausted;
@Value("${redis.testWhileIdle}")
private boolean testWhileIdle;
@Bean
public JedisPoolConfig poolConfig() {
JedisPoolConfig poolConfig = new JedisPoolConfig();
poolConfig.setMaxTotal(maxTotal);
poolConfig.setMaxIdle(maxIdle);
poolConfig.setMaxWaitMillis(maxWaitMillis);
poolConfig.setTestOnBorrow(testOnBorrow);
poolConfig.setMinEvictableIdleTimeMillis(minEvictableIdleTimeMillis);
poolConfig.setMinEvictableIdleTimeMillis(minEvictableIdleTimeMillis);
poolConfig.setSoftMinEvictableIdleTimeMillis(softMinEvictableIdleTimeMillis);
poolConfig.setTimeBetweenEvictionRunsMillis(timeBetweenEvictionRunsMillis);
poolConfig.setNumTestsPerEvictionRun(numTestsPerEvictionRun);
poolConfig.setBlockWhenExhausted(blockWhenExhausted);
poolConfig.setTestWhileIdle(testWhileIdle);
return poolConfig;
}
//這個是個巨坑
@Bean
public JedisConnectionFactory jedisConnectionFactory(JedisPoolConfig jedisPoolConfig) {
RedisStandaloneConfiguration configuration = new RedisStandaloneConfiguration();
configuration.setHostName(host);
configuration.setPort(port);
//如果沒有密碼可以不設置,要注意密碼要用RedisPassword類
configuration.setPassword(RedisPassword.of(password));
configuration.setDatabase(database);
//獲得默認的連接池構造
//JedisConnectionFactory對于Standalone模式的沒有(RedisStandaloneConfiguration,JedisPoolConfig)的構造函數,
//所以用JedisClientConfiguration接口的builder方法實例化一個構造器,還得類型轉換
JedisClientConfiguration.JedisPoolingClientConfigurationBuilder jpcf =
(JedisClientConfiguration.JedisPoolingClientConfigurationBuilder) JedisClientConfiguration.builder();
//修改我們的連接池配置
jpcf.poolConfig(jedisPoolConfig);
//通過構造器來構造jedis客戶端配置
JedisClientConfiguration jedisClientConfiguration = jpcf.build();
return new JedisConnectionFactory(configuration, jedisClientConfiguration);
}
@Bean
public RedisTemplate redisTemplate(RedisConnectionFactory redisConnectionFactory) {
RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
redisTemplate.setConnectionFactory(redisConnectionFactory);
//序列化
redisTemplate.setKeySerializer(new StringRedisSerializer());
redisTemplate.setHashKeySerializer(new StringRedisSerializer());
redisTemplate.setValueSerializer(new JdkSerializationRedisSerializer());
redisTemplate.setHashValueSerializer(new JdkSerializationRedisSerializer());
return redisTemplate;
}
@Bean
public RedisCacheManager cacheManager(JedisConnectionFactory jedisConnectionFactory) {
//這里是個坑,老方法已經過時了,用下面方法替代
return RedisCacheManager.create(jedisConnectionFactory);
}
}
講講那個巨坑JedisConnectionFactory
- 以前的版本是沒有利用RedisStandaloneConfiguration來配置的,我看了幾個教程的結果,應該是2.X的版本加進來的。賊難受。
- 有的教程的JedisConnectionFactory是沒有把jedisPoolConfig加進去的。結合幾個老教程和Spring boot我個人覺得是應該吧jedisPoolConfig的配置加載進去不然應該不能工作。所以我就找了很多教程,發現其中有個教程就用了現在代碼中的方法加了進去
- password需要用到RedisPassword.of(password)做下轉換
redis.properties配置文件如下
##########################
## redis緩存配置
##########################
# redis主機IP
redis.host=127.0.0.1
# redis端口
redis.port=6379
# 鏈接超時
redis.timeout=2000
# 密碼 如果你沒有設置密碼 這個配置可以不設置
redis.password=XXXXX
# 指定redis數據庫
redis.database=0
##########################
## redis連接池配置
##########################
# 最大連接數
redis.maxTotal=30
# 最大空閑連接數
redis.maxIdle=10
# 獲取鏈接最大等待毫秒
redis.maxWaitMillis=1000
# 獲取鏈接時檢查有效性
redis.testOnBorrow=true
# 在空閑時監測有效性
redis.testWhileIdle=true
# 鏈接耗盡時是否阻塞
redis.blockWhenExhausted=true
# 每次釋放鏈接的最大數目
redis.numTestsPerEvictionRun=1024
# 釋放鏈接的掃描間隔(毫秒)
redis.timeBetweenEvictionRunsMillis=30000
# 最小空閑時間
redis.minEvictableIdleTimeMillis=1800000
# 鏈接空閑多久后釋放
redis.softMinEvictableIdleTimeMillis=10000
在RootConfig.java(根據你的項目來)中加入下列代碼,導入RedisConfig.java(我數據庫的使用的Druid如果沒有分開 Druid是可以不要的)
@Import({DruidDataSourceConfig.class, RedisConfig.class})
隨后 定義一個RedisCache類實現Cache接口
import org.apache.ibatis.cache.Cache;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.connection.RedisConnection;
import org.springframework.data.redis.connection.jedis.JedisConnection;
import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;
import org.springframework.data.redis.serializer.JdkSerializationRedisSerializer;
import org.springframework.data.redis.serializer.RedisSerializer;
import org.springframework.stereotype.Component;
import redis.clients.jedis.exceptions.JedisConnectionException;
import java.util.concurrent.locks.ReadWriteLock;
import java.util.concurrent.locks.ReentrantReadWriteLock;
public final class RedisCache implements Cache {
private static JedisConnectionFactory redisConnectionFactory;
private final String id;
public static void setJedisConnectionFactory(JedisConnectionFactory jedisConnectionFactory) {
RedisCache.redisConnectionFactory = jedisConnectionFactory;
}
/**
* The {@code ReadWriteLock}.
*/
private final ReadWriteLock readWriteLock = new ReentrantReadWriteLock();
public RedisCache(final String id) {
if (id == null) {
throw new IllegalArgumentException("Cache instances require an ID");
}
this.id = id;
}
@Override
public void clear() {
RedisConnection connection = null;
try {
connection = redisConnectionFactory.getConnection();
connection.flushDb();
connection.flushAll();
} catch (JedisConnectionException e) {
e.printStackTrace();
} finally {
if (connection != null) {
connection.close();
}
}
}
@Override
public String getId() {
return this.id;
}
@Override
public Object getObject(Object key) {
Object result = null;
RedisConnection connection = null;
try {
connection = redisConnectionFactory.getConnection();
RedisSerializer<Object> serializer = new JdkSerializationRedisSerializer();
result = serializer.deserialize(connection.get(serializer.serialize(key)));
} catch (JedisConnectionException e) {
e.printStackTrace();
} finally {
if (connection != null) {
connection.close();
}
}
return result;
}
@Override
public ReadWriteLock getReadWriteLock() {
return this.readWriteLock;
}
@Override
public int getSize() {
int result = 0;
RedisConnection connection = null;
try {
connection = redisConnectionFactory.getConnection();
result = Integer.valueOf(connection.dbSize().toString());
} catch (JedisConnectionException e) {
e.printStackTrace();
} finally {
if (connection != null) {
connection.close();
}
}
return result;
}
@Override
public void putObject(Object key, Object value) {
RedisConnection connection = null;
try {
connection = redisConnectionFactory.getConnection();
RedisSerializer<Object> serializer = new JdkSerializationRedisSerializer();
connection.set(serializer.serialize(key), serializer.serialize(value));
} catch (JedisConnectionException e) {
e.printStackTrace();
} finally {
if (connection != null) {
connection.close();
}
}
}
@Override
public Object removeObject(Object key) {
RedisConnection connection = null;
Object result = null;
try {
connection = redisConnectionFactory.getConnection();
RedisSerializer<Object> serializer = new JdkSerializationRedisSerializer();
result = connection.expire(serializer.serialize(key), 0);
} catch (JedisConnectionException e) {
e.printStackTrace();
} finally {
if (connection != null) {
connection.close();
}
}
return result;
}
}
用另外一個類 注入jedisConnectionFactory
import lombok.Data;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;
import org.springframework.stereotype.Component;
@Component
public class RedisCacheTransfer {
@Autowired
public void setJedisConnectionFactory(JedisConnectionFactory jedisConnectionFactory) {
RedisCache.setJedisConnectionFactory(jedisConnectionFactory);
}
}
然后你需要在mybatis中開啟cache
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<!-- 配置全局屬性 -->
<settings>
<!--<!– 使用jdbc的getGeneratedKeys獲取數據庫自增主鍵值 –>-->
<!--<setting name="useGeneratedKeys" value="true" />-->
<!--允許cache-->
<setting name="cacheEnabled" value="true"/>
<!-- 使用列標簽替換列名 默認:true -->
<setting name="useColumnLabel" value="true"/>
<!-- 開啟駝峰命名轉換:Table{create_time} -> Entity{createTime} -->
<setting name="mapUnderscoreToCamelCase" value="true"/>
<!-- 打印查詢語句 -->
<setting name="logImpl" value="STDOUT_LOGGING"/>
</settings>
</configuration>
這個是我的配置文件,可以不同,根據你的需要來,你只需添加 允許cache的那一條就可以了。
另外如果你沒有配置文件 可在配置數據庫中加上
public SqlSessionFactoryBean sqlSessionFactoryBean(DataSource dataSource) throws IOException {
SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
sqlSessionFactoryBean.setDataSource(dataSource);
sqlSessionFactoryBean.setConfigLocation(resolver.getResource(CONFIG_LOCATION));
sqlSessionFactoryBean.setMapperLocations(resolver.getResources(MAPPER_LOCATION));
sqlSessionFactoryBean.setTypeAliasesPackage("io.ilss.entity");
return sqlSessionFactoryBean;
}
當中的resolver是加載配置文件和Mapper的xml文件用的。其中的兩個常量(我定義在Constants中)是下面的
/**
* 數據庫相關
*/
public static String CONFIG_LOCATION = "classpath:config/mybatis_config.xml";
public static String MAPPER_LOCATION = "classpath:mappers/*.xml";
最后你只需要在你想用cache的表的Mapper的xml文件的頭上加上如下配置就OK了
<mapper namespace="com.example.dao.UserDao">
<!--緩存設置-->
<cache type="io.ilss.commons.RedisCache"/>
.....其他省略,自行配置
如果是用純dao層注解的,加上相關的cache注解就好了。
接下來,你就可以去測試操作相對應表數據了。
你會看到如下類似日志
Cache Hit Ratio [XXXXXXX.XXXXDao]: 0.3333333333333333