SpringBoot整合Redis并自定义Redis对象的序列化

Redis简介

redis是一个key-value存储系统。和Memcached类似，它支持存储的value类型相对更多，包括string(字符串)、list(链表)、set(集合)、zset(sorted set --有序集合)和hash（哈希类型）。这些数据类型都支持push/pop、add/remove及取交集并集和差集及更丰富的操作，而且这些操作都是原子性的。在此基础上，redis支持各种不同方式的排序。与memcached一样，为了保证效率，数据都是缓存在内存中。区别的是redis会周期性的把更新的数据写入磁盘或者把修改操作写入追加的记录文件，并且在此基础上实现了master-slave(主从)同步.

Redis 是一个高性能的key-value数据库。 redis的出现，很大程度补偿了memcached这类key/value存储的不足，在部 分场合可以对关系数据库起到很好的补充作用。它提供了Java，C/C++，C#，PHP，JavaScript，Perl，Object-C，Python，Ruby，Erlang等客户端，使用很方便。Redis支持主从同步。数据可以从主服务器向任意数量的从服务器上同步，从服务器可以是关联其他从服务器的主服务器。这使得Redis可执行单层树复制。存盘可以有意无意的对数据进行写操作。由于完全实现了发布/订阅机制，使得从数据库在任何地方同步树时，可订阅一个频道并接收主服务器完整的消息发布记录。同步对读取操作的可扩展性和数据冗余很有帮助。

SpringBoot整合Redis

1. 首先创建Spring Boot项目，并编写实体Bean类，Service，Controller，Mybatis的Mapper等类

Pom文件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.0.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.yys</groupId>
    <artifactId>springbootredis</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springbootredis</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.1.4</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>io.projectreactor</groupId>
            <artifactId>reactor-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter</artifactId>
            <version>RELEASE</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

实体Bean类：必须要对bean进行序列化，否则会导致存入redis缓存时出现错误，因为redis默认使用的jdk的序列化方法

public class Department implements Serializable {
	private Integer id;
	private String departmentName;
	public Department() {
		super();
	}
	public Department(Integer id, String departmentName) {
		super();
		this.id = id;
		this.departmentName = departmentName;
	}
	public Integer getId() {
		return id;
	}
	public void setId(Integer id) {
		this.id = id;
	}
	public String getDepartmentName() {
		return departmentName;
	}
	public void setDepartmentName(String departmentName) {
		this.departmentName = departmentName;
	}
	@Override
	public String toString() {
		return "Department [id=" + id + ", departmentName=" + departmentName + "]";
	}
}

Service类

@Service
public class DeptService {
    @Autowired
    DepartmentMapper departmentMapper;
    @Cacheable(value = "dept")
    public Department getDeptById(Integer id) {
        System.out.println("查询部门" + id);
        Department department = departmentMapper.getDeptById(id);
        return department;
    }
}

在相应的service方法上使用Cacheable注解并设置缓存的名字，关于该注解的解释：

    @Cacheable：
   1、方法运行之前，先去查询Cache（缓存组件），按照cacheNames指定的名字获取；
      （CacheManager先获取相应的缓存），第一次获取缓存如果没有Cache组件会自动创建。
   2、去Cache中查找缓存的内容，使用一个key，默认就是方法的参数；
      key是按照某种策略生成的；默认是使用keyGenerator生成的，默认使用SimpleKeyGenerator生成key；
          SimpleKeyGenerator生成key的默认策略；
                  如果没有参数；key=new SimpleKey()；
                  如果有一个参数：key=参数的值
                  如果有多个参数：key=new SimpleKey(params)；
   3、没有查到缓存就调用目标方法；
   4、将目标方法返回的结果，放进缓存中
   @Cacheable标注的方法执行之前先来检查缓存中有没有这个数据，默认按照参数的值作为key去查询缓存，
   如果没有就运行方法并将结果放入缓存；以后再来调用就可以直接使用缓存中的数据；

关于该注解的几个属性：

*   几个属性：
*      cacheNames/value：指定缓存组件的名字;将方法的返回结果放在哪个缓存中，是数组的方式，可以指定多个缓存；
*
*      key：缓存数据使用的key；可以用它来指定。默认是使用方法参数的值  1-方法的返回值
*      keyGenerator：key的生成器；可以自己指定key的生成器的组件id
*                    key/keyGenerator：二选一使用;
*      cacheManager：指定缓存管理器；或者cacheResolver指定获取解析器
*      condition：指定符合条件的情况下才缓存；
*          condition = "#id>0"  //id>0进行缓存
*          condition = "#a0>1"：第一个参数的值>1的时候才进行缓存
*      unless:否定缓存；当unless指定的条件为true，方法的返回值就不会被缓存；可以获取到结果进行判断
*          unless = "#result == null"
*           unless = "#a0==2":如果第一个参数的值是2，结果不缓存；
*      sync：是否使用异步模式

在SpringBoot的项目使用@EnableCaching开启缓存，否则无法使用缓存

在完成以上配置后，此时通过Controller查询部门即可查询到相关信息，此时是从数据库查询到的，因为缓存中并没有该信息，查询到结果后，在Redis缓存种查询结果保存，如图所示：

当我们再次查询时，会发现不会从数据库查询，而是直接从缓存中得到相关的结果，此时控制台不会输出“查询部门1”的消息。

其他的几个缓存注解介绍：

* @CachePut：既调用方法，又更新缓存数据；同步更新缓存
* 修改了数据库的某个数据，同时更新缓存；
* 运行时机：
*  1、先调用目标方法
*  2、将目标方法的结果缓存起来

一定要注意更新时的key的获取该数据时的key一定要相同，否则会造成数据库中修改成功，但是缓存没有更新，比如获取一个部门时方法的参数为部门ID，如果没有指定key时，默认是id当作key，而更新一个部门是，参数是部门对象，同时还不指定key，那么ley默认是部门对象，此时缓存中不会更新原来的缓存，而是会重新创建新的缓存，key值为部门对象。可以指定key为部门的ID即可。

* @CacheEvict：缓存清除
*  key：指定要清除的数据
*  allEntries = true：指定清除这个缓存中所有的数据
*  beforeInvocation = false：缓存的清除是否在方法之前执行
*      默认代表缓存清除操作是在方法执行之后执行;如果出现异常缓存就不会清除
*  beforeInvocation = true：
*      代表清除缓存操作是在方法运行之前执行，无论方法是否出现异常，缓存都清除

Redis自定义对象序列化

通过刚才的测试，发现在缓存中保存的是二进制符号，那是因为，redis默认使用的序列化为JdkSerializationRedisSerializer,所以，此时为乱码，如果想要保存json字符串，需要使用json序列化，具体可参考org.springframework.data.redis.serializer包下的public interface RedisSerializer，里面有多种序列化方式，支持Java，json,String等

如果使用注解自动缓存时，需要自定义CacheManager类实现更改序列化类型，使用的时Spring Boot2.x，1.x的编写方式不一样

 @Bean
    public CacheManager cacheManager(RedisConnectionFactory factory) {
        RedisCacheConfiguration cacheConfiguration =
                RedisCacheConfiguration.defaultCacheConfig()
                        .entryTtl(Duration.ofDays(1))
                        .disableCachingNullValues()
                        .serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(new
                                GenericJackson2JsonRedisSerializer()));
        return RedisCacheManager.builder(factory).cacheDefaults(cacheConfiguration).build();
    }

这样就可实现使用注解时，自动序列为json字符串，如图：

但是，如果使用RedisTemplate手动缓存，这个时候还是乱码，此时需要重写RedisTemplate方法，实现更改序列化,注意，redisConfig的配置类需要使用注解标注为配置类,此配置类来源于：https://www.cnblogs.com/castlechen/p/11090505.html

@Configuration
@EnableCaching
public class RedisConfig extends CachingConfigurerSupport {
    @Bean
    public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory factory) {
        RedisTemplate<Object, Object> redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(factory);

        // 使用Jackson2JsonRedisSerialize 替换默认序列化
        Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);

        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);

        jackson2JsonRedisSerializer.setObjectMapper(objectMapper);

        // 设置value的序列化规则和 key的序列化规则
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.setValueSerializer(jackson2JsonRedisSerializer);
        redisTemplate.setHashKeySerializer(new StringRedisSerializer());
        redisTemplate.setHashValueSerializer(jackson2JsonRedisSerializer);
        redisTemplate.afterPropertiesSet();
        return redisTemplate;
    }

   @Bean
    public CacheManager cacheManager(RedisConnectionFactory factory) {
        RedisSerializer<String> redisSerializer = new StringRedisSerializer();
        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);

        // 配置序列化（解决乱码的问题）,过期时间30秒
        RedisCacheConfiguration config = RedisCacheConfiguration.defaultCacheConfig()
                .entryTtl(Duration.ofSeconds(1800000))
                .serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(redisSerializer))
                .serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(jackson2JsonRedisSerializer))
                .disableCachingNullValues();

        RedisCacheManager cacheManager = RedisCacheManager.builder(factory)
                .cacheDefaults(config)
                .build();
        return cacheManager;
    }
}

手动缓存时，未更改时结果如图：

更改之后：