分布式预约挂号平台（十） | 郑医宝の数据字典 使用Spring Cache + Redis技术 实现数据字典的 缓存功能

缓存的目的是为了提高查询速度。不经常修改的固定的，且经常查询的数据，是适合做缓存的数据

一、Spring Cache + Redis 缓存技术

Spring Cache是一个非常优秀的缓存组件
从Spring3.1，提供**@Transactional注解事务的注解Cache支持
提供Cache抽象，方便切换各种底层Cache（如Redis）**

Spring Cache的好处

1.提供基本的Cache抽象，方便切换各种底层的Cache
2.提供注解Cache可以实现类似于事务一样，缓存逻辑透明的应用到我们的代码上，需要更少的代码完成
3.提供事务宦官时也自动回滚缓存
4.支持比较复杂的缓存逻辑

二、安装Redis

windows、linux、Ubuntu操作系统下安装Redis

三、项目集成Spring Cache + Redis

1.添加依赖

缓存是公共使用，所有service模块都可能使用，把依赖添加到common下的service-util模块的pom.xml文件中

<dependencies>

    <dependency>
        <groupId>com.zhengyibao</groupId>
        <artifactId>common_util</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </dependency>

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

    <!--spring2.x集成redis所需要的common-pool2-->
    <dependency>
        <groupId>org.apache.commons</groupId>
        <artifactId>commons-pool2</artifactId>
        <version>2.6.0</version>
    </dependency>
    
</dependencies>

2.添加redis配置类

common/service_util/src/main/java/com/zhengyibao/yygh/common/config/RedisConfig

package com.zhengyibao.yygh.common.config;

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.cache.CacheManager;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.cache.interceptor.KeyGenerator;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.cache.RedisCacheConfiguration;
import org.springframework.data.redis.cache.RedisCacheManager;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.RedisSerializationContext;
import org.springframework.data.redis.serializer.RedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;

import java.lang.reflect.Method;
import java.time.Duration;


/**
 * @author wenmiao
 * @create 2021-10-13 11:05
 * @explain redis的配置类
 */

@Configuration   //代表其是一个配置类
@EnableCaching   //代表开启缓存处理
public class RedisConfig {

    //redis是一个 key value的形式
    //自定义key规则，包含包的名字，类的名字，方法的名字和多参数的名称
    @Bean
    public KeyGenerator keyGenerator(){
        return new KeyGenerator(){
            @Override
            public Object generate(Object target, Method method, Object... params){
                StringBuilder sb=new StringBuilder();
                sb.append(target.getClass().getName());
                sb.append(method.getName());
                for(Object obj:params){
                    sb.append(obj.toString());
                }
                return sb.toString();
            }
        };
    }

    //设置RedisTemplate规则
    @Bean
    public RedisTemplate<Object,Object> redisTemplate(RedisConnectionFactory redisConnectionFactory){
        RedisTemplate<Object,Object> redisTemplate=new RedisTemplate<>();
        redisTemplate.setConnectionFactory(redisConnectionFactory);
        Jackson2JsonRedisSerializer jackson2JsonRedisSerializer=new Jackson2JsonRedisSerializer(Object.class);
        //解决查询缓存转换异常的问题
        ObjectMapper om=new ObjectMapper();
        //指定要序列换的域，field,get,set及修饰符范围，ANY是都有包括private和public
        om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        //指定序列化输入的类型，类必须是非final修饰的，final修饰的类，比如String，Integer等会抛出异常
        om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        jackson2JsonRedisSerializer.setObjectMapper(om);
        //序列号key value
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.setValueSerializer(jackson2JsonRedisSerializer);
        redisTemplate.setHashKeySerializer(new StringRedisSerializer());
        redisTemplate.setHashKeySerializer(jackson2JsonRedisSerializer);

        redisTemplate.afterPropertiesSet();
        return redisTemplate;
    }

    //设置CacheManager缓存规则
    @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);
        //配置序列化（解决乱码问题）,过期时间600秒
        RedisCacheConfiguration config=RedisCacheConfiguration.defaultCacheConfig()
                .entryTtl(Duration.ofSeconds(600))
                .serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(redisSerializer))
                .serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(jackson2JsonRedisSerializer))
                .disableCachingNullValues();
        RedisCacheManager cacheManager=RedisCacheManager.builder(factory)
                .cacheDefaults(config)
                .build();
        return cacheManager;
    }
}

3.添加redis配置

common/service_cmn/resources/application.properties

spring.redis.host=192.168.44.165
spring.redis.port=6379
spring.redis.database=0
spring.redis.timeout=1800000  
spring.redis.lettuce.pool.max-active=20
spring.redis.lettuce.pool.max-wait=-1
# 最大阻塞等待时机按（负数消失没有限制）
spring.redis.lettuce.pool.max-idle=5
spring.redis.lettuce.pool.min-idle=0

4.常用的缓存标签的了解

4.1 缓存Cacheable

一般用在查询方法上
直接查询缓存，第一次查询缓存中没有结果，根据查询方法方法去查询数据库，并将查询结果存入缓存中，下次请求，查询缓存存在，就直接读取缓存数据返回。

属性	功能
value	缓存名，必选，指定缓存存放在哪块命名空间
cacheNames	与value差不多，二选一即可
key	可选属性，可以使用SpEL标签自定义缓存的key

4.2 缓存CachePut

一般用在添加方法上
使用该注解标志的方法，每次都会执行，并将插入的内容存入指定缓存中，其他方法可以直接从响应的缓存中读取缓存数据，而不需要再去查询数据库

属性	功能
value	缓存名，必选，指定缓存存放在哪块命名空间
cacheNames	与value差不多，二选一即可
key	可选属性，可以使用SpEL标签自定义缓存的key

4.3 缓存CacheEvict

一般用在更新或删除方法上
使用该注解标志的方法，会清空指定的缓存

属性	功能
value	缓存名，必选，指定缓存存放在哪块命名空间
cacheNames	与value差不多，二选一即可
key	可选属性，可以使用SpEL标签自定义缓存的key
allEntries	是否清空所有缓存，默认为false，若指定为true，则方法调用后立即清空所有缓存
beforeInvocation	是否在方法执行前就清空，默认为false，若为true，就在方法执行前就会清空缓存

5.数据字典应用redis缓存

5.1在DictServiceImpl的查询方法中添加注解

//将查询到的dictList放到缓存中，value定义的是缓存名为dict，keyGenerator就是RedisConfig生成的自定义key
@Cacheable(value = "dict" , keyGenerator = "keyGenerator")
//注意：@Cacheabl注解导入的是springframework的包：import org.springframework.cache.annotation.Cacheable;

5.1在DictServiceImpl的添加方法中添加注解

@CacheEvict(value="dict" ,allEntries = true)   //在添加数据时，先将缓存中的内容清空，清空后再重新往里面加数据

6.测试

dict::com.zhengyibao.yygh.cmn.service.impl.DictServiceImplfindDictList就是生成的keyGenerator

缓存中的数据