标签：target 动态 github stc mongo 简单介绍 fda 关联 生效
前言
在上一篇文章Spring Boot之集成Redis（二）：集成Redis中，我们一起学习了如何使用StringRedisTemplate来与Redis进行交互，但也在文末提到这种方式整体代码还是比较多的，略显臃肿，并剧透了另外一种操作Redis的方式：
今天的内容厉害啦，不仅能学会在Spring Boot中更好的使用Redis，还能学习Spring Cache！
我们一起拨开云雾睹青天吧！
整体步骤
1. 安装commons-pool2依赖；
由于我们会在application.properties配置文件中配置lettuce类型的redis连接池，因此需要引入新的依赖：
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-pool2</artifactId>
</dependency>
mvn install -Dmaven.test.skip=true -Dmaven.wagon.http.ssl.insecure=true -Dmaven.wagon.http.ssl.allowall=true
2. 修改application.properties配置；
application.properties文件整体样子：
server.port=8080
# 设置Spring Cache的缓存类型为redis
spring.cache.type=redis
# Redis数据库索引（默认为0）
spring.redis.database=0
# Redis服务端的host和port
spring.redis.host=127.0.0.1
spring.redis.port=6379
# Redis服务端的密码
spring.redis.password=Redis!123
# Redis最大连接数
spring.redis.pool.max-active=8
# 连接池最大连接数（使用负值表示没有限制）
spring.redis.lettuce.pool.max-active=8
# 连接池最大阻塞等待时间（使用负值表示没有限制）
spring.redis.lettuce.pool.max-wait=-1
# 连接池中的最大空闲连接
spring.redis.lettuce.pool.max-idle=8
# 连接池中的最小空闲连接
spring.redis.lettuce.pool.min-idle=0
# Redis连接超时时间，单位 ms（毫秒）
spring.redis.timeout=5000
特别是spring.cache.type=redis这个配置，指定了redis作为Spring Cache的缓存（还有多种可选的缓存方式，如Simple、none、Generic、JCache、EhCache、Hazelcast等，请读者有需要自行脑补哈）。
3. 学习Spring Cache的缓存注解；
Spring Cache提供了5个缓存注解，通常直接使用在Service类上，各有其作用：
@Cacheable 作用在方法上，触发缓存读取操作。
被作用的方法如果缓存中没有，比如第一次调用，则会执行方法体，执行后就会进行缓存，而如果已有缓存，那么则不再执行方法体；
@CachePut 作用在方法上，触发缓存更新操作；
被作用的方法每次调用都会执行方法体；
@CachePut 作用在方法上，触发缓存失效操作；
也即清除缓存，被作用的方法每次调用都会执行方法体，并且使用方法体返回更新缓存；
@Caching作用在方法上，注解中混合使用@Cacheable、@CachePut、@CacheEvict操作，完成复杂、多种缓存操作；
比如同一个方法，关联多个缓存，并且其缓存名字、缓存key都不同时，或同一个方法有增删改查的缓存操作等，被作用的方法每次调用都会执行方法体。
在类上设置当前缓存的一些公共设置，也即类级别的全局缓存配置。
4. 使用Spring Cache的缓存注解操作Redis；
1). 修改项目入口类；
2). 编写演示用实体类；
3). 编写演示用Service类；
4). 编写演示用Controller类；
在Spring Boot项目入口类App.java上添加注解：@EnableCaching，App.java类整体如下：
package com.github.dylanz666;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cache.annotation.EnableCaching;
/**
* @author : dylanz
* @since : 10/28/2020
*/
@SpringBootApplication
@EnableCaching
public class App {
public static void main(String[] args) {
SpringApplication.run(App.class, args);
}
}
在domain包内建立演示用实体类User.java，简单撸点代码演示一下：
package com.github.dylanz666.domain;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.stereotype.Component;
import java.io.Serializable;
/**
* @author : dylanz
* @since : 10/31/2020
*/
@NoArgsConstructor
@AllArgsConstructor
@Data
@Component
public class User implements Serializable {
private static final long serialVersionUID = 1L;
private String userName;
private String roleName;
@Override
public String toString() {
return "{" +
"\"userName\":\"" + userName + "\"," +
"\"roleName\":" + roleName + "" +
"}";
}
}
重点来了，在service包内新建UserService类，编写带有Spring Cache注解的方法们，代码如下：
package com.github.dylanz666.service;
import com.github.dylanz666.domain.User;
import org.springframework.cache.annotation.CacheEvict;
import org.springframework.cache.annotation.CachePut;
import org.springframework.cache.annotation.Cacheable;
import org.springframework.cache.annotation.Caching;
import org.springframework.stereotype.Service;
/**
* @author : dylanz
* @since : 10/31/2020
*/
@Service
public class UserService {
@Cacheable(value = "content", key = "‘id_‘+#userName")
public User getUserByName(String userName) {
System.out.println("io operation : getUserByName()");
//模拟从数据库中获取数据
User userInDb = new User();
userInDb.setUserName("dylanz");
userInDb.setRoleName("adminUser");
return userInDb;
}
@CachePut(value = "content", key = "‘id_‘+#user.userName")
public User updateUser(User user) {
System.out.println("io operation : updateUser()");
//模拟从数据库中获取数据
User userInDb = new User();
userInDb.setUserName(user.getUserName());
userInDb.setRoleName(user.getRoleName());
return userInDb;
}
@CacheEvict(value = "content", key = "‘id_‘+#user.userName")
public void deleteUser(User user) {
System.out.println("io operation : deleteUser()");
}
@Caching(cacheable = {
@Cacheable(cacheNames = "test", key = "‘id_‘+#userName")
}, put = {
@CachePut(value = "testGroup", key = "‘id_‘+#userName"),
@CachePut(value = "user", key = "#userName")
})
public User getUserByNameAndDoMultiCaching(String userName) {
System.out.println("io operation : getUserByNameAndDoMultiCaching()");
//模拟从数据库中获取数据
User userInDb = new User();
userInDb.setUserName("dylanz");
userInDb.setRoleName("adminUser");
return userInDb;
}
}
//模拟从数据库中获取数据
User userInDb = new User();
userInDb.setUserName("dylanz");
userInDb.setRoleName("adminUser");
我写了4个方法getUserByName(String userName)、
updateUser(User user)、deleteUser(User user)、getUserByNameAndDoMultiCaching(String userName)分别用于演示查询缓存、更新缓存、删除缓存，以及同一个方法使用混合缓存注解；
缓存注解中使用了2个基本属性（还有其他属性），value（也可以用cacheNames）和key，key如果是从方法体获取的，则需要在key前加#号，比如key="#userName"或者key = "‘id_‘+#userName"，当然也可以写死如key="test123"；
缓存注解中的key属性值可以从对象中获取，如：key = "‘id_‘+#user.userName"；
缓存注解的value（或cacheNames）属性、key属性共同构成了Redis服务端中完整的key，如value = "content", key = "test123"，则在Redis服务端，其完整key为：content::test123；
@Caching中可混合使用缓存注解@Cacheable、@CachePut、@CacheEvict，对应的属性是：cacheable、put、evict，复杂场景有帮助！
3). 编写演示用Controller类；
在controller包内新建UserController.java类，编写4个API，分别使用Service中的4个带有Spring Cache注解的方法们，代码如下：
package com.github.dylanz666.controller;
import com.github.dylanz666.domain.User;
import com.github.dylanz666.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
/**
* @author : dylanz
* @since : 10/31/2020
*/
@RestController
@RequestMapping("/api/user")
public class UserController {
@Autowired
private UserService userService;
@GetMapping("")
public @ResponseBody User getUserByName(@RequestParam String userName) {
return userService.getUserByName(userName);
}
@PutMapping("")
public @ResponseBody
User updateUser(@RequestBody User user) {
return userService.updateUser(user);
}
@DeleteMapping("")
public @ResponseBody String deleteUser(@RequestBody User user) {
userService.deleteUser(user);
return "success";
}
@GetMapping("/multiCaching")
public @ResponseBody User getUserByNameAndDoMultiCaching(@RequestParam String userName) {
return userService.getUserByNameAndDoMultiCaching(userName);
}
}
5. Spring Cache + Redis 缓存演示；
redis-server.exe redis.windows.conf
启动：
redis-cli.exe -h 127.0.0.1 - p 6379
auth Redis!123
在Redis客户端，进入monitor模式，命令：
monitor
同时为了更直观的让大家看到缓存有起到效果，我在Service层的方法内，都往控制台打印了一些文字，如：io operation : getUserByName()...
6. 配置类方式配置和管理Redis缓存；
在config包内创建Redis配置类RedisConfig.java，并编写如下代码：
package com.github.dylanz666.config;
import org.springframework.cache.CacheManager;
import org.springframework.cache.annotation.EnableCaching;
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.*;
import java.time.Duration;
/**
* @author : dylanz
* @since : 10/31/2020
*/
1). 默认情况下Redis的序列化会使用jdk序列化器JdkSerializationRedisSerializer，而该序列化方式，在存储内容时除了属性的内容外还存了其它内容在里面，总长度长，且不容易阅读，因此我们自定义了序列化策略：redisTemplate()，使用该自定义序列化方式后，存储在Redis的内容就比较容易阅读了！
2). Spring Cache注解方式，默认是没有过期概念的，即设置了缓存，则一直有效，这显然不能完全满足使用要求，而RedisConfig中的CacheManager给我们提供了一种方式来设置缓存过期策略！
3). cacheManager()用于配置缓存管理器，我们在方法内配置了一个entryTtl为1分钟，TTL即Time To Live，代表缓存可以生存多久，我没有在cacheManager()方法内指明哪个缓存，因此该TTL是针对所有缓存的，是全局性的，也是我们设置的默认TTL；
4). 我们可以给不同的key设置不同的TTL，但hard code的缓存key就有点多啦，此处不介绍啦！
5). 该配置类使用了注解@EnableCaching，则Spring Boot入口类App.java中的@EnableCaching注解就可以删除啦！
7. 动态缓存有效期的实现；
动态缓存有效期的实现有多种方式，如：
1). 在缓存注解上使用不同的自定义的CacheManager；
2). 自定义Redis缓存有效期注解；
3). 利用在Spring Cache缓存注解中value属性中设置的值，设置缓存有效期；
在第6步中，我们使用了一个全局的CacheManager，其实这个可以更灵活，可以用于给不同的缓存设置不同的TTL，也即缓存过期。
我们可以在RedisConfig.java中编写多个不同名字的CacheManager，每个CacheManager使用不同的TTL。
然后缓存注解中使用不同的CacheManager，就能达到不同缓存有不同TTL的目的啦，并且没有在CacheManager中hard code缓存key，演示代码：
package com.github.dylanz666.config;
import org.springframework.cache.CacheManager;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
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.*;
import java.time.Duration;
/**
* @author : dylanz
* @since : 10/31/2020
*/