快捷導(dǎo)航

Spring中@Cacheable注解的使用詳解

更新時(shí)間：2023年11月08日 09:11:48 作者：你就像甜甜的益達(dá)

這篇文章主要介紹了Spring中@Cacheable注解的使用詳解,Spring框架提供了@Cacheable注解來(lái)輕松地將方法結(jié)果緩存起來(lái),以便在后續(xù)調(diào)用中快速訪問(wèn),本文將詳細(xì)介紹@Cacheable注解的使用方法,并從源碼級(jí)別解析其實(shí)現(xiàn)原理,需要的朋友可以參考下

@Cacheable注解

在現(xiàn)代的應(yīng)用程序中，緩存是提高性能和可擴(kuò)展性的重要組成部分。

Spring框架提供了@Cacheable注解來(lái)輕松地將方法結(jié)果緩存起來(lái)，以便在后續(xù)調(diào)用中快速訪問(wèn)。本文將詳細(xì)介紹@Cacheable注解的使用方法，并從源碼級(jí)別解析其實(shí)現(xiàn)原理。

@Cacheable注解的使用方法

@Cacheable注解可用于Spring管理的bean中的任何方法上。它可以被用來(lái)緩存方法返回的結(jié)果。當(dāng)使用@Cacheable注解時(shí)，Spring會(huì)在調(diào)用方法前檢查緩存中是否已經(jīng)存在該方法的結(jié)果，如果存在，則直接返回緩存中的結(jié)果，而不會(huì)執(zhí)行方法體中的代碼。如果緩存中不存在該方法的結(jié)果，則會(huì)執(zhí)行方法體中的代碼，并將結(jié)果存儲(chǔ)到緩存中，以便下次調(diào)用該方法時(shí)可以直接返回緩存中的結(jié)果。

下面是@Cacheable注解的使用示例：

@Cacheable(value="users", key="#userId")
public User getUserById(String userId) {
    // 查詢數(shù)據(jù)庫(kù)獲取用戶信息
}

上面的示例中，@Cacheable注解被用于getUserById方法上。其中value屬性指定了緩存的名稱為“users”，key屬性指定了緩存的鍵為傳入的userId參數(shù)。當(dāng)調(diào)用getUserById方法時(shí)，Spring會(huì)先檢查名為“users”的緩存中是否已經(jīng)存在鍵為userId的結(jié)果，如果存在，則直接返回緩存中的結(jié)果，否則執(zhí)行方法體中的代碼，并將結(jié)果存儲(chǔ)到緩存中。

@Cacheable注解還可以使用SpEL表達(dá)式來(lái)動(dòng)態(tài)地計(jì)算緩存的鍵。例如：

@Cacheable(value="users", key="#user.id")
public User getUserById(User user) {
    // 查詢數(shù)據(jù)庫(kù)獲取用戶信息
}

上面的示例中，key屬性使用了SpEL表達(dá)式“#user.id”，表示緩存的鍵為傳入?yún)?shù)user對(duì)象的id屬性值。

@Cacheable注解還支持多個(gè)鍵值對(duì)作為緩存的鍵。例如：

@Cacheable(value="users", key="#userId + '_' + #type")
public User getUserByIdAndType(String userId, String type) {
    // 查詢數(shù)據(jù)庫(kù)獲取用戶信息
}

上面的示例中，key屬性使用了兩個(gè)參數(shù)作為鍵值對(duì)，分別是userId和type。

@Cacheable注解還支持condition屬性來(lái)指定是否進(jìn)行緩存。例如：

@Cacheable(value="users", key="#userId", condition="#userId.length() < 10")
public User getUserById(String userId) {
    // 查詢數(shù)據(jù)庫(kù)獲取用戶信息
}

上面的示例中，condition屬性使用了SpEL表達(dá)式“#userId.length() < 10”，表示只有當(dāng)傳入?yún)?shù)userId的長(zhǎng)度小于10時(shí)才進(jìn)行緩存。

@Cacheable注解還支持unless屬性來(lái)指定不進(jìn)行緩存的條件。例如：

@Cacheable(value="users", key="#userId", unless="#result == null")
public User getUserById(String userId) {
    // 查詢數(shù)據(jù)庫(kù)獲取用戶信息
}

上面的示例中，unless屬性使用了SpEL表達(dá)式“#result == null”，表示只有當(dāng)方法返回值不為null時(shí)才進(jìn)行緩存。

@Cacheable注解源碼分析

@Cacheable注解是Spring框架中org.springframework.cache.annotation包下的一個(gè)注解。它實(shí)際上是一個(gè)組合注解，包含了@CachePut、@CacheEvict和@Caching三個(gè)注解。

當(dāng)使用@Cacheable注解時(shí)，Spring會(huì)在運(yùn)行時(shí)動(dòng)態(tài)地生成一個(gè)代理對(duì)象來(lái)攔截目標(biāo)方法的調(diào)用。代理對(duì)象會(huì)首先檢查緩存中是否已經(jīng)存在該方法的結(jié)果，如果存在，則直接返回緩存中的結(jié)果，否則執(zhí)行目標(biāo)方法，并將結(jié)果存儲(chǔ)到緩存中。

下面是@Cacheable注解的源碼：

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@Caching(cacheable = @Cacheable)
public @interface Cacheable {
    Class<?>[] value() default {};
    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;
}

從源碼可以看出，@Cacheable注解包含了value、cacheNames、key、keyGenerator、cacheManager、cacheResolver、condition、unless和sync等屬性。

value和cacheNames屬性用于指定緩存名稱。

key和keyGenerator屬性用于指定緩存鍵。

cacheManager和cacheResolver屬性用于指定緩存管理器和緩存解析器。

condition和unless屬性用于指定是否進(jìn)行緩存。

sync屬性用于指定是否啟用同步模式。