SpringBoot中Spring-data-redis入门使用

SpringBoot中Spring-data-redis入门使用

编者的话

Spring-data-redis是基于Spring框架的redis链接插件，功能强大，简单好用（至少对我这种小白，不深究其原理和强大功能的话，是简单好用的），其和Jedis两者是Spring中常用的操作Redis服务的工具，两者的区别及其优缺点自行百度，我也不会，推荐大佬的博文 JAVA与Redis的结合

这里，小编只是介绍Spring-data-redis的简单使用，其包括引依赖，application.yml中对进行简单配置，及自定义String为key，Object为value，且Object序列化时使用JSON格式存储的RedisTemplate。

1、引入依赖

<!-- redis -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
    <!-- <version>2.6.5</version> -->
</dependency>

<!--redis附加包，因为Springboot 2.0 中redis客户端使用了Lettue, 其依赖于commons, 所以加入以上(似乎Jedis依然可以使用.)-->
<dependency>
	<groupId>org.apache.commons</groupId>
	<artifactId>commons-pool2</artifactId>
</dependency>

2、Redis链接配置

spring:
  redis:
  	# redis链接地址
    host: 127.0.0.1
    # redis链接端口
    port: 6379
    # redis链接密码
    password:
    # redis连接池
    lettuce:
      pool:
      	# 最大链接数
        max-active: 8
        # 最大建立链接等待时间，-1为无限制
        max-wait: -1
        # 最大空闲数
        max-idle: 8
        # 最小空闲数
        min-idle: 0
      # 关闭超时时间，在关闭客户端链接之前等待任务处理完成的最长时间，在这之后，无论任务是否执行完成，都会被执行器关闭
      shutdown-timeout: 100
    database: 2         # 使用Redis中的第三个分区，默认是0

如果不在application.yml或者application.properties中配置的话，也能直接使用redis，使用的是默认配置，例如host就是127.0.0.1，port就是6379，database为0等。

3、使用RedisTemplate和StringRedisTemplate

配置完以上两个步骤，就可以使用redis了，spring-data-redis默认提供RedisTemplate<Object,Object>和StringRedisTemplate<String,String>工具，其中RedisTemplate<Object,Object>就是键值都是Object类型，而StringRedisTemplate<String,String>就是键值都是String类型。

使用方法很简单，在需要使用到RedisTemplate的类上通过@Autowired或者@Resource注解就能获取该工具，当然，类上必须有声明由Spring管理的注解，例如@Controller，@Service，@Configuration等。

@Service
public class TestRedisTemplate {
    
    @Autowired
    RedisTemplate redisTemplate;
    @Autowired
    StringRedisTemplate stringRedisTemplate;
    
    public void saveInRedis(){
        SysUser sysUser = new SysUser();
        sysUser.setUsername("zhangsan");
        sysUser.setPassword("123456");
        // 存进redis,key和value都可以是object
        redisTemplate.opsForValue().set(sysUser,sysUser);
        // 从redis中取出，返回值是object
        Object object = redisTemplate.opsForValue().get(sysUser);
        // 存进redis
        stringRedisTemplate.opsForValue().set("key1","没错，我就是value");
        // 从redis中取出
        String str = stringRedisTemplate.opsForValue().get("key1");
    }
}

除此之外RedisTemplate还有很多默认的方法，这里不做详细介绍，可以自行研究，以上的存进redis都是不带时间的永久存储，而设置key的过期时间可以在存的时候多带一个long型的数字，表示过期时间，例如

// 带long参数，表示60*60*1000毫秒后过期
stringRedisTemplate.opsForValue().set("key1","没错，我就是value",60*60*1000);
// 带long参数，后面再带时间单位，表示60天后过期
stringRedisTemplate.opsForValue().set("key1","没错，我就是value",60, TimeUnit.DAYS);

为什么有了RedisTemplate<Object,Object>还要有StringRedisTemplate<String,String>呢？

因为RedisTemplate<Object,Object>存进redis时，会有将Object转成一种奇怪的编码，即使你存的是string，也不能在Redis中直接阅读，而StringRedisTemplate<String,String>存进redis，键和值都会是字符串，但是Object的序列化存入redis和String类型存入redis都经常用到，所以Spring提供了这两种方式。

另外，Redis要存Object类型的数据，一定要将该Object实现序列化，即是序列化接口，implement Serializable。

public class SysRole implements Serializable {

    private Integer id;     /** 角色id **/
    private String roleCode;    /** 角色编号 **/
    private String roleName;    /** 角色名称 **/
}

只有实现了Serializable接口的java对象才能被序列化。

存进redis效果如下

由此可见，Object被序列化存进redis时是没办法直接阅读的。

4、自定义RedisTemplate

以上我们发现RedisTemplate<Object,Object>和StringRedisTemplate<String,String>功能太局限了，我想实现一种String为key，Object为value的存储，并且Value还能直接阅读，这就需要自定义RedisTemplate，实现方法也很简单，百度上很多，下面的代码就是直接从百度上拷下来的。

写一个配置类，然后将自己配置的RedisTemplate加入到Spring IOC中

@Configuration
@EnableCaching          //开启redis缓存注解
public class RedisConfig extends CachingConfigurerSupport {

    // 因为Spring工厂里本身就有redisTemplate，如果不写name="stringObjectRedisTemplate"，会覆盖原来的redisTemplate
    // 而，我不想覆盖原来的，而是新建一个，所以取了新的名字
    @Bean(name = "stringObjectRedisTemplate")
    @SuppressWarnings("all")
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
        // 实例化自己的RedisTemplate
        RedisTemplate<String, Object> template = new RedisTemplate<String, Object>();
        // 设置使用连接工厂连接
        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;
    }
}

然后我们就可以通过自定义的 stringObjectRedisTemplate 使用我们自定义的 RedisTemplate 了

// 使用@Autowired注入
@Autowired
RedisTemplate stringObjectRedisTemplate;

// 将实现序列化的 TestSerializable 
stringObjectRedisTemplate.opsForValue().set("yourKey",testSerializable);
TestSerializable bb =(TestSerializable)stringObjectRedisTemplate.opsForValue().get("yourKey");

记得，存进Redis的Object都需要实现序列化 implement Serializable

最后存进去的结果

以上就是Spring-data-redis的简单使用。