Spring 的 Redis缓存注解 - 版本历史

Eijux：/* 使用 RedisTemplate 模板 API 完成 CRUD 的实践案例 */

2021-11-08T15:13:07Z

使用 RedisTemplate 模板 API 完成 CRUD 的实践案例

←上一版本		2021年11月8日 (一) 23:13的版本
第76行：		第76行：
	对比来说，在实际的运行时，CGLib代理类比使用Java反射代理类的效率要高。【参见：[[动态代理、CGLIB 与切面编程]]】		对比来说，在实际的运行时，CGLib代理类比使用Java反射代理类的效率要高。【参见：[[动态代理、CGLIB 与切面编程]]】

	== 使用 ~~RedisTemplate 模板 API 完成~~ CRUD 的实践案例 ==		== 使用 Spring 缓存注解完成 CRUD 的实践案例 ==
	简单介绍一下Spring的三个缓存注解：@CachePut、@CacheEvict、@Cacheable，通常都加在方法的前面，大致的作用如下：		简单介绍一下Spring的三个缓存注解：@CachePut、@CacheEvict、@Cacheable，通常都加在方法的前面，大致的作用如下：
	# @CachePut：作用是设置缓存。		# @CachePut：作用是设置缓存。

Eijux：/* @EnableCaching */

2021-11-08T02:48:07Z

@EnableCaching

←上一版本		2021年11月8日 (一) 10:48的版本
第390行：		第390行：
	=== '''@EnableCaching''' ===		=== '''@EnableCaching''' ===
	----		----
	@EnableCaching：开关性注解，在'''项目启动类'''或'''某个配置类'''~~上使用此注解后，则表示允许使用注解的方式进行缓存操作。~~		@EnableCaching：开关性注解，在'''项目启动类'''或'''某个配置类'''上使用此注解后，则表示允许使用注解的方式进行缓存操作。【自 Spring 3.1 加入了该注解】
	* 如果没有引入任何缓存中间件的话，那么 Spring 缓存注解默认操作的就是本机的缓存；而如果引入了 Redis 这样的缓存中间件的话，Spring 缓存注解操作的就是 Redis 中的缓存了。		* 当在配置类（@Configuration）上使用 @EnableCaching 注解时，会触发一个 post processor，这会扫描每一个 spring bean，查看是否已经存在注解对应的缓存。
			*: 如果找到了，就会自动创建一个代理拦截方法调用，使用缓存的 bean 执行处理。
			* 以上内容使用 xml 配置方法开启缓存注解功能，所以为使用此注解。
			*: 如果使用了这个注解，那么就不需要在 XML 文件中配置：“<cache:annotation-driven/>”、“cache manager”等内容了。


			如果没有引入任何缓存中间件的话，那么 Spring 缓存注解默认操作的就是本机的缓存；而如果引入了 Redis 这样的缓存中间件的话，Spring 缓存注解操作的就是 Redis 中的缓存了。

	== 缓存注解中的 SpringEL 表达式 ==		== 缓存注解中的 SpringEL 表达式 ==

Eijux：/* 缓存注解详解 */

2021-11-08T02:34:26Z

缓存注解详解

←上一版本		2021年11月8日 (一) 10:34的版本
第225行：		第225行：

	</syntaxhighlight>		</syntaxhighlight>


	=== @CachePut ===		=== @CachePut ===
			----
	@CachePut：用于'''增加/更新缓存'''，每次执行方法后，会将结果存入指定缓存的 Key 键上。		@CachePut：用于'''增加/更新缓存'''，每次执行方法后，会将结果存入指定缓存的 Key 键上。
	* 如果作用于 void 方法上：仍然会向缓存中进行存储，不过键值对中的 value 为 null。		* 如果作用于 void 方法上：仍然会向缓存中进行存储，不过键值对中的 value 为 null。
第262行：		第262行：

	=== @Cacheable ===		=== @Cacheable ===
			----
	@Cacheable：用于'''查询（更新）缓存'''，只有当 key 在缓存中不存在的情况下才执行方法（并更新缓存）。		@Cacheable：用于'''查询（更新）缓存'''，只有当 key 在缓存中不存在的情况下才执行方法（并更新缓存）。
	* 与 @CachePut ~~注解一样，@Cacheable 也具备增加缓存的能力。~~		* 如果作用于 void 方法上：仍然会向缓存中进行存储，不过键值对中的 value 为 null。
	** ~~但与 @CachePut 不同之处的是：~~@CachePut 在方法执行前不去进行缓存检查，无论之前是否有缓存，都会将新的执行结果加入到缓存中。		* 与 @CachePut 注解：
	* 需要注意的是，不要在一个方法上同时使用 @Cacheable 和 @CachePut。		*# 相同：都具备增加缓存的能力。
			*# 不同：@CachePut 在方法执行前不去进行缓存检查，无论之前是否有缓存，都会将新的执行结果加入到缓存中。
			** 需要注意的是，不要在一个方法上同时使用 @Cacheable 和 @CachePut。


第277行：		第280行：
	# '''cacheManager'''		# '''cacheManager'''
	# '''cacheResolver'''		# '''cacheResolver'''


	=== @CacheEvict ===		=== @CacheEvict ===
			----
	@CacheEvict：用于'''清除缓存'''。		@CacheEvict：用于'''清除缓存'''。

第315行：		第318行：
	}		}
	</syntaxhighlight>		</syntaxhighlight>


	=== @Caching ===		=== @Caching ===
			----
	@Caching 注解，是一个缓存处理的'''组合注解'''。		@Caching 注解，是一个缓存处理的'''组合注解'''。
	* 通过 @Caching，可以一次指定多个 Spring Cache 注解的组合。		* 通过 @Caching，可以一次指定多个 Spring Cache 注解的组合。
第356行：		第359行：
	}		}
	</syntaxhighlight>		</syntaxhighlight>


	=== @CacheConfig ===		=== @CacheConfig ===
			----
	@CacheConfig：用于抽取缓存的公共配置。【类级别】		@CacheConfig：用于抽取缓存的公共配置。【类级别】
	* 允许共享：cacheNames、KeyGenerator、CacheManager 和 CacheResolver。		* 允许共享：cacheNames、KeyGenerator、CacheManager 和 CacheResolver。
第384行：		第387行：
	# '''cacheManager'''：		# '''cacheManager'''：
	# '''cacheResolver'''：		# '''cacheResolver'''：


	=== '''@EnableCaching''' ===		=== '''@EnableCaching''' ===
			----
	@EnableCaching：开关性注解，在'''项目启动类'''或'''某个配置类'''上使用此注解后，则表示允许使用注解的方式进行缓存操作。		@EnableCaching：开关性注解，在'''项目启动类'''或'''某个配置类'''上使用此注解后，则表示允许使用注解的方式进行缓存操作。
	* 如果没有引入任何缓存中间件的话，那么 Spring 缓存注解默认操作的就是本机的缓存；而如果引入了 Redis 这样的缓存中间件的话，Spring 缓存注解操作的就是 Redis 中的缓存了。		* 如果没有引入任何缓存中间件的话，那么 Spring 缓存注解默认操作的就是本机的缓存；而如果引入了 Redis 这样的缓存中间件的话，Spring 缓存注解操作的就是 Redis 中的缓存了。


	== 缓存注解中的 SpringEL 表达式 ==		== 缓存注解中的 SpringEL 表达式 ==

Eijux：/* @CachePut */

2021-11-08T02:29:28Z

@CachePut

←上一版本		2021年11月8日 (一) 10:29的版本
第229行：		第229行：
	=== @CachePut ===		=== @CachePut ===
	@CachePut：用于'''增加/更新缓存'''，每次执行方法后，会将结果存入指定缓存的 Key 键上。		@CachePut：用于'''增加/更新缓存'''，每次执行方法后，会将结果存入指定缓存的 Key 键上。
			* 如果作用于 void 方法上：仍然会向缓存中进行存储，不过键值对中的 value 为 null。


第259行：		第260行：
	}		}
	</syntaxhighlight>		</syntaxhighlight>


	=== @Cacheable ===		=== @Cacheable ===

Eijux：/* 缓存注解中的 SpringEL 表达式 */

2021-11-08T02:25:18Z

缓存注解中的 SpringEL 表达式

←上一版本		2021年11月8日 (一) 10:25的版本
第389行：		第389行：
	@EnableCaching：开关性注解，在'''项目启动类'''或'''某个配置类'''上使用此注解后，则表示允许使用注解的方式进行缓存操作。		@EnableCaching：开关性注解，在'''项目启动类'''或'''某个配置类'''上使用此注解后，则表示允许使用注解的方式进行缓存操作。
	* 如果没有引入任何缓存中间件的话，那么 Spring 缓存注解默认操作的就是本机的缓存；而如果引入了 Redis 这样的缓存中间件的话，Spring 缓存注解操作的就是 Redis 中的缓存了。		* 如果没有引入任何缓存中间件的话，那么 Spring 缓存注解默认操作的就是本机的缓存；而如果引入了 Redis 这样的缓存中间件的话，Spring 缓存注解操作的就是 Redis 中的缓存了。


	== 缓存注解中的 SpringEL 表达式 ==		== 缓存注解中的 SpringEL 表达式 ==

Eijux：/* @EnableCaching */

2021-11-08T02:25:02Z

@EnableCaching

←上一版本		2021年11月8日 (一) 10:25的版本
第388行：		第388行：
	=== '''@EnableCaching''' ===		=== '''@EnableCaching''' ===
	@EnableCaching：开关性注解，在'''项目启动类'''或'''某个配置类'''上使用此注解后，则表示允许使用注解的方式进行缓存操作。		@EnableCaching：开关性注解，在'''项目启动类'''或'''某个配置类'''上使用此注解后，则表示允许使用注解的方式进行缓存操作。
			* 如果没有引入任何缓存中间件的话，那么 Spring 缓存注解默认操作的就是本机的缓存；而如果引入了 Redis 这样的缓存中间件的话，Spring 缓存注解操作的就是 Redis 中的缓存了。

	== 缓存注解中的 SpringEL 表达式 ==		== 缓存注解中的 SpringEL 表达式 ==

Eijux：/* 缓存注解中的 SpringEL 表达式 */

2021-11-08T02:23:09Z

缓存注解中的 SpringEL 表达式

←上一版本		2021年11月8日 (一) 10:23的版本
第388行：		第388行：
	=== '''@EnableCaching''' ===		=== '''@EnableCaching''' ===
	@EnableCaching：开关性注解，在'''项目启动类'''或'''某个配置类'''上使用此注解后，则表示允许使用注解的方式进行缓存操作。		@EnableCaching：开关性注解，在'''项目启动类'''或'''某个配置类'''上使用此注解后，则表示允许使用注解的方式进行缓存操作。


	== 缓存注解中的 SpringEL 表达式 ==		== 缓存注解中的 SpringEL 表达式 ==

Eijux：/* @CacheConfig */

2021-11-08T02:22:49Z

@CacheConfig

←上一版本		2021年11月8日 (一) 10:22的版本
第385行：		第385行：
	# '''cacheResolver'''：		# '''cacheResolver'''：


			=== '''@EnableCaching''' ===
			@EnableCaching：开关性注解，在'''项目启动类'''或'''某个配置类'''上使用此注解后，则表示允许使用注解的方式进行缓存操作。

	== 缓存注解中的 SpringEL 表达式 ==		== 缓存注解中的 SpringEL 表达式 ==

Eijux：/* 配置 spring-redis.xml */

2021-11-08T00:12:30Z

配置 spring-redis.xml

←上一版本		2021年11月8日 (一) 08:12的版本
第17行：		第17行：
	: <syntaxhighlight lang="xml" highlight="">		: <syntaxhighlight lang="xml" highlight="">
	<!-- 省略其他的spring-redis.xml配置，具体参见源代码 -->		<!-- 省略其他的spring-redis.xml配置，具体参见源代码 -->
	<!-- ~~(redis 数据源、Spring~~-redis ~~连接池管理工厂、redis~~ template ~~definition、将 redisTemplate 封装成通用服务，等)~~ -->		<!-- 1、redis 数据源
			2、Spring-redis 连接池管理工厂
			3、redis template definition
			-->
	<!-- . . . -->		<!-- . . . -->

Eijux：/* 缓存注解中的 SpringEL 表达式 */

2021-11-07T23:15:58Z

缓存注解中的 SpringEL 表达式

←上一版本		2021年11月8日 (一) 07:15的版本
第384行：		第384行：

	== 缓存注解中的 SpringEL 表达式 ==		== 缓存注解中的 SpringEL 表达式 ==
			对应于加在方法上的缓存注解（如：@CachePut、@Cacheable），spring 提供了专门的上下文类 '''CacheEvaluationContext'''。
			* 这个类继承于基础的方法注解上下文 '''MethodBasedEvaluationContext'''（而后者继承于，大家熟悉的标准注解上下文：'''StandardEvaluationContext'''）。
			* CacheEvaluationContext 的构造器如下：
			*: <syntaxhighlight lang="Java" highlight="">
			class CacheEvaluationContext extends MethodBasedEvaluationContext {
			//构造器
			CacheEvaluationContext(Object rootObject, //根对象
			Method method, //当前方法
			Object[] arguments,//当前方法的参数
			ParameterNameDiscoverer parameterNameDiscoverer)
			{
			super(rootObject, method, arguments, parameterNameDiscoverer);
			}

			//....省略其他Spring源代码
			}
			</syntaxhighlight>
			* 在配置缓存注解（@CachePut 等）的 Key 时，可以用到 CacheEvaluationContext 的 '''rootObject''' 根对象。
			**（通过该根对象可以获取到的属性，如下表）


			{\| class="wikitable" style="width:100%;"
			\|+ style="caption-side:top;" \| Spring EL 支持获取的属性
			\|-
			! 属性名称 !! 说明 !! 示例
			\|-
			\| colspan="3" style="text-align:center;" \| '''通过 CacheEvaluationContext 的 rootObject 根对象能获取的属性'''
			\|-
			\| methodName \|\| 当前被调用的方法名
			\| <syntaxhighlight lang="xml" inline>#root.methodName</syntaxhighlight>
			\|-
			\| method \|\| 当前被调用的方法
			\| <syntaxhighlight lang="xml" inline>#root.method.name</syntaxhighlight>
			\|-
			\| target \|\| 当前被调用的目标对象
			\| <syntaxhighlight lang="xml" inline>#root.target</syntaxhighlight>
			\|-
			\| targetClass \|\| 当前被调用的目标对象类型
			\| <syntaxhighlight lang="xml" inline>#root.targetClass</syntaxhighlight>
			\|-
			\| args \|\| 当前被调用方法的参数列表
			\| 获取当前被调用方法的第 0 个参数：<syntaxhighlight lang="xml" inline>#root.args[0]</syntaxhighlight>
			\|-
			\| caches \|\| 当前被方法调用所使用的缓存集合
			* 如：<syntaxhighlight lang="xml" inline>@Cacheable(value={"cache1","cache2"})</syntaxhighlight> 有两个 cache
			\| 当前被方法调用的第 0 个 cache 名称：<syntaxhighlight lang="xml" inline>#root.caches[0].name</syntaxhighlight>
			\|-
			\| colspan="3" style="text-align:center;" \| '''通过 EvaluationContext 能获取的属性'''
			\|-
			\| Argument name \|\| 当前方法的参数名称
			\| <syntaxhighlight lang="xml" inline>#id</syntaxhighlight> 或 <syntaxhighlight lang="xml" inline>#a0</syntaxhighlight>
			* 也可以使用“#p0”或“#p<#arg>”作为别名。
			\|-
			\| result \|\| 方法返回的结果(要缓存的值)。
			* 只有在“unless”、“@CachePut”（用于计算键）或“@CacheEvict(beforeInvocation=false)”中才可用；
			* 对于支持的包装器（如：Optional），“#result”引用的是实际对象，而不是包装器
			\| <syntaxhighlight lang="xml" inline>#result</syntaxhighlight>
			\|}
			如上，展示了：
			# 通过 '''CacheEvaluationContext''' 的 '''rootObject''' 根对象可以获取到的属性。
			#* 在配置 key 属性时，如果用到 SpEL 表达式 root 对象的属性，也可以将“'''#root'''”省略，因为 Spring 默认使用的就是 root 对象的属性。
			#*: 如：
			#*: <syntaxhighlight lang="Java" highlight="">
			@Cacheable(value={"cache1", "cache2"}, key="caches[1].name")
			public User find(User user) {
			// 省略：查询数据库的代码
			...
			}
			</syntaxhighlight>
			# 除了访问 SpEL 表达式 root 对象，还可以访问当前方法的参数以及它们的属性。访问方法的参数有以下两种形式：
			## 使用“'''#p<参数index>'''”形式访问方法的参数：
			##: <syntaxhighlight lang="Java" highlight="">
			// 访问第0个参数，参数id
			@Cacheable(value="users", key="#p0")
			public User find(Stringid) {
			// 省略：查询数据库的代码
			...
			}

			// 访问参数user的id属性
			@Cacheable(value="users", key="#p0.id")
			public User find(User user) {
			// 省略：查询数据库的代码
			...
			}
			</syntaxhighlight>
			## 使用“'''#<参数名>'''”形式访问方法的参数：【！常用】
			##: <syntaxhighlight lang="Java" highlight="">
			// 使用“#参数名”的形式访问第0个参数的属性值，这里是id
			@Cacheable(value="users", key="#user.id")
			public User find(User user) {
			// 省略：查询数据库的代码
			...
			}
			</syntaxhighlight>

Spring 的 Redis缓存注解 - 版本历史

Eijux：​/* 使用 RedisTemplate 模板 API 完成 CRUD 的实践案例 */

Eijux：​/* @EnableCaching */

Eijux：​/* 缓存注解详解 */

Eijux：​/* @CachePut */

Eijux：​/* 缓存注解中的 SpringEL 表达式 */

Eijux：​/* @EnableCaching */

Eijux：​/* 缓存注解中的 SpringEL 表达式 */

Eijux：​/* @CacheConfig */

Eijux：​/* 配置 spring-redis.xml */

Eijux：​/* 缓存注解中的 SpringEL 表达式 */

Eijux：/* 使用 RedisTemplate 模板 API 完成 CRUD 的实践案例 */

Eijux：/* @EnableCaching */

Eijux：/* 缓存注解详解 */

Eijux：/* @CachePut */

Eijux：/* 缓存注解中的 SpringEL 表达式 */

Eijux：/* @EnableCaching */

Eijux：/* 缓存注解中的 SpringEL 表达式 */

Eijux：/* @CacheConfig */

Eijux：/* 配置 spring-redis.xml */

Eijux：/* 缓存注解中的 SpringEL 表达式 */