SpringBoot学习笔记【part14】Spring Cache + Redis 集成缓存数据

Spring Cache 是一个非常优秀的缓存组件方便切换各种底层Cache如redis
使用Spring Cache的好处

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

项目集成Spring Cache + Redis步骤如下。

第一步添加依赖

<!-- 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>

第二步配置application.properties

spring.redis.host=192.168.3.100
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

第三步添加配置类

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;


@Configuration
@EnableCaching
public class RedisConfig {

    /**
     * 1.自定义key规则自定义key为类名拼接方法名拼接参数名
     * @return
     */
    @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();
            }
        };
    }

    /**
     * 2.设置RedisTemplate规则
     * @param redisConnectionFactory
     * @return
     */
    @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.setHashValueSerializer(jackson2JsonRedisSerializer);

        redisTemplate.afterPropertiesSet();
        return redisTemplate;
    }

    /**
     * 3.设置CacheManager缓存规则
     * @param factory
     * @return
     */
    @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;
    }
}

@EnableCaching 注解用于开启缓存并配置Redis缓存管理器。@EnableCaching 将触发后置处理器,检查每一个 Spring bean 的 public 方法是否存在缓存注解。如果找到方法有缓存注解则自动创建一个代理拦截方法调用和处理相应的缓存行为。

第四步使用Spring Cache

常用缓存标签注解

① @Cacheable 查

根据方法对其返回结果进行缓存下次请求时如果缓存存在则直接读取缓存数据返回如果缓存不存在则执行方法并把返回的结果存入缓存中。一般用在查询方法上。

参数	说明
value	缓存名必填它指定了你的缓存存放在哪块命名空间
cacheNames	与 value 差不多二选一即可
key	可选属性可以使用 SpEL 标签自定义缓存的key
keyGenerator	指定自定义key规则生成器

② @CachePut 增

使用该注解标志的方法每次执行时会将结果存入指定的缓存中。其他方法可以直接从响应的缓存中读取缓存数据而不需要再去查询数据库。一般用在新增方法上。

参数	说明
value	缓存名必填它指定了你的缓存存放在哪块命名空间
cacheNames	与 value 差不多二选一即可
key	可选属性可以使用 SpEL 标签自定义缓存的key
keyGenerator	指定自定义key规则生成器

③ @CacheEvict 删、改

使用该注解标志的方法会清空指定的缓存让下次查操作时再自动更新最新的缓存。一般用在更新或者删除方法上。

参数	说明
value	缓存名必填它指定了你的缓存存放在哪块命名空间
cacheNames	与 value 差不多二选一即可
key	可选属性可以使用 SpEL 标签自定义缓存的 key
allEntries	是否清空所有缓存默认为 false。如果指定为 true则方法调用后将立即清空所有的缓存
beforeInvocation	是否在方法执行前就清空默认为 false。如果指定为 true则在方法执行前就会清空缓存

第五步编码并测试

注在后端架构中缓存的处理应该放在 Service 层也就是以上 3 个注解应该标记在 Service 方法上。

启动服务器测试成功写入 redis。

记录
        在测试过程中碰到一个问题启动 Spring Cache 后查询方法将不执行了。经过排查发现后台报错 Unable to connect to 192.168.3.100:6379 这个错误时因为redis 默认端口号 6379 在Linux防火墙中不允许进行远程连接。
        需要执行如下Linux命令 /sbin/iptables -I INPUT -p tcp --dport 6379 -j ACCEPT 在防火墙中开启 6379 端口的远程服务。