前言

SpringCache是SpringFramework3.1引入的新特性，提供了基於註解的快取配置方法.SpringCache是SpringFramework3.1引入的新特性，提供了基於註解的快取配置方法

pom檔案引入

<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-context</artifactId>
</dependency>

chching配置

@Configuration
@EnableCaching
public class RedisConfig extends CachingConfigurerSupport {

    /**
     *快取管理器.
     *@param redisTemplate
     *@return
     */
    @Bean
    public CacheManager cacheManager(RedisTemplate<?,?>redisTemplate) {
        RedisCacheManager cacheManager = new RedisCacheManager(redisTemplate);
        cacheManager.setDefaultExpiration(3600);
        return cacheManager;
    }


    /**
     *自定義key.
     *此方法將會根據類名+方法名+所有引數的值生成唯一的一個key,即使@Cacheable中的value屬性一樣，key也會不一樣。
     */
    @Override
    public KeyGenerator keyGenerator() {
        System.out.println("RedisCacheConfig.keyGenerator()");
        return new KeyGenerator(){
                 @Override
                 public Object generate(Object o, Method method, Object... objects ) {
                StringBuilder sb = new StringBuilder("Cache:BaseService");
                sb.append(":" + o.getClass().getName().toString());
                sb.append(":" + method.getName().toString());

                StringBuilder s = new StringBuilder();
                for (Object obj : objects) {
                    if (Objects.nonNull(obj)){
                        s.append(obj.toString());
                    }
                }

                StringBuilder testss = sb;
                sb.append(":" + StringEncryptionUtils.StringToMd5(s.toString()));
                return sb.toString();
            }
        };
    }
}
 

註解

Spring為我們提供了幾個註解來支援Spring Cache。其核心主要是@Cacheable、@CachePut和@CacheEvict。
使用@Cacheable標記的方法，如果未快取，在執行後Spring Cache將快取其返回結果；已快取，則直接返回快取內容；
使用@CachePut標記的必然會在方法執行後，更新快取；
而使用@CacheEvict標記的方法會在方法執行前或者執行後移除Spring Cache中的某些元素。

1.1 @Cacheable

@Cacheable可以標記在一個方法上，也可以標記在一個類上。標記方法上表示該方法支援快取，標記類上表示該類下所有方法都支援快取。
對於一個支援快取的方法，Spring會在其被呼叫後將其返回值快取起來，以保證下次利用同樣的引數來執行該方法時可以直接從快取中獲取結果，而不需要再次執行該方法。
spring以鍵值對形式快取，key可以自定義設定，未設定則為預設值，value則是方法返回結果。@Cacheable可以指定三個屬性：value、key和condition。
@Cacheable 常用與查詢操作。

1.1.1 value指定cache快取空間
value指定當前結果快取在哪個cache下，value值可以是一個cache，或者多個cache

@Cacheable("goods")
public Goods find(Integer goodsId) {
  return null;
}

@Cacheable({"goods", "channel:goods"})
public Goods find(Integer goodsId) {
  return null;
}
 

1.1.2 指定cache的key值
設定快取資料的key值，未設定則為預設值。

預設策略
預設的key生成策略是通過KeyGenerator生成的，其預設策略如下：
如果方法沒有引數，則使用0作為key。
如果只有一個引數的話則使用該引數作為key。
如果引數多餘一個的話則使用所有引數的hashCode作為key

自定義key

@Cacheable(value="goods", key="goodsId")
public Goods find(Integer goodsId) {
  return null;
}


@Cacheable(value="goods", key="goods.goodsId")
public Goods find(Goods goods) {
  return null;
}
 

前言caching配置中

@Override
public KeyGenerator keyGenerator() {
	System.out.println("RedisCacheConfig.keyGenerator()");
	return new KeyGenerator(){
			 @Override
			 public Object generate(Object o, Method method, Object... objects ) {
			StringBuilder sb = new StringBuilder("Cache:BaseService");
			sb.append(":" + o.getClass().getName().toString());
			sb.append(":" + method.getName().toString());


			StringBuilder s = new StringBuilder();
			for (Object obj : objects) {
				if (Objects.nonNull(obj)){
					s.append(obj.toString());
				}
			}


			StringBuilder testss = sb;
			sb.append(":" + StringEncryptionUtils.StringToMd5(s.toString()));
			return sb.toString();
		}
	};
}

1.1.3 condition 設定快取條件
指定快取方法上，新增快取條件，當滿足該條件時候，結果才進行快取。

@Cacheable(value="goods", key="goods.goodsId", condition="goods.goodsId == 123456")
public Goods find(Goods goods) {
  return null;
}

1.2 @CachePut

@CachePut也可以宣告一個方法支援快取功能。與@Cacheable不同的是使用@CachePut標註的方法在執行前不會去檢查快取中是否存在之前執行過的結果，而是每次都會執行該方法，並將執行結果以鍵值對的形式存入指定的快取中。
@CachePut也可以標註在類上和方法上。使用@CachePut時我們可以指定的屬性跟@Cacheable是一樣的(這邊就不重複闡述)。
@CachePut常用與更新操作。

@CachePut(value="goods", key="goods.goodsId", condition="goods.goodsId == 123456")
public Goods update(Goods goods) {
  return null;
}

[email protected]

@CacheEvict可以標記在一個方法上，也可以標記在一個類上。標記方法上標識方法執行時候觸發清楚快取操作，當標記在一個類上時表示其中所有的方法的執行都會觸發快取的清除操作。
@CacheEvict可以指定的屬性有value、key、condition、allEntries和beforeInvocation。
其中value、key和condition的語義與@Cacheable對應的屬性類似。主要闡述新出現的兩個屬性allEntries和beforeInvocation。
@CacheEvict常用刪除操作。

1.3.1  allEntries屬性
allEntries是boolean型別，表示是否需要清除快取中的所有元素，預設為false。
當指定了allEntries為true時，Spring Cache將忽略指定的key。有的時候我們需要Cache一下清除所有的元素，這比一個一個清除元素更有效率。

@CacheEvict(value="goods", key="goods.goodsId", condition="goods.goodsId == 123456")
public void deleteGoods(Goods goods) {
}


@CacheEvict(value="goods", allEntries=true)
public void deleteAllGoods() {
}

1.3.2  beforeInvocation屬性
清除操作預設是在對應方法成功執行之後觸發的，即方法如果因為丟擲異常而未能成功返回時也不會觸發清除操作。
使用beforeInvocation可以改變觸發清除操作的時間，當我們指定該屬性值為true時，Spring會在呼叫該方法之前清除快取中的指定元素。

@CacheEvict(value="goods", beforeInvocation=true)
public void deleteGoods(Goods goods) {
}

1.4 @Caching

@Caching註解可以讓我們在一個方法或者類上同時指定多個Spring Cache相關的註解。其擁有三個屬性：cacheable、put和evict，分別用於指定@Cacheable、@CachePut和@CacheEvict。

@Caching(cacheable = @Cacheable("goods"), evict = { @CacheEvict("goods1"),
@CacheEvict(value = "goods2", allEntries = true) })
public Goods find(Integer goodsId) {
  return null;
}