實(shí)戰(zhàn)出真知扯再，作文以記之。
解決的主要痛點(diǎn)
- 以SpringBoot2.0.2為背景
- 通用的序列化和反序列化設(shè)置
使用Jackson2JsonRedisSerializer進(jìn)行序列化與反序列化。 - 解決緩存中的亂碼問(wèn)題
- 詳細(xì)的使用說(shuō)明
- 齊全的使用示例
創(chuàng)建Spring Boot工程
略车猬，詳細(xì)步驟可參考使用STS創(chuàng)建Spring Boot 項(xiàng)目门躯。
添加Maven依賴
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-cache</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
</dependency>
Redis的配置參數(shù)
在application.properties中加入以下配置參數(shù)
# 緩存時(shí)長(zhǎng)淆党，單位秒
cache.default-exp=72
# 數(shù)據(jù)庫(kù)設(shè)置
spring.redis.database=0
# 宿主機(jī)IP
spring.redis.host=127.0.0.1
# 端口號(hào)
spring.redis.port=6379
# 密碼
spring.redis.password=redis
# 連接超時(shí)時(shí)間 單位 ms（毫秒）
spring.redis.timeout=3000
# 連接池中的最大空閑連接，默認(rèn)值也是8
spring.redis.lettuce.pool.max-idle=100
# 連接池中的最小空閑連接讶凉，默認(rèn)值也是0
spring.redis.lettuce.pool.min-idle=50
# 如果賦值為-1染乌，則表示不限制
spring.redis.lettuce.pool.max-wait=2000
使用注解配置Redis
創(chuàng)建一個(gè)名為RedisConfig的class并繼承CachingConfigurerSupport，注意需要在class上添加@Configuration和@EnableCaching注解懂讯。
import java.lang.reflect.Method;
import java.time.Duration;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cache.CacheManager;
import org.springframework.cache.annotation.CachingConfigurerSupport;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.cache.interceptor.KeyGenerator;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.cache.RedisCacheConfiguration;
import org.springframework.data.redis.cache.RedisCacheManager;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.RedisSerializationContext;
import org.springframework.data.redis.serializer.RedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;
import com.alibaba.fastjson.JSON;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
@Configuration
@EnableCaching
public class RedisConfig extends CachingConfigurerSupport {
@Value("${cache.default-exp}")
private long exps;
@Value("${spring.redis.host}")
private String host;
@Value("${spring.redis.port}")
private int port;
@Value("${spring.redis.timeout}")
private int timeout;
@Value("${spring.redis.password}")
private String password;
@Value("${spring.redis.lettuce.pool.min-idle}")
private int minIdle;
@Value("${spring.redis.lettuce.pool.max-idle}")
private int maxIdle;
@Value("${spring.redis.lettuce.pool.max-wait}")
private long maxWaitMillis;
@Bean
public KeyGenerator keyGenerator() {
return new KeyGenerator() {
@Override
public Object generate(Object target, Method method, Object... params) {
StringBuffer sb = new StringBuffer();
sb.append(target.getClass().getName());
sb.append(method.getName());
for (Object obj : params) {
sb.append(obj.toString());
}
return sb.toString();
}
};
}
/**
* RedisTemplate配置
*
* @param redisConnectionFactory
* @return
*/
@Bean
public RedisTemplate<?, ?> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
RedisTemplate<Object, Object> template = new RedisTemplate<>();
template.setConnectionFactory(redisConnectionFactory);
// 使用Jackson2JsonRedisSerializer來(lái)序列化和反序列化redis的value值
Jackson2JsonRedisSerializer<JSON> serializer = new Jackson2JsonRedisSerializer<JSON>(JSON.class);
ObjectMapper mapper = new ObjectMapper();
mapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
mapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
serializer.setObjectMapper(mapper);
template.setValueSerializer(serializer);
template.setHashValueSerializer(serializer);
// 使用StringRedisSerializer來(lái)序列化和反序列化redis的key值
template.setKeySerializer(new StringRedisSerializer());
template.afterPropertiesSet();
return template;
}
@Bean
public CacheManager cacheManager(RedisConnectionFactory redisConnectionFactory) {
// 生成一個(gè)默認(rèn)配置荷憋，通過(guò)config對(duì)象即可對(duì)緩存進(jìn)行自定義配置
RedisSerializer<String> redisSerializer = new StringRedisSerializer();
// 使用Jackson2JsonRedisSerializer來(lái)序列化和反序列化redis的value值
Jackson2JsonRedisSerializer<JSON> serializer = new Jackson2JsonRedisSerializer<JSON>(JSON.class);
// 配置序列化
RedisCacheConfiguration config = RedisCacheConfiguration.defaultCacheConfig();
config.serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(redisSerializer));
config.serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(serializer));
// 設(shè)置緩存的默認(rèn)過(guò)期時(shí)間
config.entryTtl(Duration.ofSeconds(exps));
// 不緩存空值
config.disableCachingNullValues();
RedisCacheManager cacheManager = RedisCacheManager.builder(redisConnectionFactory).cacheDefaults(config).build();
return cacheManager;
}
}
緩存使用示例
分別對(duì)@Cacheable、@CachePut和@CacheEvict進(jìn)行了舉例褐望。
@Cacheable(value = "users",key = "#collection.concat(#user.id)")
public void create(String collection, JSONObject user) {
//do something
}
@CacheEvict(value = "users",key = "#collection.concat(#id)")
public void delete(String collection, String id) {
//do something
}
@Cacheable(value = "users",key = "#collection.concat(#id)")
public JSONObject getOne(String collection, String id) {
//do something
}
注意事項(xiàng)
- 要緩存的 Java 對(duì)象必須實(shí)現(xiàn) Serializable 接口
- 在CacheManager對(duì)象中 設(shè)置緩存過(guò)期時(shí)間勒庄，否則緩存對(duì)象將永不過(guò)期
- 緩存key必須為string類型的值串前，否則需要進(jìn)行類型轉(zhuǎn)換
