SpringBoot-Reactive-Redis缓存注解

发表于 更新于 分类于 ， ， 置顶 精品
阅读次数： 本文字数： 987 阅读时长 ≈ 4 分钟

摘要

前言

最近在使用WebFlux时发现，SpringBoot提供的@Cacheable，@CachePut，@CacheEvict和@Caching注解不支持响应式方法，SpringBoot官方也没有提供响应式方法的缓存注解，看到网上的一些解决方案都是直接在方法代码中加入缓存数据的代码逻辑，这样虽然可以解决问题，但是代码侵入并不优雅，于是萌生自己写一个基于redis的响应式方法缓存注解的想法，本项目参考SpringBoot提供的@Cacheable，@CachePut，@CacheEvict和@Caching注解声明，但是只是实现了一些基本功能，可以满足绝大部分使用场景的要求，因为SpringBoot早晚会给出官方解决方案，在此之前，不妨一试。

使用示例

  • 本项目已经发布到maven中央仓库，直接在项目中添加依赖即可。

  • 1.1.0及以下版本是基于springboot:2.4.0构建，可以在springboot2.0+的项目中使用。

  • 2.x.x及以上版本是基于springboot:2.17.15构建，可以在springboot2.17+(包含3.x+)的项目中使用。

  • maven依赖

1
2
3
4
5
<dependency>
  <groupId>com.hanqunfeng</groupId>
  <artifactId>reactive-redis-cache-annotation-spring-boot-starter</artifactId>
  <version>{latest-version}</version>
</dependency>

  • gradle依赖

1
implementation 'com.hanqunfeng:reactive-redis-cache-annotation-spring-boot-starter:{latest-version}'

  • 此时项目中可能还要添加其它依赖，以gradle举例

1
2
3
4
5
6
7
8
9
10
11
//webflux，非必须，主要是面向响应式编程的，所以使用springboot大概率会使用webflux
implementation 'org.springframework.boot:spring-boot-starter-webflux'

//Spring Boot Redis 依赖，或者spring-boot-starter-data-redis-reactive，任选其一即可，注意要在配置文件中加入redis的配置
implementation 'org.springframework.boot:spring-boot-starter-data-redis'

//redis lettuce连接池依赖，也可以使用jedis连接池，非必须，正式环境建议开启连接池
implementation 'org.apache.commons:commons-pool2'

//aop 面向方面编程 支持@Aspect，非必须
implementation 'org.springframework.boot:spring-boot-starter-aop'

  • 方法返回值必须是Mono或者Flux类型，使用方式与springboot提供的Cacheable等注解类似

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
/**
* 缓存 cacheName和key支持EL表达式，实际key的名称是"cacheName:key"
* 缓存结果
* key:sys-user:find_lisi
* value:
* [
* "com.example.model.SysUser"
* {
*    id:"5c74a4e4-c4f2-4570-8735-761d7a570d36"
*    username:"lisi"
*    password:"$2a$10$PXoGXLwg05.5YO.QtZa46ONypBmiK59yfefvO1OGO8kYFwzOB.Os6"
*    enable:true
* }
* ]
*/
@ReactiveRedisCacheable(cacheName = "sys-user", key = "'find_' + #username")
public Mono<SysUser> findUserByUsername(String username) {
    return sysUserRepository.findByUsername(username);
}

@ReactiveRedisCacheable(cacheName = "sys-user", key = "all")
public Flux<SysUser> findAll() {
    return sysUserRepository.findAll();
}

/**
* 删除缓存，allEntries = true 表示删除全部以"cacheName:"开头的缓存
* allEntries 默认false，此时需要指定key的值，表示删除指定的"cacheName:key"
*/
@ReactiveRedisCacheEvict(cacheName = "sys-user", allEntries = true)
public Mono<SysUser> add(SysUser sysUser) {
    return sysUserRepository.addSysUser(sysUser.getId(), sysUser.getUsername(), sysUser.getPassword(), sysUser.getEnable()).flatMap(data -> sysUserRepository.findById(sysUser.getId()));
}

/**
* 组合注解，用法与@Caching类似
* 规则：
* 1.cacheables不能与cacheEvicts或者cachePuts同时存在，因为后者一定会执行方法主体，达不到调用缓存的目的，所以当cacheables存在时，后者即便指定也不执行
* 2.先执行cacheEvicts，再执行cachePuts
*/
@ReactiveRedisCaching(
        evict = {@ReactiveRedisCacheEvict(cacheName = "sys-user", key = "all")},
        put = {@ReactiveRedisCachePut(cacheName = "sys-user", key = "'find_' + #sysUser.username")}
)
public Mono<SysUser> update(SysUser sysUser) {
    Mono<SysUser> save = sysUserRepository.save(sysUser);
    return save;
}

/**
* 删除指定的"cacheName:key"
*/
@ReactiveRedisCacheEvict(cacheName = "sys-user", key="'find_' + #username")
public Mono<Boolean> deleteByUserName(String username) {
    return sysUserRepository.deleteByUsername(username);
}

RedisTemplate

  • 如果使用时没有创建RedisTemplate，本项目中提供了一个默认的RedisTemplate，基于jackson序列化，支持jdk8的LocalDate和LocalDateTime

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
@Bean
@ConditionalOnMissingBean(value = RedisTemplate.class)
public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {

    log.debug("ReactiveRedisConfig RedisTemplate");
    ObjectMapper objectMapper = new ObjectMapper();
    objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
    //objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
    objectMapper.activateDefaultTyping(objectMapper.getPolymorphicTypeValidator(), ObjectMapper.DefaultTyping.NON_FINAL, JsonTypeInfo.As.WRAPPER_ARRAY);

    //LocalDateTime系列序列化和反序列化模块，继承自jsr310，我们在这里修改了日期格式
    JavaTimeModule javaTimeModule = new JavaTimeModule();
    //序列化
    javaTimeModule.addSerializer(LocalDateTime.class, new LocalDateTimeSerializer(
            DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)));
    javaTimeModule.addSerializer(LocalDate.class,
            new LocalDateSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)));
    javaTimeModule.addSerializer(LocalTime.class,
            new LocalTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
    //反序列化
    javaTimeModule.addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer(
            DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)));
    javaTimeModule.addDeserializer(LocalDate.class,
            new LocalDateDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)));
    javaTimeModule.addDeserializer(LocalTime.class,
            new LocalTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));

    //注册模块
    objectMapper.registerModule(javaTimeModule);

    Jackson2JsonRedisSerializer<Object> serializer = new Jackson2JsonRedisSerializer<>(Object.class);
    serializer.setObjectMapper(objectMapper);

    RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
    redisTemplate.setConnectionFactory(redisConnectionFactory);
    redisTemplate.setKeySerializer(new StringRedisSerializer());
    redisTemplate.setValueSerializer(serializer);
    redisTemplate.setHashKeySerializer(new StringRedisSerializer());
    redisTemplate.setHashValueSerializer(serializer);
    redisTemplate.afterPropertiesSet();

    return redisTemplate;
}

Github示例代码

开启debug日志

1
2
3
logging:
  level:
    com.hanqunfeng.reactive.redis.cache: DEBUG