JSR107

Java Caching定義了5個核心介面，分別是CachingProvider, CacheManager, Cache, Entry和Expiry。

• CachingProvider定義了建立、配置、獲取、管理和控制多個 CacheManager。一個應用可以在執行期訪問多個CachingProvider。

• CacheManager定義了建立、配置、獲取、管理和控制多個唯一命名的Cache，這些Cache存在於CacheManager的上下文中。一個CacheManager僅被一個CachingProvider所擁有。

• Cache是一個類似Map的資料結構並臨時儲存以Key為索引的值。一個Cache僅被一個CacheManager所擁有。
• Entry是一個儲存在Cache中的key-value對。
• Expiry每一個儲存在Cache中的條目有一個定義的有效期。一旦超過這個時間，條目為過期的狀態。一旦過期，條目將不可訪問、更新和刪除。快取有效期可以通過ExpiryPolicy設定。

使用JSR107需要匯入如下包

<dependency>
    <groupId>javax.cache</groupId>
    <artifactId>cache-api</artifactId>
</dependency>

Spring快取抽象

Spring從3.1開始定義了org.springframework.cache.Cache和org.springframework.cache.CacheManager介面來統一不同的快取技術；並支援使用JCache（JSR-107）註解簡化我們開發；

• Cache介面為快取的元件規範定義，包含快取的各種操作集合；

• Cache介面下Spring提供了各種xxxCache的實現；如RedisCache，EhCacheCache , ConcurrentMapCache等；

• 每次呼叫需要快取功能的方法時，Spring會檢查檢查指定引數的指定的目標方法是否已經被呼叫過；如果有就直接從快取中獲取方法呼叫後的結果，如果沒有就呼叫方法並快取結果後返回給使用者。下次呼叫直接從快取中獲取。

• 使用Spring快取抽象時我們需要關注以下兩點；
  
  • 確定方法需要被快取以及他們的快取策略
  • 從快取中讀取之前快取儲存的資料

重要概念和快取註解

簡要說明：

• @Cacheable註解載入方法中，那麼該方法第一次會查詢資料庫，然後就會把資料放在快取中，使用Cache 進行資料的讀取等操作。
• @CacheEvict刪除快取，例如根據id刪除使用者，那麼也要刪除快取中的使用者資訊
• @CachePut更新快取，例如更新使用者資訊後，同時也要更新快取中的使用者資訊

使用springboot+mybatis完成快取初體驗

一、Spring boot cache原理

第一步、自動配置類；

​ 自動啟動類：CacheAutoConfiguration
​ 屬性配置：CacheProperties
​ 主啟動類新增：@EnableCaching註解
cache POM新增：

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-cache</artifactId>
</dependency>

第二步、從快取的配置類 中獲取 多個cache

CacheConfigurationImportSelector.selectImports()方法獲取

static class CacheConfigurationImportSelector implements ImportSelector {
​
        @Override
        public String[] selectImports(AnnotationMetadata importingClassMetadata) {
            CacheType[] types = CacheType.values();
            String[] imports = new String[types.length];
            for (int i = 0; i < types.length; i++) {
                imports[i] = CacheConfigurations.getConfigurationClass(types[i]);
            }
            return imports;
        }
​
}

獲取結果：SimpleCacheConfiguration 預設cache

  org.springframework.boot.autoconfigure.cache.GenericCacheConfiguration
   org.springframework.boot.autoconfigure.cache.JCacheCacheConfiguration
   org.springframework.boot.autoconfigure.cache.EhCacheCacheConfiguration
   org.springframework.boot.autoconfigure.cache.HazelcastCacheConfiguration
   org.springframework.boot.autoconfigure.cache.InfinispanCacheConfiguration
   org.springframework.boot.autoconfigure.cache.CouchbaseCacheConfiguration
   org.springframework.boot.autoconfigure.cache.RedisCacheConfiguration
   org.springframework.boot.autoconfigure.cache.CaffeineCacheConfiguration
   org.springframework.boot.autoconfigure.cache.GuavaCacheConfiguration
   org.springframework.boot.autoconfigure.cache.SimpleCacheConfiguration【預設】
   org.springframework.boot.autoconfigure.cache.NoOpCacheConfiguration

第三步：SimpleCacheConfiguration.cacheManager()

此方法中給容器中註冊了一個CacheManager元件：型別為ConcurrentMapCacheManager

@Bean
public ConcurrentMapCacheManager cacheManager() {
   ConcurrentMapCacheManager cacheManager = new ConcurrentMapCacheManager();
   List<String> cacheNames = this.cacheProperties.getCacheNames();
   if (!cacheNames.isEmpty()) {
      cacheManager.setCacheNames(cacheNames);
   }
   return this.customizerInvoker.customize(cacheManager);
}

第四步：檢視獲取快取方法getCache（）

ConcurrentMapCacheManager 類裡，資料都儲存到為ConcurrentMap 中

public Cache getCache(String name) {
   Cache cache = this.cacheMap.get(name); //cacheMap 為ConcurrentMap  型別，獲取一個cache元件
   if (cache == null && this.dynamic) {
      synchronized (this.cacheMap) {
         cache = this.cacheMap.get(name); //cahceMap不為空獲取
         if (cache == null) {
            //可以獲取或者建立ConcurrentMapCache型別的快取元件；他的作用將資料儲存在ConcurrentMap中；
            cache = createConcurrentMapCache(name);   
            this.cacheMap.put(name, cache); //ConcurrentMapCache.lookup();
         }
      }
   }
   return cache;
}

二、Cacheable執行流程：

@Cacheable： 1、方法執行之前，先去查詢Cache（快取元件），按照cacheNames指定的名字獲取； （CacheManager先獲取相應的快取），第一次獲取快取如果沒有Cache元件會自動建立。 2、去Cache中查詢快取的內容(ConcurrentMapCache.lookup()方法中去查詢)，使用一個key，預設就是方法的引數； key是按照某種策略生成的；預設是使用keyGenerator生成的，預設使用SimpleKeyGenerator生成key； SimpleKeyGenerator生成key的預設策略； 如果沒有引數；key=new SimpleKey()； 如果有一個引數：key=引數的值 如果有多個引數：key=new SimpleKey(params)；

//這個方法  SimpleKeyGenerator.generateKey()    方法生成key

public static Object generateKey(Object... params) {
   if (params.length == 0) {
      return SimpleKey.EMPTY;
   }
   if (params.length == 1) {  //如果只有一個引數，直接返回這個引數為key
      Object param = params[0];
      if (param != null && !param.getClass().isArray()) {
         return param;
      }
   }
   return new SimpleKey(params);
}

​ 3、沒有查到快取就呼叫目標方法； 4、將目標方法返回的結果，放進快取中ConcurrentMapCache.put();

​ @Cacheable標註的方法執行之前先來檢查快取中有沒有這個資料，預設按照引數的值作為key去查詢快取， 如果沒有就執行方法並將結果放入快取；以後再來呼叫就可以直接使用快取中的資料；

核心：

1. 使用CacheManager【ConcurrentMapCacheManager】按照名字得到Cache【ConcurrentMapCache】元件
2. key使用keyGenerator生成的，預設是SimpleKeyGenerator

詳細執行流程：ConcurrentMapCache.lookup()上斷點檢視，執行過程

//第一步CacheAspectSupport  中execute（）
private Object execute(final CacheOperationInvoker invoker, Method method, CacheOperationContexts contexts) 
//第二步  CacheAspectSupport
private Cache.ValueWrapper findCachedItem(Collection<CacheOperationContext> contexts) {
    Object result = CacheOperationExpressionEvaluator.NO_RESULT;
    for (CacheOperationContext context : contexts) {
        if (isConditionPassing(context, result)) {
            Object key = generateKey(context, result);  //獲取key
            Cache.ValueWrapper cached = findInCaches(context, key);
            if (cached != null) {
                return cached;
            }
            else {
                if (logger.isTraceEnabled()) {
                    logger.trace("No cache entry for key '" + key + "' in cache(s) " + context.getCacheNames());
                }
            }
        }
    }
    return null;
}
//第三步：CacheAspectSupport.findInCaches()
//第四步：AbstractCacheInvoker.doGet()
//第五步：AbstractValueAdaptingCache.get();
@Override
public ValueWrapper get(Object key) {
        Object value = lookup(key);
        return toValueWrapper(value);
}
// 第六步：ConcurrentMapCache.lookup();  從ConcurrentMap 中根據key獲取值
@Override
protected Object lookup(Object key) {
        return this.store.get(key);
}

三、Cacheable 註解的幾個屬性：

• cacheNames/value：指定快取元件的名字;將方法的返回結果放在哪個快取中，是陣列的方式，可以指定 多個快取；
  
  • key：快取資料使用的key；可以用它來指定。預設是使用方法引數的值 1-方法的返回值
    ​ 編寫SpEL； #i d;引數id的值 #a0 #p0 #root.args[0]
    ​ getEmp[2]
  • ​keyGenerator：key的生成器；可以自己指定key的生成器的元件id
    ​ key/keyGenerator：二選一使用;
  • cacheManager：指定快取管理器；或者cacheResolver指定獲取解析器
  • condition：指定符合條件的情況下才快取；
    ​ condition = “#id>0”
    ​ condition = “#a0>1”：第一個引數的值》1的時候才進行快取

• unless:否定快取；當unless指定的條件為true，方法的返回值就不會被快取；可以獲取到結果進行判斷
  ​ unless = “#result == null”
  ​ unless = “#a0==2”:如果第一個引數的值是2，結果不快取；

  • sync：是否使用非同步模式；非同步模式的情況下unless不支援

四、Cache使用：

1.Cacheable的使用

@Cacheable(value = {"emp"}/*,keyGenerator = "myKeyGenerator",condition = "#a0>1",unless = "#a0==2"*/)
public Employee getEmp(Integer id){
    System.out.println("查詢"+id+"號員工");
    Employee emp = employeeMapper.getEmpById(id);
    return emp;
}

2.自定義keyGenerator：

@Bean("myKeyGenerator")
public KeyGenerator keyGenerator(){
    return new KeyGenerator(){
​
        @Override
        public Object generate(Object target, Method method, Object... params) {
            return method.getName()+"["+ Arrays.asList(params).toString()+"]";
        }
    };
}

3.CachePut的使用：更新快取

/**
     * @CachePut：既呼叫方法，又更新快取資料；同步更新快取
     * 修改了資料庫的某個資料，同時更新快取；
     * 執行時機：
     *  1、先呼叫目標方法
     *  2、將目標方法的結果快取起來
     *
     * 測試步驟：
     *  1、查詢1號員工；查到的結果會放在快取中；
     *          key：1  value：lastName：張三
     *  2、以後查詢還是之前的結果
     *  3、更新1號員工；【lastName:zhangsan；gender:0】
     *          將方法的返回值也放進快取了；
     *          key：傳入的employee物件  值：返回的employee物件；
     *  4、查詢1號員工？
     *      應該是更新後的員工；
     *          key = "#employee.id":使用傳入的引數的員工id；
     *          key = "#result.id"：使用返回後的id
     *             @Cacheable的key是不能用#result
     *      為什麼是沒更新前的？【1號員工沒有在快取中更新】
     *
     */
    @CachePut(value = "emp",key = "#result.id")
    public Employee updateEmp(Employee employee){
        System.out.println("updateEmp:"+employee);
        employeeMapper.updateEmp(employee);
        return employee;
    }

4.CacheEvict 快取清除

/**
 * @CacheEvict：快取清除
 *  key：指定要清除的資料
 *  allEntries = true：指定清除這個快取（emp快取元件）中所有的資料
 *  beforeInvocation = false：快取的清除是否在方法之前執行
 *      預設代表快取清除操作是在方法執行之後執行;如果出現異常快取就不會清除
 *
 *  beforeInvocation = true：
 *      代表清除快取操作是在方法執行之前執行，無論方法是否出現異常，快取都清除
 *
 *
 */
@CacheEvict(value="emp",beforeInvocation = true，key = "#id")
public void deleteEmp(Integer id){
    System.out.println("deleteEmp:"+id);
    //employeeMapper.deleteEmpById(id);
    int i = 10/0;
}

5.Caching 複雜配置

// @Caching 定義複雜的快取規則
@Caching(
     cacheable = {
         @Cacheable(/*value="emp",*/key = "#lastName")
     },
     put = {
         @CachePut(/*value="emp",*/key = "#result.id"),
         @CachePut(/*value="emp",*/key = "#result.email")
     }
)
public Employee getEmpByLastName(String lastName){
    return employeeMapper.getEmpByLastName(lastName);
}

6.CacheConfig快取清除

@CacheConfig(cacheNames="emp",cacheManager = "employeeCacheManager") //抽取快取的公共配置
@Service
public class EmployeeService {