Redis 是一个高性能的Key-Value内存数据库。Spring 官方对 Redis 提供支持，使用 Spring Data Redis 可以选择 Jedis 或 Lettuce 客户端，在 Spring Boot 项目中操作 Redis 简单方便。
Spring Data Redis 是 Spring Data 家族的一部分，它提供了配置方法和访问 Redis 接口的抽象。在内底层实现上，我们可以选择使用 Jedis 或 Lettuce 来访问 Redis 数据库。
Jedis 和 Lettuce 都是 Redis 的客户端。简单来说，Jedis 是社区的开源项目， Lettuce的连接是基于Netty的，关于他们的比较，引用 Spring Data Redis 官网的一张图说明：
本文将给出 Jedis 和 Lettuce 两种集成方法。
引入依赖
- 在pom.xml文件中加入
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
<version>{version}</version>
</dependency>
不用指定版本，因为在 Spring Boot 应用中，spring-boot-dependencies 中声明了版本信息，也是和现 Spring Boot 版本契合度最高的。自己手动指定可能会引发不可意料的兼容问题。
- 如果使用 jedis ，则引入
<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
<version>{version}</version>
</dependency>
- 如果使用 Luttuce ，则引入
<dependency>
<groupId>io.lettuce</groupId>
<artifactId>lettuce-core</artifactId>
<version>{version}</version>
</dependency>
我现在所使用的 Spring Data Redis 2.3.x 版本默认使用 Luttuce 且已引入依赖。
配置
- 在 application.xml 中加入
spring:
redis:
host: 127.0.0.1 # redis ip
port: 6379 # redis 端口
password: # redis 登录密码
database: 1 # 数据库
ssl: false
timeout: 2s
以上是连接 Redis 的通用配置，Spring Boot 支持对 Jedis 或 Luttuce 的一些属性进行配置。更多请参考Spring Boot Data Properties
使用
创建 RedisConnectionFactory 工厂
- Jedis
@Bean
public JedisConnectionFactory redisConnectionFactory() {
return new JedisConnectionFactory(new RedisStandaloneConfiguration());
}
- Luttuce
@Bean
public LettuceConnectionFactory redisConnectionFactory2() {
// LettuceConnectionFactory factory = new LettuceConnectionFactory(new RedisSocketConfiguration("/var/run/redis.sock"));
LettuceConnectionFactory factory = new LettuceConnectionFactory(new RedisStandaloneConfiguration());
return factory;
}
Spring Data Redis配置类有3个：
// 单点redis RedisStandaloneConfiguration config = new RedisStandaloneConfiguration(); // 哨兵redis RedisSentinelConfiguration config = new RedisSentinelConfiguration(); // 集群redis RedisClusterConfiguration config = new RedisClusterConfiguration();
本篇都使用单点配置，集群相关知识放在 Redis 专题讲解
配置缓存管理
@Bean
public CacheManager cacheManager(RedisConnectionFactory factory) {
RedisCacheConfiguration redisCacheConfiguration = RedisCacheConfiguration.defaultCacheConfig();
// 设置缓存的默认超时时间：30分钟
redisCacheConfiguration.entryTtl(Duration.ofMinutes(30L));
// 如果是空值，不缓存
redisCacheConfiguration.disableCachingNullValues();
// 设置key序列化器
redisCacheConfiguration.serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(new StringRedisSerializer()));
// 设置value序列化器
redisCacheConfiguration.serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(new GenericJackson2JsonRedisSerializer()));
RedisCacheManager.RedisCacheManagerBuilder build = RedisCacheManager.builder(RedisCacheWriter.nonLockingRedisCacheWriter(factory));
RedisCacheManager cacheManager = build.cacheDefaults(redisCacheConfiguration).build();
return cacheManager;
}
经过以上配置，Spring Boot 会自动装配，直接使用 RedisTemplate 操作 Redis
@Autowired
private RedisTemplate redisTemplate;
我们也可以自己创建 RedisTemplate 对象定义数据存储时序列化与反序列化的方式
@Bean
public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
RedisTemplate<String, Object> template = new RedisTemplate<>();
template.setConnectionFactory(factory);
Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
ObjectMapper om = new ObjectMapper();
om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
jackson2JsonRedisSerializer.setObjectMapper(om);
StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();
// key采用String的序列化方式
template.setKeySerializer(stringRedisSerializer);
// hash的key也采用String的序列化方式
template.setHashKeySerializer(stringRedisSerializer);
// value序列化方式采用jackson
template.setValueSerializer(jackson2JsonRedisSerializer);
// hash的value序列化方式采用jackson
template.setHashValueSerializer(jackson2JsonRedisSerializer);
template.afterPropertiesSet();
return template;
}
RedisTemplate 类
RedisTemplate 是 Spring Data Redis 中提供用来访问 Redis 的类。以下是它的一些常用方法：
Boolean hasKey(key) Redis 中 key 是否存在
Long getExpire(key) 获取key剩余过期时间，返回毫秒
Boolean delete(key) 删除key
SetOperations opsForSet() 获取set类型数据操作对象
ListOperations opsForList() 获取list类型数据操作对象
ValueOperations opsForValue() 获取键值数据操作对象
HashOperations opsForHash() 获取Map数据操作对象
更多方法参考官方API文档：RedisTemplate
基于 Redis 的分布式锁
在 Redis中使用 setnx 和 expire 可以实现分布式锁，以下是它的用法：
set key value [EX seconds] [PX milliseconds] [NX|XX]
EX seconds：设置失效时长，单位秒
PX milliseconds：设置失效时长，单位毫秒
NX：key不存在时设置value，成功返回OK，失败返回(nil)
XX：key存在时设置value，成功返回OK，失败返回(nil)
setnx不能同时完成expire设置失效时长，不能保证setnx和expire的原子性，所以在做分布式锁时要合成一条命令使用。
在 Jedis 提供的API中是有 setNX 方法的，在 RedisTemplate 中可以这样：
Boolean flag = redisTemplate.opsForValue().setIfAbsent(lockKey, value, 10, TimeUnit.SECONDS);
if (!flag) {
// 已锁定
}
系统使用 Redis 做缓存能极大提高性能。后续会发布 Spring 缓存的使用。
除非注明，否则均为"攻城狮·正"原创文章，转载请注明出处。 本文链接：engr-z.com/129.html
