Redis学习之Spring-data-redis使用

Redis学习之Spring-data-redis使用

前言

在前面，我们学习了Redis的基础知识，也学习了在Java中通过Jedis来操作Redis，同时我们也提到了，Jedis的操作过于底层，或者说封装得不够彻底，当我们要存储一个对象的时候，其实是比较麻烦的，所以接下来我们来学习另外一个操作工具，spring-data-redis

Spring-data-redis是Spring-Data项目的一个子项目，主要用于操作Redis，通过Spring-data-redis工具，使得操作Redis以更加面向对象的方式。

Spring-data-redis配置

环境准备

为了操作方便，这里使用Spring-boot作为脚手架，版本为2.0.4.RELEASE，引入依赖如下

<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-data-redisartifactId>
dependency>

在使用Spring-data-redis的时候，要特别留意版本信息，Spring Boot 2.X中的Spring-data-redis的配置以及操作方式跟1.X系列的有很大区别，这里以2.0.4.RELEASE为例

Bean配置

在Spring Boot 2.X中，有两种不同的使用操作，一种是使用Jedis，一种是使用Lettuce，这里我们演示的是使用Jedis，主要是Lettuce这个目前还没研究，后面有时间的话，研究一下。

连接池的配置

最好将信息配置在配置文件中，这里为了方便直接编码在程序中

@Bean
public JedisPoolConfig poolConfig() {
    JedisPoolConfig poolConfig = new JedisPoolConfig();
    poolConfig.setMaxTotal(100);
    poolConfig.setMaxWaitMillis(30 * 1000);
    poolConfig.setMinIdle(20);
    poolConfig.setMaxIdle(40);
    poolConfig.setTestWhileIdle(true);
    return poolConfig;
}

连接工厂配置

2.x系列跟1.x系列的不同之处在于，1.x可以直接通过JedisConnectionFactory，设置各种配置信息，但是在2.x之后，所有的set方法都被标注为过期了。通过查看JedisConnectionFactory的构造方法也可以看出，所以，如果是使用单机版的Redis的话，需要配置一下两个内容

public JedisConnectionFactory(
    RedisStandaloneConfiguration standaloneConfig, JedisClientConfiguration clientConfig) {}

当然，可以不配置连接池信息，这里连接池的配置也是有区别与1.x，使用的是JedisClientConfiguration进行配置

@Bean
public RedisStandaloneConfiguration redisStandaloneConfiguration() {
    RedisStandaloneConfiguration configuration = new RedisStandaloneConfiguration();
    configuration.setHostName(host);
    configuration.setPassword(RedisPassword.of(password));
    configuration.setPort(port);
    return configuration;
}

@Bean
public JedisClientConfiguration clientConfiguration() {
    JedisClientConfiguration.JedisClientConfigurationBuilder builder = JedisClientConfiguration.builder();
    return builder.usePooling()
            .poolConfig(poolConfig())
            .build();
}

请特别留意上面的JedisClientConfiguration的配置，通过builder来构造，然后使用usePooling()以及poolConfig()来配置连接池信息，网上很多的直接构造一个JedisPool的bean的方案在2.x中是不生效的，不信的话，断点查看一下连接池信息，还是默认的方式。

@Bean
public JedisConnectionFactory redisConnectionFactory() {
    return new JedisConnectionFactory(redisStandaloneConfiguration(), clientConfiguration());
}

RedisTemplate配置

在文章开头，我们提到了使用原生Jedis操作的不方便性以及Spring-data-redis的改进，其实，使用后者的主要好处就在于，它提供了序列化选项，可以根据需要配置不同的序列化器来序列化键跟值。

正如我们所知道的，Redis中存储的是二进制，或者说字符串也行，所以一个对象是没办法直接存储在Redis中的，我们可以将对象的一个个属性拆分出来，但是这样效率太低了，通过序列化器直接序列化，效率就高了很多啦，这里是效率指的是编码的效率。

@Bean
public RedisTemplate redisTemplate() {
    // 注意这里使用的是StringRedisTempalte
    StringRedisTemplate template = new StringRedisTemplate(redisConnectionFactory());
    GenericJackson2JsonRedisSerializer jackson2JsonRedisSerializer = new GenericJackson2JsonRedisSerializer();
    // 设置值的序列化器
    template.setValueSerializer(jackson2JsonRedisSerializer);
    return template;
}

请注意上面配置模板的方式，在Spring-data-redis中，提供了两种模板，一种是RedisTemplate每一种是StringRedisTempalte，区别在于，RedisTemplate的键值序列使用的是默认的序列化器，即JdkSerializationRedisSerializer，而StringRedisTemplate使用的是StringRedisSerializer。

在上面的配置中，我们也可以使用RedisTempalte，并且手动配置其对应的序列化器来覆盖默认的序列化器即可。

在上面的配置中，我们使用的值序列化器是GenericJackson2JsonRedisSerializer，当然，使用Jackson2JsonRedisSerializer也是可以，只是需要多做一些额外的配置。

到此为止，配置环节就完成了，接下来就是使用了。

Spring-data-redis使用

在Spring-data-redis中，为Redis的五种不同的数据结构提供了五种不同的操作类，如下所示

ValueOperations<K, V> valueOps;
ListOperations<K, V> listOps;
SetOperations<K, V> setOps;
ZSetOperations<K, V> zSetOps;
HashOperations<K, HK, HV> hashOps;

可以通过tempalte.opsForXXX()方法来获取对应的对象，然后进行对应的操作。

在注入RedisTemplate的时候需要注意，由于RedisTemplate是泛型，并且获取的对应的操作类的类型是注入是的类型是相同的，所以，在注入的时候就选择合适的类型是比较推荐的。

@Autowired
private RedisTemplate<String, User> redisTemplate;

// .....

ValueOperations<String, User> ops = redisTemplate.opsForValue();
ListOperations<String, User> listOps = redisTemplate.opsForList();
HashOperations<String, Object, Object> hashOps = redisTemplate.opsForHash();
// ....

对应的Ops的操作方式跟原生命令比较相似，只是由于现在加入了序列化器，记得上面的配置吗？所有，现在可以直接操作对象了。

在Redis中存储的内容跟具体的序列化器有关，如上面的配置，存储的内容如下

"{\"@class\":\"cn.xuhuanfeng.spring.mvc.springmvcdemo.domain.User\",\"name\":\"xuhuanfeng\",\"password\":\"huanfeng\"}"

总结

本小节主要是学习了Spring-data-redis的配置以及使用，主要重点在于配置，Spring boot 2.x配置跟Spring boot 1.x的配置差别有点大，而网上找到的大部分配置都是基于1.x的，所以，希望这篇配置能够帮到同样在学习的你。