1.前言
Spring从3.1开始定义了一系列抽象接口来统一不同的缓存技术;并支持使用JCache(JSR-107)注解简化我们进行缓存开发。Spring Cache 只负责维护抽象层,具体的实现由你的技术选型来决定。将缓存处理和缓存技术解除耦合。
2.主要依赖
Spring cache 抽象由spring-context相关组件实现。非Spring Boot 项目可通过引入该模块进行集成。
Spring Boot 项目可引入以下依赖:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-cache</artifactId>
</dependency>
同时可能需要引入你采用的缓存中间件客户端;比如 Ehcache、redis等。
3.重要抽象概念
4.常用的一些注解
Spring cache 提供了一系列的注解,将我们从编程开发中解放出来。让我们更加关注于业务开发。
4.1 @EnableCaching
该注解是启用Spring cache 的开关。必须开启才能使用Spring cache相关功能。
4.2 @Cacheable
可以标记在一个方法或者类上。方法级只针对该方法。类上则针对类内所有的方法。对于一个支持缓存的方法,Spring会在其被调用后将其返回值缓存起来,以保证下次利用同样的参数来执行该方法时可以直接从缓存中获取结果,而不需要再次执行该方法。Spring在缓存方法的返回值时是以键值对进行缓存的,值就是方法的返回结果。
public @interface Cacheable {
@AliasFor("cacheNames")
String[] value() default {};
//和value注解差不多,二选一
String[] cacheNames() default {};
// 该次缓存的key
String key() default "";
//key的生成器。key/keyGenerator二选一使用
String keyGenerator() default "";
//指定缓存管理器 一般使用默认
String cacheManager() default "";
//或者指定获取解析器 一般使用默认
String cacheResolver() default "";
//条件符合则缓存 使用的比较多 支持SpEL
String condition() default "";
//条件符合则不缓存 使用的比较多 支持SpEL
String unless() default "";
//是否使用异步模式
boolean sync() default false;
}
后面有个别注解属性跟这个基本相同不进行重复介绍。
4.3 @CacheConfig
作用于缓存接口上,来对该接口下的一些重复配置(缓存名称、key生成器、缓存管理器、缓存处理器)进行归纳处理。其他属性可参考Cacheable。
4.4 @CachePut
该注解容易跟@Cacheable混淆。两者都可以执行缓存的“放入”操作,不同于@Cacheable,@CachePut每次都将执行方法并将返回值K-V放入缓存,如果该K存在则进行更新。其他属性可参考Cacheable。
4.5 @CacheEvict
@CachEvict主要针对方法配置,能够根据一定的条件对特定的缓存进行清空。该注解有两个特别的属性:
beforeInvocation 是否在方法执行前就清空,缺省为 false,如果指定为 true,则在方法还没有执行的时候就清空缓存,缺省情况下,如果方法执行抛出异常,则不会清空缓存。
4.6 @Caching
该注解是个组合注解。有时候我们需要在一个方法上同时使用多个相同注解但是java是不支持一个注解在同一个方法上多次使用。这时就可以使用该注解进行组合。
5. 使用要点
6. 缓存实战
接下来我们通过Spring cache 集合redis 来实战一下,甚至有一些特别的玩法。假设redis环境已经搭建好了。Spring Boot 项目中引入:
<!-- redis -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<!-- spring cache -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-cache</artifactId>
</dependency>
<!-- lettuce 必备依赖 -->
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-pool2</artifactId>
</dependency>
在yml配置中我们大多可使用默认配置。配置spring.cache.type=REDIS 。其他配置可通过前缀spring.cache、spring.redis进行配置。
6.1 redis高级客户端
Spring Boot 2.x中 默认使用lettuce作为默认redis客户端。当然你也可以引入redisson客户端。这两种是非阻塞反应式高级redis客户端。建议放弃阻塞客户端jedis。
6.2 自定义缓存配置
如果我们使用默认的配置那么所有的K-V都不会自动过期。很多情况下我们有这样的需求,验证码缓存5分钟自动过期,区域信息30分钟。那么我们就需要自定义 CacheManager。代码如下:
public CacheManager cacheManager(RedisConnectionFactory redisConnectionFactory) {
return RedisCacheManager.RedisCacheManagerBuilder
.fromCacheWriter(RedisCacheWriter.nonLockingRedisCacheWriter(redisConnectionFactory))
// 默认策略,未配置的 key 会使用这个
.cacheDefaults(redisConfig(60))
// 自定义 key 策略
.withInitialCacheConfigurations(redisCacheConfigurationMap()).build();
}
cacheDefaults方法来指定默认配置。withInitialCacheConfigurations方法用来对各种缓存空间进行个性化配置。
redisCacheConfigurationMap方法是一个以缓存名称为key,其对应的redis配置类为值得键值映射。这个需要在开发中自己进行配置。参考`CacheNameEnum` 。
6.3 编写缓存处理类
经过上面的配置后,我们编写以下缓存类:
/**
* The type Captcha cache.
*
* @author dax
* @since 2019 /9/2 21:31
* @see cn.felord.rediscache.config.CacheNameEnum
*/
@Slf4j
@Component
@CacheConfig(cacheNames = {"smsCode"})
public class CaptchaCache {
@CachePut(key = "#key")
public String put(String key,String code){
log.info("执行 cachePut");
return code;
}
@CacheEvict(key = "#key")
public void expire(String key){
}
@Cacheable(key = "#key")
public String get(String key){
return null;
}
}
请注意 缓存名称 smsCode 在CacheNameEnum进行了个性化配置。
7. 总结
到上面我们的spring cache 缓存就搞完了。样例已经上传到了我的码云仓库,你可以通过以下地址:
https://gitee.com/felord/redis-cache
获取demo,结合本文进行学习一些高级玩法来应对你的业务开发。有什么问题可以留言或者其他方式进行咨询。
点击下方可查看其他干货▼
扫描二维码
关注我
SpringForAll社区
Original url: Access
Created at: 2019-09-26 16:20:17
Category: default
Tags: none
未标明原创文章均为采集,版权归作者所有,转载无需和我联系,请注明原出处,南摩阿彌陀佛,知识,不只知道,要得到
java windows火焰图_mob64ca12ec8020的技术博客_51CTO博客 - 在windows下不可行,不知道作者是怎样搞的 监听SpringBoot 服务启动成功事件并打印信息_监听springboot启动完毕-CSDN博客 SpringBoot中就绪探针和存活探针_management.endpoint.health.probes.enabled-CSDN博客 u2u转换板 - 嘉立创EDA开源硬件平台 Spring Boot 项目的轻量级 HTTP 客户端 retrofit 框架,快来试试它!_Java精选-CSDN博客 手把手教你打造一套最牛的知识笔记管理系统! - 知乎 - 想法有重合-理论可参考 安宇雨 闲鱼 机械键盘 客制化 开贴记录 文本 linux 使用find命令查找包含某字符串的文件_beijihukk的博客-CSDN博客_find 查找字符串 ---- mac 也适用 安宇雨 打字音 记录集合 B站 bilibili 自行搭建 开坑 真正的客制化 安宇雨 黑苹果开坑 查找工具包maven pom 引用地 工具网站 Dantelis 介绍的玩轴入坑攻略 --- 关于轴的一些说法 --- 非官方 ---- 心得而已 --- 长期开坑更新 [本人问题][新开坑位]关于自动化测试的工具与平台应用 机械键盘 开团 网站记录 -- 能做一个收集的程序就好了 不过现在没时间 -- 信息大多是在群里发的 - 你要让垃圾佬 都去一个地方看难度也是很大的 精神支柱 [超级前台]sprinbboot maven superdesk-app 记录 [信息有用] [环境准备] [基本完成] [sebp/elk] 给已创建的Docker容器增加新的端口映射 - qq_30599553的博客 - CSDN博客 [正在研究] Elasticsearch, Logstash, Kibana (ELK) Docker image documentation elasticsearch centos 安装记录 及 启动手记 正式服务器 39 elasticsearch 问题合集 不断更新 6.1.1 | 6.5.1 两个版本 博客程序 - 测试 - bug记录 等等问题 laravel的启动过程解析 - lpfuture - 博客园 OAuth2 Server PHP 用 Laravel 搭建带 OAuth2 验证的 RESTful 服务 | Laravel China 社区 - 高品质的 Laravel 和 PHP 开发者社区 利用Laravel 搭建oauth2 API接口 附 Unauthenticated 解决办法 - 煮茶的博客 - SegmentFault 思否 使用 OAuth2-Server-php 搭建 OAuth2 Server - 午时的海 - 博客园 基于PHP构建OAuth 2.0 服务端 认证平台 - Endv - 博客园 Laravel 的 Artisan 命令行工具 Laravel 的文件系统和云存储功能集成 浅谈Chromium中的设计模式--终--Observer模式 浅谈Chromium中的设计模式--二--pre/post和Delegate模式 浅谈Chromium中的设计模式--一--Chromium中模块分层和进程模型 DeepMind 4 Hacking Yourself README.md update 20211011
Laravel China 简书 知乎 博客园 CSDN博客 开源中国 Go Further Ryan是菜鸟 | LNMP技术栈笔记 云栖社区-阿里云 Netflix技术博客 Techie Delight Linkedin技术博客 Dropbox技术博客 Facebook技术博客 淘宝中间件团队 美团技术博客 360技术博客 古巷博客 - 一个专注于分享的不正常博客 软件测试知识传播 - 测试窝 有赞技术团队 阮一峰 语雀 静觅丨崔庆才的个人博客 软件测试从业者综合能力提升 - isTester IBM Java 开发 使用开放 Java 生态系统开发现代应用程序 pengdai 一个强大的博主 HTML5资源教程 | 分享HTML5开发资源和开发教程 蘑菇博客 - 专注于技术分享的博客平台 个人博客-leapMie 流星007 CSDN博客 - 舍其小伙伴 稀土掘金 Go 技术论坛 | Golang / Go 语言中国知识社区
最新评论