Spring Boot 2.0+使用Redis做缓存，@Cacheable注解的unless参数详解

末蓝、 2022-03-21 12:54 359阅读 0赞

# 需求概述 #

在Spring boot 中，用Redis作为缓存，在指定方法上使用@Cacheable注解，并且在缓存时，排除特定返回值

# 结论 #

`@Cacheable`中，`unless`参数的作用是：**函数返回值符合表达式条件的，veto（否决）、不缓存**  
换句话说，**函数返回值符合条件的排除掉、只缓存其余不符合条件的**  
高效一些，我先把结论写在前面。感兴趣的朋友可以继续阅读具体的论证过程。

# 部分代码实现 #

### 具体方法 ###

import org.springframework.cache.annotation.Cacheable;
    import org.springframework.stereotype.Component;
    
    /** * created at 2019-02-01 18:05 * @author lerry */
    @Component
    public class ForCacheService { 
    
    	@Cacheable(value = "fruit", key = "#param", unless = "!#result")
    	public boolean isApple(String param) { 
    		LatencyService.sleepAWhile(3);
    		if (param.equals("apple")) { 
    			return true;
    		}
    		else { 
    			return false;
    		}
    	}
    }

我们定义了一个`isApple`方法。想要实现的功能为：如果入参是“apple”，则把返回结果缓存起来。如果不是，就不进行缓存。

### 模拟网络延迟的代码 ###

import lombok.extern.slf4j.Slf4j;
    
    /** * created at 2019-02-01 14:52 * @author lerry */
    @Slf4j
    public class LatencyService { 
    
    	/** * 模拟延迟 * @param seconds */
    	public static void sleepAWhile(int seconds) { 
    		try { 
    			log.info("模拟延迟{}s开始", seconds);
    			Thread.sleep(seconds * 1000L);
    			log.info("模拟延迟{}s结束", seconds);
    		}
    		catch (InterruptedException e) { 
    			e.printStackTrace();
    		}
    	}
    }

### 测试代码 ###

@Autowired
    private ForCacheService forCacheService;
    @Test
    public void testBooelanReturn() { 
    	log.info("apple is apple ? {}", forCacheService.isApple("apple"));
    	log.info("apple is apple ? {}", forCacheService.isApple("apple"));
    	log.info("apple is apple ? {}", forCacheService.isApple("apple"));
    
    	log.info("orange is apple ? {}", forCacheService.isApple("orange"));
    	log.info("orange is apple ? {}", forCacheService.isApple("orange"));
    	log.info("orange is apple ? {}", forCacheService.isApple("orange"));
    }

### 测试返回结果 ###

- 模拟延迟3s开始
    - 模拟延迟3s结束
    - apple is apple ? true
    - apple is apple ? true
    - apple is apple ? true
    - 模拟延迟3s开始
    - 模拟延迟3s结束
    - orange is apple ? false
    - 模拟延迟3s开始
    - 模拟延迟3s结束
    - orange is apple ? false
    - 模拟延迟3s开始
    - 模拟延迟3s结束
    - orange is apple ? false

可以看到，当参数是`apple`时，第一次访问，程序执行了3秒延迟的代码。但是第二次、第三次执行时，直接从缓存获取了结果。 当参数是`orange`时，没有进行缓存。第二次、第三次访问，都进行了3秒延迟。  
![redis][]

# unless的详细解释 #

`unless = "!#result"`  
其中`#result`，代指函数的返回值。非(!)(返回值)，都进行缓存。 就是说，当返回值不是false时，才进行缓存。  
这样解释，可能比较绕。接下来，我换个写法，再解释一遍。

我们实现一个String类型返回值的函数。这个函数很简单，返回值就是入参：

@Cacheable(value = "str", key = "#param", unless = "#result eq 'abc'")
    	public String stringDemo(String param) { 
    		LatencyService.sleepAWhile(3);
    		return param;
    	}

测试代码如下：

@Test
    public void testStrReturn() { 
    	log.info("123:{}", forCacheService.stringDemo("123"));
    	log.info("123:{}", forCacheService.stringDemo("123"));
    	log.info("123:{}", forCacheService.stringDemo("123"));
    
    	log.info("456:{}", forCacheService.stringDemo("456"));
    	log.info("456:{}", forCacheService.stringDemo("456"));
    	log.info("456:{}", forCacheService.stringDemo("456"));
    
    	log.info("abc:{}", forCacheService.stringDemo("abc"));
    	log.info("abc:{}", forCacheService.stringDemo("abc"));
    	log.info("abc:{}", forCacheService.stringDemo("abc"));
    }

测试结果如下：

- 模拟延时3s开始
    - 模拟延时3s结束
    - 123:123
    - 123:123
    - 123:123
    - 模拟延时3s开始
    - 模拟延时3s结束
    - 456:456
    - 456:456
    - 456:456
    - 模拟延时3s开始
    - 模拟延时3s结束
    - abc:abc
    - 模拟延时3s开始
    - 模拟延时3s结束
    - abc:abc
    - 模拟延时3s开始
    - 模拟延时3s结束
    - abc:abc

可以很明显的看到，除了`abc`没有被缓存，其余不等于`abc`的字符串，都被缓存了。  
![str缓存][str]  
`unless = "#result eq 'abc'`的含义为：  
**函数返回值符合条件的，不缓存。**  
或者说：  
**除了符合el表达式条件的，其余的都进行缓存。**

# API文档注释 #

> Spring Expression Language (SpEL) expression used to veto method caching.  
> Unlike condition, this expression is evaluated after the method has been called and can therefore refer to the result.  
> Default is “”, meaning that caching is never vetoed.

翻译：
    用于否决方法缓存的 Spring表达式语言(SpEL) 表达式。
    与condition不同，这个表达式是在调用方法之后计算的，因此可以引用结果(方法返回结果)。
    默认值是“”，这意味着缓存从未被否决。

所以，可以这样理解：  
**函数返回值符合表达式条件的，veto（否决）、不缓存**

[redis]: /images/20220321/e431c77e4fd64c9482290002ea16aa71.png
[str]: /images/20220321/1d89aa6484b140eaa84243a686cdafcf.png

发表评论取消回复

表情：

评论列表（有 0 条评论，359人围观）

还没有评论，来说两句吧...

相关阅读

相关 Spring Boot缓存注解@Cacheable、@CacheEvict、@CachePut使用

3.1开始，Spring引入了对Cache的支持。其使用方法和原理都类似于Spring对事务管理的支持。Spring Cache是作用在方法上的，其核心思想是这样的：当我...

小鱼儿/ 2024年04月18日 16:48/ 0 赞/ 90 阅读

相关 Spring缓存注解--@Cacheable

文章目录 1、Cacheable注解 2、@Cacheable注解属性 2.1 value/cacheName属性 2.2 key属

小咪咪/ 2023年10月08日 21:52/ 0 赞/ 131 阅读

相关 Spring Boot缓存注解@Cacheable、@CacheEvict、@CachePut使用

版权声明：本文为CSDN博主「Dreamhai」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。原文链接：https://blog.cs

阳光穿透心脏的1/2处/ 2023年02月22日 12:28/ 0 赞/ 24 阅读

相关使用spring自带的Cacheable注解处理Redis缓存

本文不为Redis安装和使用范畴,有兴趣的朋友可以联系我,也可以自行百度:[Redis安装和使用][Redis] Redis实现缓存添加,更新和删除的方法有很多. 1

小灰灰/ 2022年06月08日 03:45/ 0 赞/ 526 阅读

相关 SpringBoot使用Redis做缓存，@Cacheable、@CachePut、@CacheEvict等注解的使用

SpringBoot使用Redis做缓存，@Cacheable、@CachePut、@CacheEvict等注解的使用导入依赖 <dependency>

太过爱你忘了你带给我的痛/ 2022年05月29日 20:40/ 0 赞/ 283 阅读

相关详解Spring缓存注解@Cacheable,@CachePut , @CacheEvict使用

注释介绍 @Cacheable @Cacheable 的作用主要针对方法配置，能够根据方法的请求参数对其结果进行缓存 @Cacheable 作用和配置方法

淩亂°似流年/ 2022年05月21日 03:05/ 0 赞/ 278 阅读

相关 Spring Boot 2.0+使用Redis做缓存，@Cacheable注解的unless参数详解

需求概述在Spring boot 中，用Redis作为缓存，在指定方法上使用@Cacheable注解，并且在缓存时，排除特定返回值结论 `@Cacheable

末蓝、/ 2022年03月21日 12:54/ 0 赞/ 360 阅读

相关 Spring之缓存注解@Cacheable

转载出处：[转载出处https://www.cnblogs.com/fashflying/p/6908028.html][https_www.cnblogs.com_fashf

左手的ㄟ右手/ 2021年09月29日 04:08/ 0 赞/ 449 阅读

相关 Spring Boot缓存注解@Cacheable、@CacheEvict、@CachePut使用

从3.1开始，Spring引入了对Cache的支持。其使用方法和原理都类似于Spring对事务管理的支持。Spring Cache是作用在方法上的，其核心思想是这样的：当我们在

刺骨的言语ヽ痛彻心扉/ 2021年09月24日 02:32/ 0 赞/ 483 阅读

相关 Spring缓存注解@Cacheable、@CacheEvict、@CachePut使用

[https://www.cnblogs.com/fashflying/p/6908028.html][https_www.cnblogs.com_fashflying_p_6

古城微笑少年丶/ 2021年06月24日 16:09/ 0 赞/ 540 阅读