Spring @Cacheable key

概述

關於@Cacheable註解的做用不作過多說明，文本主要針對該註解的key自定義策略規則提供一些示例。

@Cacheable

| 屬性名 | 必填? | 描述 |
| ----- | ----- | ------------- |
| value | 必填 | 緩存的命名空間 |
| key | 可選 | 指定一個惟一的key（在緩存命名空間中），使用SpEL表達式 |
| condition | 可選 | 限定條件，哪一種狀況使用緩存，使用SpEL表達式 |
| unless | 可選 | 限定條件，哪一種狀況下不使用緩存，使用SpEL表達式 |

key

默認狀況下，key屬性能夠不填，Spring會按照默認策略去生成緩存相關的key（這裏不細究了）
該屬性在自定義時，一般使用SpEL表達式來聲明，如下是一些常見的例子：

經過方法參數做爲key：

@Cacheable(value = "findByUserIdCached", key = "#userId")
public User findByUserIdCached(Integer userId) {
    return userDao.findByUserId(userId);
}

// 還有一種寫法：#p0 表示第一個參數
@Cacheable(value = "findByUserIdCached", key = "#p0")
public User findByUserIdCached(Integer userId) {
    return userDao.findByUserId(userId);
}


@Cacheable(value = "findByUserIdCached", key = "#user.id")
// @Cacheable(value = "findByUserIdCached", key = "#p0.id")
public User findByUserIdCached(User user) {
    return userDao.findByUserId(user.getId());
}

// 多個參數拼接
@Cacheable(value = "findByUsernameAndTypeCached", key = "#username + '_' + #type")
// @Cacheable(value = "findByUsernameAndTypeCached", key = "#p0 + '_' + #p1")
public User findByUsernameAndTypeCached(String username, Integer type) {
    return null;
}

// 複雜參數（數組）
@Cacheable(value = "findByUserIdsCached", key = "#userIds[0] + ''")
// @Cacheable(value = "findByUserIdsCached", key = "#p0[0] + ''")
public User findByUserIdsCached(Integer[] userIds) {
    return null;
}

除此以外，Spring還提供了一個root對象：。

屬性	描述	示例
methodName	當前方法名	#root.methodName
method	當前方法	#root.method.name
target	當前被調用的對象	#root.target
targetClass	當前被調用的對象的class	#root.targetClass
args	當前方法參數數組	#root.args[0]
caches	當前被調用的方法使用的Cache	#root.caches[0].name

@Cacheable(value = "findByUserIdCached", key = "#root.methodName + '_' + #user.id")
public User findByUserIdCached(User user) {
    return userDao.findByUserId(user.getId());
}

// 固然，也能夠經過root對象調用當前類的public方法
class TestService {

    @Cacheable(value = "findByUserIdCached", key = "#root.target.getName() + '_' + #user.id")
    public User findByUserIdCached(User user) {
        return userDao.findByUserId(user.getId());
    }
    
    public String getName() {
        return "test";
    }
}

condition && unless

此外，condition以及unless都是能夠經過配置SpEL表達式來完成的，最終須要一個條件表達式，如：

// 只有當type爲偶數時，才使用緩存。
@Cacheable(value = "findByUsernameAndTypeCached", key = "#username + '_' + #type", condition = "#type % 2 == 0")
public User findByUsernameAndTypeCached(String username, Integer type) {
    return null;
}

// 同理，只有當type爲偶數時，纔不使用緩存
@Cacheable(value = "findByUsernameAndTypeCached", key = "#username + '_' + #type", unless = "#type % 2 == 0")
public User findByUsernameAndTypeCached(String username, Integer type) {
    return null;
}