spring 5.x 系列第8篇 —— 整合Redis客户端 Jedis和Redisson (代码配置方式)

文章目录

• 一、说明
• 1.1 Redis 客户端说明
• 1.2 Redis可视化软件
• 1.3 项目结构说明
• 1.3 依赖说明

• 2.1 新建基本配置文件和其映射类
• 2.2 单机配置
• 2.3 集群配置
• 2.4 单机版本测试用例
• 2.5 集群版本测试用例

• 2.1 单机配置
• 2.2 集群配置
• 2.3 存储基本类型测试用例
• 2.4 存储实体对象测试用例

• 1.1 预备
• 1.1.1 全局命令
• 1.1.2 数据结构和内部编码
• 1.1.3 单线程架构

• 1.7.1 单个键管理
• 1.键重命名
• 2. 随机返回键
• 3.键过期

• 1. 全量键遍历
• 2. 渐进式遍历

• 1.切换数据库
• 2.flushdb/flushall

一、说明

1.1 Redis 客户端说明

关于spring 整合 mybatis 本用例提供两种整合方法：

1. jedis: 官方推荐的java客户端，能够胜任redis的大多数基本使用；
2. redisson：也是官方推荐的客户端，比起jedis提供了更多高级的功能，比如分布式锁、集合数据切片等功能。同时提供了丰富而全面的中英文版本的wiki。

注：关于redis其他语言官方推荐的客户端可以在客户端该网页查看，其中官方推荐的用了黄色星星⭐️标注。

1.2 Redis可视化软件

推荐Redis Desktop Manager 作为可视化查看工具，可以直观看到用例中测试关于存储实体对象序列化的情况。

1.3 项目结构说明

1. jedis和redisson的配置类和单元测试分别位于config和test下对应的包中，其中集群的配置类以cluster开头。
2. 实体类Programmer.java用于测试Redisson序列化与反序列化

1.3 依赖说明

除了spring的基本依赖外，需要导入jedis 和 redisson 对应的客户端依赖包

<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>org.redisson</groupId>
<artifactId>redisson</artifactId>
<version>3.9.1</version>
</dependency>
<!--redisson 中部分功能依赖了netty  -->
<dependency>
<groupId>io.netty</groupId>
<artifactId>netty-all</artifactId>
<version>4.1.32.Final</version>
</dependency>

二、spring 整合 jedis

2.1 新建基本配置文件和其映射类

redis.host=127.0.0.1
redis.port=6379
# 连接超时时间
redis.timeout=2000
# 最大空闲连接数
redis.maxIdle=8
# 最大连接数
redis.maxTotal=16

@Configuration
@PropertySource(value = "classpath:jedis.properties")
@Data
@NoArgsConstructor
@AllArgsConstructor
public class RedisProperty {

@Value("${redis.host}")
private String host;
@Value("${redis.port}")
private int port;
@Value("${redis.timeout}")
private int timeout;
@Value("${redis.maxIdle}")
private int maxIdle;
@Value("${redis.maxTotal}")
private int maxTotal;
}

2.2 单机配置

/**
* @author : heibaiying
* @description : Jedis 单机配置
*/
@Configuration
@ComponentScan(value = "com.heibaiying.*")
public class SingleJedisConfig {

@Bean
public JedisPool jedisPool(RedisProperty property) {
JedisPoolConfig poolConfig = new JedisPoolConfig();
poolConfig.setMaxIdle(property.getMaxIdle());
poolConfig.setMaxTotal(property.getMaxTotal());
return new JedisPool(poolConfig, property.getHost(), property.getPort(), property.getTimeout());
}

@Bean(destroyMethod = "close")
public Jedis jedis(JedisPool jedisPool) {
return jedisPool.getResource();
}
}

2.3 集群配置

@Configuration
@ComponentScan(value = "com.heibaiying.*")
public class ClusterJedisConfig {

@Bean
public JedisCluster jedisCluster(RedisProperty property) {
JedisPoolConfig poolConfig = new JedisPoolConfig();
poolConfig.setMaxIdle(property.getMaxIdle());
poolConfig.setMaxTotal(property.getMaxTotal());
Set<HostAndPort> nodes = new HashSet<HostAndPort>();
nodes.add(new HostAndPort("127.0.0.1", 6379));
nodes.add(new HostAndPort("127.0.0.1", 6380));
return new JedisCluster(nodes, 2000);
}
}

2.4 单机版本测试用例

1.需要注意的是，对于jedis而言，单机版本和集群版本注入的实例是不同的；

2.jedis本身并不支持序列化于反序列化操作，如果需要存储实体类，需要序列化后存入。(redisson本身就支持序列化于反序列化，详见下文)

/**
* @author : heibaiying
* @description :redis 单机版测试
*/
@RunWith(SpringRunner.class)
@ContextConfiguration(classes = SingleJedisConfig.class)
public class JedisSamples {

@Autowired
private Jedis jedis;

@Test
public void Set() {
jedis.set("hello", "spring annotation");
}

@Test
public void Get() {
String s = jedis.get("hello");
System.out.println(s);
}

@Test
public void setEx() {
String s = jedis.setex("spring", 10, "我会在10秒后过期");
System.out.println(s);
}

}

2.5 集群版本测试用例

@RunWith(SpringRunner.class)
@ContextConfiguration(classes = ClusterJedisConfig.class)
public class JedisClusterSamples {

@Autowired
private JedisCluster jedisCluster;

@Test
public void Set() {
jedisCluster.set("hello", "spring");
}

@Test
public void Get() {
String s = jedisCluster.get("hello");
System.out.println(s);
}

@Test
public void setEx() {
String s = jedisCluster.setex("spring", 10, "我会在10秒后过期");
System.out.println(s);
}

}

三、spring 整合 redisson

2.1 单机配置

/**
* @author : heibaiying
* @description : redisson 单机配置
*/
@Configuration
public class SingalRedissonConfig {

@Bean
public RedissonClient redissonClient() {
Config config = new Config();
config.setTransportMode(TransportMode.NIO);
config.useSingleServer().setAddress("redis://127.0.0.1:6379");
return Redisson.create(config);
}

}

2.2 集群配置

/**
* @author : heibaiying
* @description : redisson 集群配置
*/
@Configuration
public class ClusterRedissonConfig {

//@Bean
public RedissonClient redissonClient() {
Config config = new Config();
config.useClusterServers()
.setScanInterval(2000) // 集群状态扫描间隔时间，单位是毫秒
//可以用"rediss://"来启用SSL连接
.addNodeAddress("redis://127.0.0.1:6379", "redis://127.0.0.1:6380")
.addNodeAddress("redis://127.0.0.1:6381");
return Redisson.create(config);
}

}

2.3 存储基本类型测试用例

1. 这里需要注意的是，对于Redisson而言， 单机和集群最后在使用的时候注入的都是RedissonClient，这和jedis是不同的。

/**
* @author : heibaiying
* @description :redisson 操作普通数据类型
*/

@RunWith(SpringRunner.class)
@ContextConfiguration(classes = SingalRedissonConfig.class)
public class RedissonSamples {

@Autowired
private RedissonClient redissonClient;

@Test
public void Set() {
// key 存在则更新 不存在则删除
RBucket<String> rBucket = redissonClient.getBucket("redisson");
rBucket.set("annotation Value");
redissonClient.shutdown();
}

@Test
public void Get() {
// key 存在则更新 不存在则删除
RBucket<String> rBucket = redissonClient.getBucket("redisson");
System.out.println(rBucket.get());
}

@Test
public void SetEx() {
// key 存在则更新 不存在则删除
RBucket<String> rBucket = redissonClient.getBucket("redissonEx");
rBucket.set("我在十秒后会消失", 10, TimeUnit.SECONDS);
}

@After
public void close() {
redissonClient.shutdown();
}
}

2.4 存储实体对象测试用例

/**
* @author : heibaiying
* @description :redisson 对象序列化与反序列化
*/

@RunWith(SpringRunner.class)
@ContextConfiguration(classes = SingalRedissonConfig.class)
public class RedissonObjectSamples {

@Autowired
private RedissonClient redissonClient;

// Redisson的对象编码类是用于将对象进行序列化和反序列化 默认采用Jackson

@Test
public void Set() {
RBucket<Programmer> rBucket = redissonClient.getBucket("programmer");
rBucket.set(new Programmer("xiaoming", 12, 5000.21f, new Date()));
redissonClient.shutdown();
//存储结果: {"@class":"com.heibaiying.com.heibaiying.bean.Programmer","age":12,"birthday":["java.util.Date",1545714986590],"name":"xiaoming","salary":5000.21}
}

@Test
public void Get() {
RBucket<Programmer> rBucket = redissonClient.getBucket("programmer");
System.out.println(rBucket.get());
}

@After
public void close() {
redissonClient.shutdown();
}
}

附：Redis的数据结构和操作命令

1.1 预备

1.1.1 全局命令

1. 查看所有键： keys *

2. 查看键总数：dbsize

3. 检查键是否存在：exists key

4. 删除键：del key [key …] 支持删除多个键

5. 键过期：expire key seconds

   ttl命令会返回键的剩余过期时间， 它有3种返回值：

   大于等于0的整数： 键剩余的过期时间。
   • -1： 键没设置过期时间。
   • -2： 键不存在

6. 键的数据结构 type key

1.1.2 数据结构和内部编码

type命令实际返回的就是当前键的数据结构类型， 它们分别是：string（字符串） 、 hash（哈希） 、 list（列表） 、 set（集合） 、 zset（有序集合）

1.1.3 单线程架构

1. 纯内存访问， Redis将所有数据放在内存中， 内存的响应时长大约为100纳秒， 这是Redis达到每秒万级别访问的重要基础。
2. 非阻塞I/O， Redis使用epoll作为I/O多路复用技术的实现， 再加上Redis自身的事件处理模型将epoll中的连接、 读写、 关闭都转换为事件， 不在网络I/O上浪费过多的时间， 如图2-6所示。
3. 单线程避免了线程切换和竞态产生的消耗。

1.2 字符串

1.3 哈希

1.4 列表

1.5 集合

集合（set） 类型也是用来保存多个的字符串元素， 但和列表类型不一样的是， 集合中不允许有重复元素， 并且集合中的元素是无序的， 不能通过索引下标获取元素。

集合内操作：

集合间操作：

1.6 有序集合

有序集合中的元素可以排序。 但是它和列表使用索引下标作为排序依据不同的是， 它给每个元素设置一个分数（score） 作为排序的依据。

集合内操作：

集合间操作：

• destination： 交集计算结果保存到这个键。
• numkeys： 需要做交集计算键的个数。
• key[key…]： 需要做交集计算的键。
• weights weight[weight…]： 每个键的权重， 在做交集计算时， 每个键中的每个member会将自己分数乘以这个权重， 每个键的权重默认是1。
• aggregate sum|min|max： 计算成员交集后， 分值可以按照sum（和） 、min（最小值） 、 max（最大值） 做汇总， 默认值是sum。

1.7 键管理

1.7.1 单个键管理

1.键重命名

rename key newkey

为了防止被强行rename， Redis提供了renamenx命令， 确保只有newKey不存在时候才被覆盖。

2. 随机返回键

random key

3.键过期

• expire key seconds： 键在seconds秒后过期。
• expireat key timestamp： 键在秒级时间戳timestamp后过期。
• pexpire key milliseconds： 键在milliseconds毫秒后过期。
• pexpireat key milliseconds-timestamp键在毫秒级时间戳timestamp后过期

注意：

1. 如果expire key的键不存在， 返回结果为0
2. 如果设置过期时间为负值， 键会立即被删除， 犹如使用del命令一样
3. persist key t命令可以将键的过期时间清除
4. 对于字符串类型键， 执行set命令会去掉过期时间， 这个问题很容易在开发中被忽视
5. Redis不支持二级数据结构（例如哈希、 列表） 内部元素的过期功能， 例如不能对列表类型的一个元素做过期时间设置
6. setex命令作为set+expire的组合， 不但是原子执行， 同时减少了一次网络通讯的时间

1.7.2 键遍历

1. 全量键遍历

keys pattern

2. 渐进式遍历

scan cursor [match pattern] [count number]

• cursor是必需参数， 实际上cursor是一个游标， 第一次遍历从0开始， 每次scan遍历完都会返回当前游标的值， 直到游标值为0， 表示遍历结束。
• match pattern是可选参数， 它的作用的是做模式的匹配， 这点和keys的模式匹配很像。
• count number是可选参数， 它的作用是表明每次要遍历的键个数， 默认值是10， 此参数可以适当增大。

1.7.3 数据库管理

1.切换数据库

select dbIndex

2.flushdb/flushall

flushdb/flushall命令用于清除数据库， 两者的区别的是flushdb只清除当前数据库， flushall会清除所有数据库。

附：源码Gitub地址：https://github.com/heibaiying/spring-samples-for-all