Spring学习笔记之RedisTemplate的配置与使用教程

前言

Spring针对Redis的使用，封装了一个比较强大的Template以方便使用；之前在Spring的生态圈中也使用过redis，但直接使用Jedis进行相应的交互操作，现在正好来看一下RedisTemplate是怎么实现的，以及使用起来是否更加便利

I. 基本配置

1. 依赖

依然是采用Jedis进行连接池管理，因此除了引入 spring-data-redis之外，再加上jedis依赖，pom文件中添加

 org.springframework.data
 spring-data-redis
 1.8.4.RELEASE



 redis.clients
 jedis
 2.9.0

如果需要指定序列化相关参数，也可以引入jackson，本篇为简单入门级，就不加这个了

2. 配置文件

准备redis相关的配置参数，常见的有host, port, password, timeout…，下面是一份简单的配置，并给出了相应的含义

redis.hostName=127.0.0.1
redis.port=6379
redis.password=https://blog.hhui.top
# 连接超时时间
redis.timeout=10000

#最大空闲数
redis.maxIdle=300
#控制一个pool可分配多少个jedis实例,用来替换上面的redis.maxActive,如果是jedis 2.4以后用该属性
redis.maxTotal=1000
#最大建立连接等待时间。如果超过此时间将接到异常。设为-1表示无限制。
redis.maxWaitMillis=1000
#连接的最小空闲时间 默认1800000毫秒(30分钟)
redis.minEvictableIdleTimeMillis=300000
#每次释放连接的最大数目,默认3
redis.numTestsPerEvictionRun=1024
#逐出扫描的时间间隔(毫秒) 如果为负数,则不运行逐出线程, 默认-1
redis.timeBetweenEvictionRunsMillis=30000
#是否在从池中取出连接前进行检验,如果检验失败,则从池中去除连接并尝试取出另一个
redis.testOnBorrow=true
#在空闲时检查有效性, 默认false
redis.testWhileIdle=true

说明

redis密码请一定记得设置，特别是在允许远程访问的时候，如果没有密码，默认端口号，很容易就被是扫描注入脚本，然后开始给人挖矿（亲身经历…）

II. 使用与测试

根据一般的思路，首先是得加载上面的配置，创建redis连接池，然后再实例化RedisTemplate对象，最后持有这个实力开始各种读写操作

1. 配置类

使用JavaConfig的方式来配置，主要是两个Bean，读取配置文件设置各种参数的RedisConnectionFactory以及预期的RedisTemplate

@Configuration
@PropertySource("classpath:redis.properties")
public class RedisConfig extends JCacheConfigurerSupport {
 @Autowired
 private Environment environment;

 @Bean
 public RedisConnectionFactory redisConnectionFactory() {
 JedisConnectionFactory fac = new JedisConnectionFactory();
 fac.setHostName(environment.getProperty("redis.hostName"));
 fac.setPort(Integer.parseInt(environment.getProperty("redis.port")));
 fac.setPassword(environment.getProperty("redis.password"));
 fac.setTimeout(Integer.parseInt(environment.getProperty("redis.timeout")));
 fac.getPoolConfig().setMaxIdle(Integer.parseInt(environment.getProperty("redis.maxIdle")));
 fac.getPoolConfig().setMaxTotal(Integer.parseInt(environment.getProperty("redis.maxTotal")));
 fac.getPoolConfig().setMaxWaitMillis(Integer.parseInt(environment.getProperty("redis.maxWaitMillis")));
 fac.getPoolConfig().setMinEvictableIdleTimeMillis(
 Integer.parseInt(environment.getProperty("redis.minEvictableIdleTimeMillis")));
 fac.getPoolConfig()
 .setNumTestsPerEvictionRun(Integer.parseInt(environment.getProperty("redis.numTestsPerEvictionRun")));
 fac.getPoolConfig().setTimeBetweenEvictionRunsMillis(
 Integer.parseInt(environment.getProperty("redis.timeBetweenEvictionRunsMillis")));
 fac.getPoolConfig().setTestOnBorrow(Boolean.parseBoolean(environment.getProperty("redis.testOnBorrow")));
 fac.getPoolConfig().setTestWhileIdle(Boolean.parseBoolean(environment.getProperty("redis.testWhileIdle")));
 return fac;
 }

 @Bean
 public RedisTemplate redisTemplate(RedisConnectionFactory redisConnectionFactory) {
 RedisTemplate redis = new RedisTemplate<>();
 redis.setConnectionFactory(redisConnectionFactory);
 redis.afterPropertiesSet();
 return redis;
 }
}

2. 测试与使用

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = {RedisConfig.class})
public class RedisTest {

 @Autowired
 private RedisTemplate redisTemplate;
 
 @Test
 public void testRedisObj() {
 Map properties = new HashMap<>();
 properties.put("123", "hello");
 properties.put("abc", 456);
 
 redisTemplate.opsForHash().putAll("hash", properties);
 
 Map ans = redisTemplate.opsForHash().entries("hash");
 System.out.println("ans: " + ans);
 }
}

执行后输出如下

ans: {123=hello, abc=456}

从上面的配置与实现来看，是很简单的了，基本上没有绕什么圈子，但是使用redis-cli连上去，却查询不到 hash 这个key的内容

127.0.0.1:6379> get hash
(nil)
127.0.0.1:6379> keys *
1) "\xac\xed\x00\x05t\x00\x04hash"

使用代码去查没问题，直接控制台连接，发现这个key和我们预期的不一样，多了一些前缀，why ?

3. 序列化问题

为了解决上面的问题，只能debug进去，看下是什么引起的了

对应源码位置:

// org.springframework.data.redis.core.AbstractOperations#rawKey

byte[] rawKey(Object key) {
 Assert.notNull(key, "non null key required");
 return this.keySerializer() == null && key instanceof byte[] ? (byte[])((byte[])key) : this.keySerializer().serialize(key);
}

可以看到这个key不是我们预期的 key.getBytes(), 而是调用了this.keySerializer().serialize(key)，而debug的结果，默认Serializer是JdkSerializationRedisSerializer

然后就是顺藤摸瓜一步一步深入进去，链路如下

// org.springframework.core.serializer.support.SerializingConverter#convert

// org.springframework.core.serializer.DefaultSerializer#serialize

public class DefaultSerializer implements Serializer