一、Spring Cache
1、简介
Spring Cache 是一个非常优秀的缓存组件。自Spring 3.1起,提供了类似于@Transactional注解事务的注解Cache支持,且提供了Cache抽象,方便切换各种底层Cache(如:redis)
使用Spring Cache的好处:
1,提供基本的Cache抽象,方便切换各种底层Cache;
2,通过注解Cache可以实现类似于事务一样,缓存逻辑透明的应用到我们的业务代码上,且只需要更少的代码就可以完成;
3,提供事务回滚时也自动回滚缓存;
4,支持比较复杂的缓存逻辑;
2、常用缓存标签(常用注解)
(1)缓存@Cacheable(最常用)
根据方法对其返回结果进行缓存,下次请求时,如果缓存存在,则直接读取缓存数据返回;如果缓存不存在,则执行方法,并把返回的结果存入缓存中。一般用在查询方法上。
查看源码,属性值如下:
属性/方法名 | 解释 |
---|---|
value | 缓存名,必填,它指定了你的缓存存放在哪块命名空间 |
cacheNames | 与 value 差不多,二选一即可 |
key | 可选属性,可以使用 SpEL 标签自定义缓存的key |
示例:
@Override
@Cacheable(value = "dict", keyGenerator = "keyGenerator")
public List<Dict> findChildData(Long id) {
// 构造条件
QueryWrapper<Dict> wrapper = new QueryWrapper<>();
wrapper.eq("parent_id", id);
// 查询数据
List<Dict> dicts = baseMapper.selectList(wrapper);
// 修改是否存在子节点数据值
for (Dict dict : dicts) {
dict.setHasChildren(isChildren(dict.getId()));
}
return dicts;
}
(2)缓存@CachePut
使用该注解标志的方法,每次都会执行,并将结果存入指定的缓存中。其他方法可以直接从响应的缓存中读取缓存数据,而不需要再去查询数据库。一般用在新增方法上。
查看源码,属性值如下:
属性/方法名 | 解释 |
---|---|
value | 缓存名,必填,它指定了你的缓存存放在哪块命名空间 |
cacheNames | 与 value 差不多,二选一即可 |
key | 可选属性,可以使用 SpEL 标签自定义缓存的key |
(3)缓存@CacheEvict
使用该注解标志的方法,会清空指定的缓存。一般用在更新或者删除方法上
查看源码,属性值如下:
属性/方法名 | 解释 |
---|---|
value | 缓存名,必填,它指定了你的缓存存放在哪块命名空间 |
cacheNames | 与 value 差不多,二选一即可 |
key | 可选属性,可以使用 SpEL 标签自定义缓存的key |
allEntries | 是否清空所有缓存,默认为 false。如果指定为 true,则方法调用后将立即清空所有的缓存 |
beforeInvocation | 是否在方法执行前就清空,默认为 false。如果指定为 true,则在方法执行前就会清空缓存 |
示例:导入数据后立即刷新数据
@Override
@CacheEvict(value = "dict", allEntries = true)
public void importDictData(MultipartFile file) {
// 直接读取我们上长传文件的流,对读取的数据进行处理在监听器里面实现
try {
EasyExcel.read(file.getInputStream(), DictEeVo.class, new DictListener(baseMapper))
.sheet()
.doRead();
} catch (IOException e) {
e.printStackTrace();
}
}
二、项目使用Spring Cache+Redis
1、导入依赖
因为我们的其他service模块都需要进行缓存数据,所以我们需要在service_util模块中导入依赖
<!-- 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>
2、配置Redis
同样在service_util中配置相关信息
package com.atdk.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;
/**
* Redis配置类
*
* @author qy
*/
@Configuration
@EnableCaching
public class RedisConfig {
/**
* 自定义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();
}
};
}
/**
* 设置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;
}
/**
* 设置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;
}
}
3、在cmn模块配置redis连接信息
那个模块使用Redis,那个模块配置Redis连接信息
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、字典模块使用
@Service
public class DictServiceImpl extends ServiceImpl<DictMapper, Dict> implements DictService {
/**
* 添加数据到缓存中
*
* @param id
* @return
*/
@Override
@Cacheable(value = "dict", keyGenerator = "keyGenerator")
public List<Dict> findChildData(Long id) {
// 构造条件
QueryWrapper<Dict> wrapper = new QueryWrapper<>();
wrapper.eq("parent_id", id);
// 查询数据
List<Dict> dicts = baseMapper.selectList(wrapper);
// 修改是否存在子节点数据值
for (Dict dict : dicts) {
dict.setHasChildren(isChildren(dict.getId()));
}
return dicts;
}
/**
* 实现字典数据导出功能
*
* @param response
*/
@Override
public void exportDictData(HttpServletResponse response) {
try {
// 1、设置下载的信息
// 1.1、再回传前,通过响应头告诉客户端返回的数据类型excel类型
response.setContentType("application/vnd.ms-excel");
// 1.2、设置下载的文件名字,且对中文进行utf-8编码
String fileName = URLEncoder.encode("数据字典.xlsx", "UTF-8");
// 1.3、设置响应头的信息,attachment(附件下载); fileName=(文件名)
response.setHeader("Content-Disposition", "attachment; fileName=" + fileName);
// 2、准备响应的数据流,使用response.getOutputStream(流数据);把流输出浏览器
// 因为我们需要读取数据,封装数据,所以我们需要先对数据进行处理
// 获取数据库字典信息
List<Dict> dicts = baseMapper.selectList(null);
// 创建写文件字典对象,vo上标注注解@ExcelProperty,专门用来导入和导出excel文件
List<DictEeVo> dictEeVos = new ArrayList<>();
// 把我们的dict对象,转换为dictEevo对象
for (Dict dict : dicts) {
// 创建需要转换的vo对象
DictEeVo dictEeVo = new DictEeVo();
// 调用BeanUtils.copyProperties转换,求实就是获取属性,设置属性的操作。
BeanUtils.copyProperties(dict, dictEeVo);
// 添加到集合中
dictEeVos.add(dictEeVo);
}
// 3、把EasyExcel写文件写入到response.getOutputStream()中,直接响应给客户端
EasyExcel.write(response.getOutputStream(), DictEeVo.class)
.sheet("dict").doWrite(dictEeVos);
} catch (IOException e) {
e.printStackTrace();
}
}
/**
* 导入字典数据
* allEntries=true 刷新我们的缓存
*
* @param file
*/
@Override
@CacheEvict(value = "dict", allEntries = true)
public void importDictData(MultipartFile file) {
// 直接读取我们上长传文件的流,对读取的数据进行处理在监听器里面实现
try {
EasyExcel.read(file.getInputStream(), DictEeVo.class, new DictListener(baseMapper))
.sheet()
.doRead();
} catch (IOException e) {
e.printStackTrace();
}
}
/**
* 传入的数据,进行查询数据,判断此id对应的节点是否
* 存在子节点,更具查询出的数量进行判断,if count>0说明存在数据,否则不存在数据
*
* @param id
* @return
*/
private boolean isChildren(Long id) {
// 构造条件
QueryWrapper<Dict> wrapper = new QueryWrapper<>();
wrapper.eq("parent_id", id);
Integer selectCount = baseMapper.selectCount(wrapper);
return selectCount > 0;
}
}