SpringBoot怎麼使用@Cacheable進行快取與取值-java教程-PHP中文網

使用@Cacheable進行快取與取值

1. @Cacheable的作用

使用快取的步驟是透過使用註解@Cacheable來實現快取。所以我們可以先說一下快取的使用步驟：

在SpringBoot的主啟動類別上使用@EnableCaching註解開啟基於註解的快取。

標註快取註解即可

#第一步：開啟基於註解的快取，使用@EnableCaching 標註在springboot 主啟動類別上

//开启基于注解的缓存
@EnableCaching   
@EnableRyFeignClients
@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})
public class ZfjgAuthApplication {
    public static void main(String[] args) {
        SpringApplication.run(ZfjgAuthApplication.class, args);
    }
}

登入後複製

第二步：標註快取註解

@Repository
public interface DeviceMapper {
    @Cacheable(cacheNames = "DeviceDO.deviceId")
    DeviceDO get(String deviceId);
    @CacheEvict(cacheNames = "DeviceDO.deviceId", key = "#record.deviceId")
    int insert(DeviceDO record);
}

登入後複製

註：這裡使用@Cacheable 註解就可以將執行結果緩存，以後查詢相同的數據，直接從快取取，不需要呼叫方法。

2.常用屬性說明

下面介紹@Cacheable 這個註解常用的幾個屬性：

cacheNames/ value：用來指定快取元件的名字
key：快取資料時所使用的key，可以用它來指定。預設是使用方法參數的值。（這個 key 你可以使用 spEL 表達式來寫）
keyGenerator：key 的生成器。 key 和 keyGenerator 二選一使用
cacheManager：可以用來指定快取管理器。從哪個快取管理器裡面取得快取。
condition：可以用來指定符合條件的情況下才快取
unless ：否定緩存。當 unless 指定的條件為 true ，方法的回傳值就不會被快取。當然你也可以獲得結果來判斷。（透過 #result 取得方法結果）
sync：是否使用非同步模式。

SpringBoot中Cacheable使用說明

功能說明

當方法使用@Cacheable 註解時，這表示該方法傳回的結果可以被緩存。也就是說，該方法的回傳結果會放在快取中，以便於日後使用相同的參數呼叫方法時，會傳回快取中的值，而不會實際執行該方法。

注意，這裡強調了一點：參數相同。這一點應該是很容易理解的，因為快取不關心方法的執行邏輯，它能確定的是：對於同一個方法，如果參數相同，那麼傳回結果也是相同的。但是如果參數不同，快取只能假設結果是不同的，所以對於同一個方法，你的程式運行過程中，使用了多少種參數組合呼叫過該方法，理論上就會產生多少個快取的key（當然，這些組合的參數指的是與生成key 相關的）。下面來了解@Cacheable 的一些參數：

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.core.annotation.AliasFor;
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Cacheable {
    @AliasFor("cacheNames")
    String[] value() default {};
    @AliasFor("value")
    String[] cacheNames() default {};
    String key() default "";
    String keyGenerator() default "";
    String cacheManager() default "";
    String cacheResolver() default "";
    String condition() default "";
    String unless() default "";
    boolean sync() default false;
}

登入後複製

1. cacheNames & value

你可以選擇使用value或cacheNames其中之一來指定快取名，這可透過@Cacheable來實現。這是 @Cacheable 最簡單的用法範例：

@Override
@Cacheable("menu")
public Menu findById(String id) {
    Menu menu = this.getById(id);
    if (menu != null){
        System.out.println("menu.name = " + menu.getName());
    }
    return menu;
}

登入後複製

在這個範例中，menu 快取被關聯到了名為 findById 的方法。如果 menu 快取中已有結果，則呼叫該方法時不會執行，而是直接使用快取結果。

2. 關聯多個快取名稱

其實，依照官方文檔，@Cacheable 支援同一個方法關聯多個快取。在這種情況下，當執行方法之前，這些關聯的每一個快取都會被檢查，而且只要至少其中一個快取命中了，那麼這個快取中的值就會被傳回。

範例：

@Override
    @Cacheable({"menu", "menuById"})
    public Menu findById(String id) {
        Menu menu = this.getById(id);
        if (menu != null){
            System.out.println("menu.name = " + menu.getName());
        }
        return menu;
    }
---------
@GetMapping("/findById/{id}")
public Menu findById(@PathVariable("id")String id){
    Menu menu0 = menuService.findById("fe278df654adf23cf6687f64d1549c0a");
    Menu menu2 = menuService.findById("fb6106721f289ebf0969565fa8361c75");
    return menu0;
}

登入後複製

為了直覺起見，直接將 id 參數寫到程式碼裡。現在，我們來測試一下，看看結果：

SpringBoot怎麼使用@Cacheable進行快取與取值

3. key & keyGenerator

一個快取名稱對應一個被註解的方法，但是一個方法可能傳入不同的參數，那麼結果也會不同，這又該如何區分呢？這就需要用到 key 。在 Spring 框架中，可以透過兩種方式產生鍵值：明確指定並使用鍵產生器自動產生。

3.1 KeyGenerator 自動產生

當我們在宣告 @Cacheable 時不指定 key 參數，則該快取名稱下的所有 key 會使用 KeyGenerator 根據參數自動產生。 spring 有一個預設的 SimpleKeyGenerator ，在 spring boot 自動化配置中，這個會被預設注入。產生規則如下：

如果該快取方法沒有參數，傳回SimpleKey.EMPTY ;
如果該快取方法有一個參數，傳回該參數的實例；
如果該快取方法有多個參數，則傳回一個包含所有參數的SimpleKey ；

預設的鍵產生器需要參數具有有效的hashCode() 和equals() 方法的實作。此外，也可以自訂 keyGenerator 並透過其來指定。關於 KeyGenerator 這裡不做詳細介紹，有興趣的話可以去看看原始碼，其實就是使用 hashCode 來進行加乘運算。類似於 String 和 ArrayList 的雜湊計算。

3.2 明確指定 key

相较于使用 KeyGenerator 生成，spring 官方更推荐显式指定 key 的方式，即指定 @Cacheable 的 key 参数。

即便是显式指定，但是 key 的值还是需要根据参数的不同来生成，那么如何实现动态拼接呢？SpEL（Spring Expression Language，Spring 表达式语言）能做到这一点。下面是一些使用 SpEL 生成 key 的例子。

@Override
    @Cacheable(value = {"menuById"}, key = "#id")
    public Menu findById(String id) {
        Menu menu = this.getById(id);
        if (menu != null){
            System.out.println("menu.name = " + menu.getName());
        }
        return menu;
    }
    @Override
    @Cacheable(value = {"menuById"}, key = "&#39;id-&#39; + #menu.id")
    public Menu findById(Menu menu) {
        return menu;
    }
    @Override
    @Cacheable(value = {"menuById"}, key = "&#39;hash&#39; + #menu.hashCode()")
    public Menu findByHash(Menu menu) {
        return menu;
    }

登入後複製

SpringBoot怎麼使用@Cacheable進行快取與取值

官方说 key 和 keyGenerator 参数是互斥的，同时指定两个会导致异常。

4. cacheManager & cacheResolver

缓存管理器CacheManager用于管理（寻找）某种缓存。通常来讲，缓存管理器是与缓存组件类型相关联的。我们知道，spring 缓存抽象的目的是为使用不同缓存组件类型提供统一的访问接口，以向开发者屏蔽各种缓存组件的差异性。那么 CacheManager 就是承担了这种屏蔽的功能。spring 为其支持的每一种缓存的组件类型提供了一个默认的 manager，如：RedisCacheManager 管理 redis 相关的缓存的检索、EhCacheManager 管理 ehCache 相关的缓等。

CacheResolver，缓存解析器是用来管理缓存管理器的，CacheResolver 保持一个 cacheManager 的引用，并通过它来检索缓存。CacheResolver 与 CacheManager 的关系有点类似于 KeyGenerator 跟 key。spring 默认提供了一个 SimpleCacheResolver，开发者可以自定义并通过 @Bean 来注入自定义的解析器，以实现更灵活的检索。

大多数情况下，我们的系统只会配置一种缓存，所以我们并不需要显式指定 cacheManager 或者 cacheResolver。Spring允许我们在系统中配置多个缓存组件，这时我们需要进行明确的指定。指定的方式是使用 @Cacheable 的 cacheManager 或者 cacheResolver 参数。

按照官方文档，cacheManager 和 cacheResolver 是互斥参数，同时指定两个可能会导致异常。

5. sync

是否同步，true/false。在一个多线程的环境中，某些操作可能被相同的参数并发地调用，这样同一个 value 值可能被多次计算（或多次访问 db），这样就达不到缓存的目的。针对这些可能高并发的操作，我们可以使用 sync 参数来告诉底层的缓存提供者将缓存的入口锁住，这样就只能有一个线程计算操作的结果值，而其它线程需要等待，这样就避免了 n-1 次数据库访问。

sync = true 可以有效的避免缓存击穿的问题。

6. condition

调用前判断，缓存的条件。有时候，我们可能并不想对一个方法的所有调用情况进行缓存，我们可能想要根据调用方法时候的某些参数值，来确定是否需要将结果进行缓存或者从缓存中取结果。例如，当我查询用户时按年龄分组，我只需缓存那些年龄大于 35 的结果。那么 condition 能实现这种效果。

SpEL 支持的表达式可以作为 condition 的值，结果为 true 或 false。如果表达式结果为 true，则调用方法时会执行正常的缓存逻辑（查缓存-有就返回-没有就执行方法-方法返回不空就添加缓存）；否则，调用方法时就好像该方法没有声明缓存一样（即无论传入了什么参数或者缓存中有些什么值，都会执行方法，并且结果不放入缓存）。下面举个例子：

我们看一下数据库，以这两条数据为例：

　　 SpringBoot怎麼使用@Cacheable進行快取與取值

我们首先定义一个带条件的缓存方法：

@Override
    @Cacheable(value = {"menuById"}, key = "#id", condition = "#conditionValue > 1")
    public Menu findById(String id, Integer conditionValue) {
        Menu menu = this.getById(id);
        if (menu != null){
            System.out.println("menu.name = " + menu.getName());
        }
        return menu;
    }

登入後複製

然后分两种情况调用（为了直观可见，直接将 id 写在代码中）：

@GetMapping("/findById/{id}")
    public Menu findById(@PathVariable("id")String id){
        Menu menu0 = menuService.findById("fe278df654adf23cf6687f64d1549c0a", 0);
        Menu menu2 = menuService.findById("fb6106721f289ebf0969565fa8361c75", 2);
        return menu0;
    }

登入後複製

SpringBoot怎麼使用@Cacheable進行快取與取值

虽然两次请求都调用了方法，但只有第二次请求缓存了"微服务测试2"。只有在满足条件 condition 的情况下才会进行调用，这样才能将结果缓存。接下来我们再请求一遍，看下结果和打印：

SpringBoot怎麼使用@Cacheable進行快取與取值

可以看到，“微服务测试2”由于已经有了缓存，所以没有再执行方法体。而“微服务测试0”又一次执行了。

7. unless

执行后判断，不缓存的条件。SpEL 可以支持表达式结果为 true 或 false，用于 unless。当结果为 true 时，不缓存。举个例子：

我们先清除 redis 中的数据。然后看看 mysql 中的数据：

　　 SpringBoot怎麼使用@Cacheable進行快取與取值

然后编写一个缓存方法（在该方法中，result代表方法的返回值。关于）：

@Override
    @Cacheable(value = {"menuById"}, key = "#id", unless = "#result.type == &#39;folder&#39;")
    public Menu findById(String id) {
        Menu menu = this.getById(id);
        if (menu != null){
            System.out.println("menu.name = " + menu.getName());
        }
        return menu;
    }

登入後複製

然后调用该方法：

@GetMapping("/findById/{id}")
    public Menu findById(@PathVariable("id")String id){
        Menu menu0 = menuService.findById("fe278df654adf23cf6687f64d1549c0a");
        Menu menu2 = menuService.findById("fb6106721f289ebf0969565fa8361c75");
        return menu0;
    }

登入後複製

SpringBoot怎麼使用@Cacheable進行快取與取值

可以看到，两次都执行了方法体（其实，unless 条件就是在方法执行完毕后调用，所以它不会影响方法的执行），但是结果只有 menu.type = ‘page’ 的缓存了，说明 unless 参数生效了。

8. condition VS unless ？

既然 condition 和 unless 都能决定是否进行缓存，那么同时指定这两个参数并且结果相冲突的时候，会怎么样呢？我们来试一试。

首先清除 redis 数据，然后在缓存方法上加上 condition=“true”，如：

@Override
    @Cacheable(value = {"menuById"}, key = "#id", condition = "true", unless = "#result.type == &#39;folder&#39;")
    public Menu findById(String id) {
        Menu menu = this.getById(id);
        if (menu != null){
            System.out.println("menu.name = " + menu.getName());
        }
        return menu;
    }

登入後複製

其它代码不变，我们来看一下缓存结果和打印：

SpringBoot怎麼使用@Cacheable進行快取與取值