緩存是實(shí)際工作中非常常用的一種提高性能的方法, 我們會(huì )在許多場(chǎng)景下來(lái)使用緩存。

本文通過(guò)一個(gè)簡(jiǎn)單的例子進(jìn)行展開(kāi)，通過(guò)對比我們原來(lái)的自定義緩存和 spring 的基于注釋的 cache 配置方法，展現了 spring cache 的強大之處，然后介紹了其基本的原理，擴展點(diǎn)和使用場(chǎng)景的限制。通過(guò)閱讀本文，你應該可以短時(shí)間內掌握 spring 帶來(lái)的強大緩存技術(shù)，在很少的配置下即可給既有代碼提供緩存能力。

概述

Spring 3.1 引入了激動(dòng)人心的基于注釋?zhuān)╝nnotation）的緩存（cache）技術(shù)，它本質(zhì)上不是一個(gè)具體的緩存實(shí)現方案（例如EHCache 或者 OSCache），而是一個(gè)對緩存使用的抽象，通過(guò)在既有代碼中添加少量它定義的各種 annotation，即能夠達到緩存方法的返回對象的效果。

Spring 的緩存技術(shù)還具備相當的靈活性，不僅能夠使用 SpEL（Spring Expression Language）來(lái)定義緩存的 key 和各種 condition，還提供開(kāi)箱即用的緩存臨時(shí)存儲方案，也支持和主流的專(zhuān)業(yè)緩存例如 EHCache 集成。

其特點(diǎn)總結如下：

• 通過(guò)少量的配置 annotation 注釋即可使得既有代碼支持緩存
• 支持開(kāi)箱即用 Out-Of-The-Box，即不用安裝和部署額外第三方組件即可使用緩存
• 支持 Spring Express Language，能使用對象的任何屬性或者方法來(lái)定義緩存的 key 和 condition
• 支持 AspectJ，并通過(guò)其實(shí)現任何方法的緩存支持
• 支持自定義 key 和自定義緩存管理者，具有相當的靈活性和擴展性

本文將針對上述特點(diǎn)對 Spring cache 進(jìn)行詳細的介紹，主要通過(guò)一個(gè)簡(jiǎn)單的例子和原理介紹展開(kāi)，然后我們將一起看一個(gè)比較實(shí)際的緩存例子，最后會(huì )介紹 spring cache 的使用限制和注意事項。好吧，讓我們開(kāi)始吧

我們以前如何自己實(shí)現緩存的呢

這里先展示一個(gè)完全自定義的緩存實(shí)現，即不用任何第三方的組件來(lái)實(shí)現某種對象的內存緩存。

場(chǎng)景如下：

對一個(gè)賬號查詢(xún)方法做緩存，以賬號名稱(chēng)為 key，賬號對象為 value，當以相同的賬號名稱(chēng)查詢(xún)賬號的時(shí)候，直接從緩存中返回結果，否則更新緩存。賬號查詢(xún)服務(wù)還支持 reload 緩存（即清空緩存）

首先定義一個(gè)實(shí)體類(lèi)：賬號類(lèi)，具備基本的 id 和 name 屬性，且具備 getter 和 setter 方法

public class Account {

    private int id;
    private String name;

    public Account(String name) {
        this.name = name;
    }
    public int getId() {
        return id;
    }
    public void setId(int id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }

}

然后定義一個(gè)緩存管理器，這個(gè)管理器負責實(shí)現緩存邏輯，支持對象的增加、修改和刪除，支持值對象的泛型。如下：

import com.google.common.collect.Maps;

import java.util.Map;
public class CacheContext<T> {

    private Map<String, T> cache = Maps.newConcurrentMap();

    public T get(String key){
        return  cache.get(key);
    }

    public void addOrUpdateCache(String key,T value) {
        cache.put(key, value);
    }

    // 根據 key 來(lái)刪除緩存中的一條記錄
    public void evictCache(String key) {
        if(cache.containsKey(key)) {
            cache.remove(key);
        }
    }

    // 清空緩存中的所有記錄
    public void evictCache() {
        cache.clear();
    }

}

好，現在我們有了實(shí)體類(lèi)和一個(gè)緩存管理器，還需要一個(gè)提供賬號查詢(xún)的服務(wù)類(lèi)，此服務(wù)類(lèi)使用緩存管理器來(lái)支持賬號查詢(xún)緩存，如下：

import com.google.common.base.Optional;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Service;

import javax.annotation.Resource;
@Service
public class AccountService1 {

    private final Logger logger = LoggerFactory.getLogger(AccountService1.class);

    @Resource
    private CacheContext<Account> accountCacheContext;

    public Account getAccountByName(String accountName) {
        Account result = accountCacheContext.get(accountName);
        if (result != null) {
            logger.info("get from cache... {}", accountName);
            return result;
        }

        Optional<Account> accountOptional = getFromDB(accountName);
        if (!accountOptional.isPresent()) {
            throw new IllegalStateException(String.format("can not find account by account name : [%s]", accountName));
        }

        Account account = accountOptional.get();
        accountCacheContext.addOrUpdateCache(accountName, account);
        return account;
    }

    public void reload() {
        accountCacheContext.evictCache();
    }

    private Optional<Account> getFromDB(String accountName) {
        logger.info("real querying db... {}", accountName);
        //Todo query data from database
        return Optional.fromNullable(new Account(accountName));
    }

}

現在我們開(kāi)始寫(xiě)一個(gè)測試類(lèi)，用于測試剛才的緩存是否有效

import org.junit.Before;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.support.ClassPathXmlApplicationContext;

import static org.junit.Assert.*;

public class AccountService1Test {

    private AccountService1 accountService1;

    private final Logger logger = LoggerFactory.getLogger(AccountService1Test.class);

    @Before
    public void setUp() throws Exception {
        ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("applicationContext1.xml");
        accountService1 = context.getBean("accountService1", AccountService1.class);
    }

    @Test
    public void testInject(){
        assertNotNull(accountService1);
    }

    @Test
    public void testGetAccountByName() throws Exception {
        accountService1.getAccountByName("accountName");
        accountService1.getAccountByName("accountName");

        accountService1.reload();
        logger.info("after reload ....");

        accountService1.getAccountByName("accountName");
        accountService1.getAccountByName("accountName");
    }
}

按照分析，執行結果應該是：首先從數據庫查詢(xún)，然后直接返回緩存中的結果，重置緩存后，應該先從數據庫查詢(xún)，然后返回緩存中的結果. 查看程序運行的日志如下：

00:53:17.166 [main] INFO  c.r.s.cache.example1.AccountService - real querying db... accountName
00:53:17.168 [main] INFO  c.r.s.cache.example1.AccountService - get from cache... accountName
00:53:17.168 [main] INFO  c.r.s.c.example1.AccountServiceTest - after reload ....
00:53:17.168 [main] INFO  c.r.s.cache.example1.AccountService - real querying db... accountName
00:53:17.169 [main] INFO  c.r.s.cache.example1.AccountService - get from cache... accountName

可以看出我們的緩存起效了，但是這種自定義的緩存方案有如下劣勢：

• 緩存代碼和業(yè)務(wù)代碼耦合度太高，如上面的例子，AccountService 中的 getAccountByName（）方法中有了太多緩存的邏輯，不便于維護和變更
• 不靈活，這種緩存方案不支持按照某種條件的緩存，比如只有某種類(lèi)型的賬號才需要緩存，這種需求會(huì )導致代碼的變更
• 緩存的存儲這塊寫(xiě)的比較死，不能靈活的切換為使用第三方的緩存模塊

如果你的代碼中有上述代碼的影子，那么你可以考慮按照下面的介紹來(lái)優(yōu)化一下你的代碼結構了，也可以說(shuō)是簡(jiǎn)化，你會(huì )發(fā)現，你的代碼會(huì )變得優(yōu)雅的多！

Spring cache是如何做的呢

我們對AccountService1 進(jìn)行修改，創(chuàng )建AccountService2:

import com.google.common.base.Optional;
import com.rollenholt.spring.cache.example1.Account;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.cache.annotation.Cacheable;
import org.springframework.stereotype.Service;
@Service
public class AccountService2 {

    private final Logger logger = LoggerFactory.getLogger(AccountService2.class);

    // 使用了一個(gè)緩存名叫 accountCache
    @Cacheable(value="accountCache")
    public Account getAccountByName(String accountName) {

        // 方法內部實(shí)現不考慮緩存邏輯，直接實(shí)現業(yè)務(wù)
        logger.info("real querying account... {}", accountName);
        Optional<Account> accountOptional = getFromDB(accountName);
        if (!accountOptional.isPresent()) {
            throw new IllegalStateException(String.format("can not find account by account name : [%s]", accountName));
        }

        return accountOptional.get();
    }

    private Optional<Account> getFromDB(String accountName) {
        logger.info("real querying db... {}", accountName);
        //Todo query data from database
        return Optional.fromNullable(new Account(accountName));
    }

}

我們注意到在上面的代碼中有一行：

     @Cacheable(value="accountCache")
     

這個(gè)注釋的意思是，當調用這個(gè)方法的時(shí)候，會(huì )從一個(gè)名叫 accountCache 的緩存中查詢(xún)，如果沒(méi)有，則執行實(shí)際的方法（即查詢(xún)數據庫），并將執行的結果存入緩存中，否則返回緩存中的對象。這里的緩存中的 key 就是參數 accountName，value 就是 Account 對象。“accountCache”緩存是在 spring*.xml 中定義的名稱(chēng)。我們還需要一個(gè) spring 的配置文件來(lái)支持基于注釋的緩存

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:cache="http://www.springframework.org/schema/cache"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
           http://www.springframework.org/schema/beans/spring-beans.xsd
           http://www.springframework.org/schema/context
           http://www.springframework.org/schema/context/spring-context.xsd
           http://www.springframework.org/schema/cache
           http://www.springframework.org/schema/cache/spring-cache.xsd">

    <context:component-scan base-package="com.rollenholt.spring.cache"/>

    <context:annotation-config/>

    <cache:annotation-driven/>

    <bean id="cacheManager" class="org.springframework.cache.support.SimpleCacheManager">
        <property name="caches">
            <set>
                <bean class="org.springframework.cache.concurrent.ConcurrentMapCacheFactoryBean">
                    <property name="name" value="default"/>
                </bean>
                <bean class="org.springframework.cache.concurrent.ConcurrentMapCacheFactoryBean">
                    <property name="name" value="accountCache"/>
                </bean>
            </set>
        </property>
    </bean>

</beans>

注意這個(gè) spring 配置文件有一個(gè)關(guān)鍵的支持緩存的配置項：

<cache:annotation-driven />

這個(gè)配置項缺省使用了一個(gè)名字叫 cacheManager 的緩存管理器，這個(gè)緩存管理器有一個(gè) spring 的缺省實(shí)現，即 org.springframework.cache.support.SimpleCacheManager，這個(gè)緩存管理器實(shí)現了我們剛剛自定義的緩存管理器的邏輯，它需要配置一個(gè)屬性 caches，即此緩存管理器管理的緩存集合，除了缺省的名字叫 default 的緩存，我們還自定義了一個(gè)名字叫 accountCache 的緩存，使用了缺省的內存存儲方案 ConcurrentMapCacheFactoryBean，它是基于 java.util.concurrent.ConcurrentHashMap 的一個(gè)內存緩存實(shí)現方案。

然后我們編寫(xiě)測試程序：

 import org.junit.Before;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.support.ClassPathXmlApplicationContext;

import static org.junit.Assert.*;

public class AccountService2Test {

    private AccountService2 accountService2;

    private final Logger logger = LoggerFactory.getLogger(AccountService2Test.class);

    @Before
    public void setUp() throws Exception {
        ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("applicationContext2.xml");
        accountService2 = context.getBean("accountService2", AccountService2.class);
    }

    @Test
    public void testInject(){
        assertNotNull(accountService2);
    }

    @Test
    public void testGetAccountByName() throws Exception {
        logger.info("first query...");
        accountService2.getAccountByName("accountName");

        logger.info("second query...");
        accountService2.getAccountByName("accountName");
    }
}

上面的測試代碼主要進(jìn)行了兩次查詢(xún)，第一次應該會(huì )查詢(xún)數據庫，第二次應該返回緩存，不再查數據庫，我們執行一下，看看結果

01:10:32.435 [main] INFO  c.r.s.c.example2.AccountService2Test - first query...
01:10:32.456 [main] INFO  c.r.s.cache.example2.AccountService2 - real querying account... accountName
01:10:32.457 [main] INFO  c.r.s.cache.example2.AccountService2 - real querying db... accountName
01:10:32.458 [main] INFO  c.r.s.c.example2.AccountService2Test - second query...

可以看出我們設置的基于注釋的緩存起作用了，而在 AccountService.java 的代碼中，我們沒(méi)有看到任何的緩存邏輯代碼，只有一行注釋?zhuān)篅Cacheable(value="accountCache")，就實(shí)現了基本的緩存方案，是不是很強大？

如何清空緩存

好，到目前為止，我們的 spring cache 緩存程序已經(jīng)運行成功了，但是還不完美，因為還缺少一個(gè)重要的緩存管理邏輯：清空緩存.

當賬號數據發(fā)生變更，那么必須要清空某個(gè)緩存，另外還需要定期的清空所有緩存，以保證緩存數據的可靠性。

為了加入清空緩存的邏輯，我們只要對 AccountService2.java 進(jìn)行修改，從業(yè)務(wù)邏輯的角度上看，它有兩個(gè)需要清空緩存的地方

• 當外部調用更新了賬號，則我們需要更新此賬號對應的緩存
• 當外部調用說(shuō)明重新加載，則我們需要清空所有緩存

我們在A(yíng)ccountService2的基礎上進(jìn)行修改，修改為AccountService3，代碼如下：

import com.google.common.base.Optional;
import com.rollenholt.spring.cache.example1.Account;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.cache.annotation.CacheEvict;
import org.springframework.cache.annotation.Cacheable;
import org.springframework.stereotype.Service;

@Service
public class AccountService3 {

    private final Logger logger = LoggerFactory.getLogger(AccountService3.class);

    // 使用了一個(gè)緩存名叫 accountCache
    @Cacheable(value="accountCache")
    public Account getAccountByName(String accountName) {

        // 方法內部實(shí)現不考慮緩存邏輯，直接實(shí)現業(yè)務(wù)
        logger.info("real querying account... {}", accountName);
        Optional<Account> accountOptional = getFromDB(accountName);
        if (!accountOptional.isPresent()) {
            throw new IllegalStateException(String.format("can not find account by account name : [%s]", accountName));
        }

        return accountOptional.get();
    }

    @CacheEvict(value="accountCache",key="#account.getName()")
    public void updateAccount(Account account) {
        updateDB(account);
    }

    @CacheEvict(value="accountCache",allEntries=true)
    public void reload() {
    }

    private void updateDB(Account account) {
        logger.info("real update db...{}", account.getName());
    }

    private Optional<Account> getFromDB(String accountName) {
        logger.info("real querying db... {}", accountName);
        //Todo query data from database
        return Optional.fromNullable(new Account(accountName));
    }
}

我們的測試代碼如下：

import com.rollenholt.spring.cache.example1.Account;
import org.junit.Before;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class AccountService3Test {


    private AccountService3 accountService3;

    private final Logger logger = LoggerFactory.getLogger(AccountService3Test.class);

    @Before
    public void setUp() throws Exception {
        ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("applicationContext2.xml");
        accountService3 = context.getBean("accountService3", AccountService3.class);
    }

    @Test
    public void testGetAccountByName() throws Exception {

        logger.info("first query.....");
        accountService3.getAccountByName("accountName");

        logger.info("second query....");
        accountService3.getAccountByName("accountName");

    }

    @Test
    public void testUpdateAccount() throws Exception {
        Account account1 = accountService3.getAccountByName("accountName1");
        logger.info(account1.toString());
        Account account2 = accountService3.getAccountByName("accountName2");
        logger.info(account2.toString());

        account2.setId(121212);
        accountService3.updateAccount(account2);

        // account1會(huì )走緩存
        account1 = accountService3.getAccountByName("accountName1");
        logger.info(account1.toString());
        // account2會(huì )查詢(xún)db
        account2 = accountService3.getAccountByName("accountName2");
        logger.info(account2.toString());

    }

    @Test
    public void testReload() throws Exception {
        accountService3.reload();
        // 這2行查詢(xún)數據庫
        accountService3.getAccountByName("somebody1");
        accountService3.getAccountByName("somebody2");

        // 這兩行走緩存
        accountService3.getAccountByName("somebody1");
        accountService3.getAccountByName("somebody2");
    }
}

在這個(gè)測試代碼中我們重點(diǎn)關(guān)注testUpdateAccount()方法，在測試代碼中我們已經(jīng)注釋了在update完account2以后，再次查詢(xún)的時(shí)候，account1會(huì )走緩存，而account2不會(huì )走緩存，而去查詢(xún)db，觀(guān)察程序運行日志，運行日志為：

01:37:34.549 [main] INFO  c.r.s.cache.example3.AccountService3 - real querying account... accountName1
01:37:34.551 [main] INFO  c.r.s.cache.example3.AccountService3 - real querying db... accountName1
01:37:34.552 [main] INFO  c.r.s.c.example3.AccountService3Test - Account{id=0, name='accountName1'}
01:37:34.553 [main] INFO  c.r.s.cache.example3.AccountService3 - real querying account... accountName2
01:37:34.553 [main] INFO  c.r.s.cache.example3.AccountService3 - real querying db... accountName2
01:37:34.555 [main] INFO  c.r.s.c.example3.AccountService3Test - Account{id=0, name='accountName2'}
01:37:34.555 [main] INFO  c.r.s.cache.example3.AccountService3 - real update db...accountName2
01:37:34.595 [main] INFO  c.r.s.c.example3.AccountService3Test - Account{id=0, name='accountName1'}
01:37:34.596 [main] INFO  c.r.s.cache.example3.AccountService3 - real querying account... accountName2
01:37:34.596 [main] INFO  c.r.s.cache.example3.AccountService3 - real querying db... accountName2
01:37:34.596 [main] INFO  c.r.s.c.example3.AccountService3Test - Account{id=0, name='accountName2'}

我們會(huì )發(fā)現實(shí)際運行情況和我們預估的結果是一致的。

如何按照條件操作緩存

前面介紹的緩存方法，沒(méi)有任何條件，即所有對 accountService 對象的 getAccountByName 方法的調用都會(huì )起動(dòng)緩存效果，不管參數是什么值。

如果有一個(gè)需求，就是只有賬號名稱(chēng)的長(cháng)度小于等于 4 的情況下，才做緩存，大于 4 的不使用緩存

雖然這個(gè)需求比較坑爹，但是拋開(kāi)需求的合理性，我們怎么實(shí)現這個(gè)功能呢？

通過(guò)查看CacheEvict注解的定義，我們會(huì )發(fā)現：

/**
 * Annotation indicating that a method (or all methods on a class) trigger(s)
 * a cache invalidate operation.
 *
 * @author Costin Leau
 * @author Stephane Nicoll
 * @since 3.1
 * @see CacheConfig
 */
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface CacheEvict {

    /**
     * Qualifier value for the specified cached operation.
     * <p>May be used to determine the target cache (or caches), matching the qualifier
     * value (or the bean name(s)) of (a) specific bean definition.
     */
    String[] value() default {};

    /**
     * Spring Expression Language (SpEL) attribute for computing the key dynamically.
     * <p>Default is "", meaning all method parameters are considered as a key, unless
     * a custom {@link #keyGenerator()} has been set.
     */
    String key() default "";

    /**
     * The bean name of the custom {@link org.springframework.cache.interceptor.KeyGenerator} to use.
     * <p>Mutually exclusive with the {@link #key()} attribute.
     */
    String keyGenerator() default "";

    /**
     * The bean name of the custom {@link org.springframework.cache.CacheManager} to use to
     * create a default {@link org.springframework.cache.interceptor.CacheResolver} if none
     * is set already.
     * <p>Mutually exclusive with the {@link #cacheResolver()}  attribute.
     * @see org.springframework.cache.interceptor.SimpleCacheResolver
     */
    String cacheManager() default "";

    /**
     * The bean name of the custom {@link org.springframework.cache.interceptor.CacheResolver} to use.
     */
    String cacheResolver() default "";

    /**
     * Spring Expression Language (SpEL) attribute used for conditioning the method caching.
     * <p>Default is "", meaning the method is always cached.
     */
    String condition() default "";

    /**
     * Whether or not all the entries inside the cache(s) are removed or not. By
     * default, only the value under the associated key is removed.
     * <p>Note that setting this parameter to {@code true} and specifying a {@link #key()}
     * is not allowed.
     */
    boolean allEntries() default false;

    /**
     * Whether the eviction should occur after the method is successfully invoked (default)
     * or before. The latter causes the eviction to occur irrespective of the method outcome (whether
     * it threw an exception or not) while the former does not.
     */
    boolean beforeInvocation() default false;
}

定義中有一個(gè)condition描述：

Spring Expression Language (SpEL) attribute used for conditioning the method caching.Default is "", meaning the method is always cached.

我們可以利用這個(gè)方法來(lái)完成這個(gè)功能，下面只給出示例代碼：

@Cacheable(value="accountCache",condition="#accountName.length() <= 4")// 緩存名叫 accountCache 
public Account getAccountByName(String accountName) {
    // 方法內部實(shí)現不考慮緩存邏輯，直接實(shí)現業(yè)務(wù)
    return getFromDB(accountName);
}

注意其中的 condition=”#accountName.length() <=4”，這里使用了 SpEL 表達式訪(fǎng)問(wèn)了參數 accountName 對象的 length() 方法，條件表達式返回一個(gè)布爾值，true/false，當條件為 true，則進(jìn)行緩存操作，否則直接調用方法執行的返回結果。

如果有多個(gè)參數，如何進(jìn)行 key 的組合

我們看看CacheEvict注解的key()方法的描述：

Spring Expression Language (SpEL) attribute for computing the key dynamically. Default is "", meaning all method parameters are considered as a key, unless a custom {@link #keyGenerator()} has been set.

假設我們希望根據對象相關(guān)屬性的組合來(lái)進(jìn)行緩存，比如有這么一個(gè)場(chǎng)景：

要求根據賬號名、密碼和是否發(fā)送日志查詢(xún)賬號信息

很明顯，這里我們需要根據賬號名、密碼對賬號對象進(jìn)行緩存，而第三個(gè)參數“是否發(fā)送日志”對緩存沒(méi)有任何影響。所以，我們可以利用 SpEL 表達式對緩存 key 進(jìn)行設計

我們?yōu)锳ccount類(lèi)增加一個(gè)password 屬性， 然后修改AccountService代碼：

 @Cacheable(value="accountCache",key="#accountName.concat(#password)") 
 public Account getAccount(String accountName,String password,boolean sendLog) { 
   // 方法內部實(shí)現不考慮緩存邏輯，直接實(shí)現業(yè)務(wù)
   return getFromDB(accountName,password); 
 }
 

注意上面的 key 屬性，其中引用了方法的兩個(gè)參數 accountName 和 password，而 sendLog 屬性沒(méi)有考慮，因為其對緩存沒(méi)有影響。

accountService.getAccount("accountName", "123456", true);// 查詢(xún)數據庫
accountService.getAccount("accountName", "123456", true);// 走緩存
accountService.getAccount("accountName", "123456", false);// 走緩存
accountService.getAccount("accountName", "654321", true);// 查詢(xún)數據庫
accountService.getAccount("accountName", "654321", true);// 走緩存

如何做到：既要保證方法被調用，又希望結果被緩存

根據前面的例子，我們知道，如果使用了 @Cacheable 注釋?zhuān)瑒t當重復使用相同參數調用方法的時(shí)候，方法本身不會(huì )被調用執行，即方法本身被略過(guò)了，取而代之的是方法的結果直接從緩存中找到并返回了。

現實(shí)中并不總是如此，有些情況下我們希望方法一定會(huì )被調用，因為其除了返回一個(gè)結果，還做了其他事情，例如記錄日志，調用接口等，這個(gè)時(shí)候，我們可以用 @CachePut 注釋?zhuān)@個(gè)注釋可以確保方法被執行，同時(shí)方法的返回值也被記錄到緩存中。

@Cacheable(value="accountCache")
 public Account getAccountByName(String accountName) { 
   // 方法內部實(shí)現不考慮緩存邏輯，直接實(shí)現業(yè)務(wù)
   return getFromDB(accountName); 
 } 

 // 更新 accountCache 緩存
 @CachePut(value="accountCache",key="#account.getName()")
 public Account updateAccount(Account account) { 
   return updateDB(account); 
 } 
 private Account updateDB(Account account) { 
   logger.info("real updating db..."+account.getName()); 
   return account; 
 }

我們的測試代碼如下

Account account = accountService.getAccountByName("someone"); 
account.setPassword("123"); 
accountService.updateAccount(account); 
account.setPassword("321"); 
accountService.updateAccount(account); 
account = accountService.getAccountByName("someone"); 
logger.info(account.getPassword()); 

如上面的代碼所示，我們首先用 getAccountByName 方法查詢(xún)一個(gè)人 someone 的賬號，這個(gè)時(shí)候會(huì )查詢(xún)數據庫一次，但是也記錄到緩存中了。然后我們修改了密碼，調用了 updateAccount 方法，這個(gè)時(shí)候會(huì )執行數據庫的更新操作且記錄到緩存，我們再次修改密碼并調用 updateAccount 方法，然后通過(guò) getAccountByName 方法查詢(xún)，這個(gè)時(shí)候，由于緩存中已經(jīng)有數據，所以不會(huì )查詢(xún)數據庫，而是直接返回最新的數據，所以打印的密碼應該是“321”

@Cacheable、@CachePut、@CacheEvict 注釋介紹

• @Cacheable 主要針對方法配置，能夠根據方法的請求參數對其結果進(jìn)行緩存
• @CachePut 主要針對方法配置，能夠根據方法的請求參數對其結果進(jìn)行緩存，和 @Cacheable 不同的是，它每次都會(huì )觸發(fā)真實(shí)方法的調用
  -@CachEvict 主要針對方法配置，能夠根據一定的條件對緩存進(jìn)行清空

基本原理

一句話(huà)介紹就是Spring AOP的動(dòng)態(tài)代理技術(shù)。 如果讀者對Spring AOP不熟悉的話(huà)，可以去看看官方文檔

擴展性

直到現在，我們已經(jīng)學(xué)會(huì )了如何使用開(kāi)箱即用的 spring cache，這基本能夠滿(mǎn)足一般應用對緩存的需求。

但現實(shí)總是很復雜，當你的用戶(hù)量上去或者性能跟不上，總需要進(jìn)行擴展，這個(gè)時(shí)候你或許對其提供的內存緩存不滿(mǎn)意了，因為其不支持高可用性，也不具備持久化數據能力，這個(gè)時(shí)候，你就需要自定義你的緩存方案了。

還好，spring 也想到了這一點(diǎn)。我們先不考慮如何持久化緩存，畢竟這種第三方的實(shí)現方案很多。

我們要考慮的是，怎么利用 spring 提供的擴展點(diǎn)實(shí)現我們自己的緩存，且在不改原來(lái)已有代碼的情況下進(jìn)行擴展。

首先，我們需要提供一個(gè) CacheManager 接口的實(shí)現，這個(gè)接口告訴 spring 有哪些 cache 實(shí)例，spring 會(huì )根據 cache 的名字查找 cache 的實(shí)例。另外還需要自己實(shí)現 Cache 接口，Cache 接口負責實(shí)際的緩存邏輯，例如增加鍵值對、存儲、查詢(xún)和清空等。

利用 Cache 接口，我們可以對接任何第三方的緩存系統，例如 EHCache、OSCache，甚至一些內存數據庫例如 memcache 或者 redis 等。下面我舉一個(gè)簡(jiǎn)單的例子說(shuō)明如何做。

import java.util.Collection; 

 import org.springframework.cache.support.AbstractCacheManager; 

 public class MyCacheManager extends AbstractCacheManager { 
   private Collection<? extends MyCache> caches; 
  
   /** 
   * Specify the collection of Cache instances to use for this CacheManager. 
   */ 
   public void setCaches(Collection<? extends MyCache> caches) { 
     this.caches = caches; 
   } 

   @Override 
   protected Collection<? extends MyCache> loadCaches() { 
     return this.caches; 
   } 

 }

上面的自定義的 CacheManager 實(shí)際繼承了 spring 內置的 AbstractCacheManager，實(shí)際上僅僅管理 MyCache 類(lèi)的實(shí)例。

下面是MyCache的定義：

import java.util.HashMap; 
 import java.util.Map; 

 import org.springframework.cache.Cache; 
 import org.springframework.cache.support.SimpleValueWrapper; 

 public class MyCache implements Cache { 
   private String name; 
   private Map<String,Account> store = new HashMap<String,Account>();; 
  
   public MyCache() { 
   } 
  
   public MyCache(String name) { 
     this.name = name; 
   } 
  
   @Override 
   public String getName() { 
     return name; 
   } 
  
   public void setName(String name) { 
     this.name = name; 
   } 

   @Override 
   public Object getNativeCache() { 
     return store; 
   } 

   @Override 
   public ValueWrapper get(Object key) { 
     ValueWrapper result = null; 
     Account thevalue = store.get(key); 
     if(thevalue!=null) { 
       thevalue.setPassword("from mycache:"+name); 
       result = new SimpleValueWrapper(thevalue); 
     } 
     return result; 
   } 

   @Override 
   public void put(Object key, Object value) { 
     Account thevalue = (Account)value; 
     store.put((String)key, thevalue); 
   } 

   @Override 
   public void evict(Object key) { 
   } 

   @Override 
   public void clear() { 
   } 
 }
 

上面的自定義緩存只實(shí)現了很簡(jiǎn)單的邏輯，但這是我們自己做的，也很令人激動(dòng)是不是，主要看 get 和 put 方法，其中的 get 方法留了一個(gè)后門(mén)，即所有的從緩存查詢(xún)返回的對象都將其 password 字段設置為一個(gè)特殊的值，這樣我們等下就能演示“我們的緩存確實(shí)在起作用！”了。

這還不夠，spring 還不知道我們寫(xiě)了這些東西，需要通過(guò) spring*.xml 配置文件告訴它

 <cache:annotation-driven /> 

 <bean id="cacheManager" class="com.rollenholt.spring.cache.MyCacheManager">
     <property name="caches"> 
       <set> 
         <bean 
           class="com.rollenholt.spring.cache.MyCache"
           p:name="accountCache" /> 
       </set> 
     </property> 
   </bean> 
   

接下來(lái)我們來(lái)編寫(xiě)測試代碼：

Account account = accountService.getAccountByName("someone"); 
logger.info("passwd={}", account.getPassword()); 
account = accountService.getAccountByName("someone"); 
logger.info("passwd={}", account.getPassword()); 

上面的測試代碼主要是先調用 getAccountByName 進(jìn)行一次查詢(xún)，這會(huì )調用數據庫查詢(xún)，然后緩存到 mycache 中，然后我打印密碼，應該是空的；下面我再次查詢(xún) someone 的賬號，這個(gè)時(shí)候會(huì )從 mycache 中返回緩存的實(shí)例，記得上面的后門(mén)么？我們修改了密碼，所以這個(gè)時(shí)候打印的密碼應該是一個(gè)特殊的值

注意和限制

基于 proxy 的 spring aop 帶來(lái)的內部調用問(wèn)題

上面介紹過(guò) spring cache 的原理，即它是基于動(dòng)態(tài)生成的 proxy 代理機制來(lái)對方法的調用進(jìn)行切面，這里關(guān)鍵點(diǎn)是對象的引用問(wèn)題.

如果對象的方法是內部調用（即 this 引用）而不是外部引用，則會(huì )導致 proxy 失效，那么我們的切面就失效，也就是說(shuō)上面定義的各種注釋包括 @Cacheable、@CachePut 和 @CacheEvict 都會(huì )失效，我們來(lái)演示一下。

public Account getAccountByName2(String accountName) { 
   return this.getAccountByName(accountName); 
 } 

 @Cacheable(value="accountCache")// 使用了一個(gè)緩存名叫 accountCache 
 public Account getAccountByName(String accountName) { 
   // 方法內部實(shí)現不考慮緩存邏輯，直接實(shí)現業(yè)務(wù)
   return getFromDB(accountName); 
 }
 

上面我們定義了一個(gè)新的方法 getAccountByName2，其自身調用了 getAccountByName 方法，這個(gè)時(shí)候，發(fā)生的是內部調用（this），所以沒(méi)有走 proxy，導致 spring cache 失效

要避免這個(gè)問(wèn)題，就是要避免對緩存方法的內部調用，或者避免使用基于 proxy 的 AOP 模式，可以使用基于 aspectJ 的 AOP 模式來(lái)解決這個(gè)問(wèn)題。

@CacheEvict 的可靠性問(wèn)題

我們看到，@CacheEvict 注釋有一個(gè)屬性 beforeInvocation，缺省為 false，即缺省情況下，都是在實(shí)際的方法執行完成后，才對緩存進(jìn)行清空操作。期間如果執行方法出現異常，則會(huì )導致緩存清空不被執行。我們演示一下

// 清空 accountCache 緩存
 @CacheEvict(value="accountCache",allEntries=true)
 public void reload() { 
   throw new RuntimeException(); 
 }
 

我們的測試代碼如下：

   accountService.getAccountByName("someone"); 
   accountService.getAccountByName("someone"); 
   try { 
     accountService.reload(); 
   } catch (Exception e) { 
    //...
   } 
   accountService.getAccountByName("someone"); 
   

注意上面的代碼，我們在 reload 的時(shí)候拋出了運行期異常，這會(huì )導致清空緩存失敗。上面的測試代碼先查詢(xún)了兩次，然后 reload，然后再查詢(xún)一次，結果應該是只有第一次查詢(xún)走了數據庫，其他兩次查詢(xún)都從緩存，第三次也走緩存因為 reload 失敗了。

那么我們如何避免這個(gè)問(wèn)題呢？我們可以用 @CacheEvict 注釋提供的 beforeInvocation 屬性，將其設置為 true，這樣，在方法執行前我們的緩存就被清空了?？梢源_保緩存被清空。

非 public 方法問(wèn)題

和內部調用問(wèn)題類(lèi)似，非 public 方法如果想實(shí)現基于注釋的緩存，必須采用基于 AspectJ 的 AOP 機制

Dummy CacheManager 的配置和作用

有的時(shí)候，我們在代碼遷移、調試或者部署的時(shí)候，恰好沒(méi)有 cache 容器，比如 memcache 還不具備條件，h2db 還沒(méi)有裝好等，如果這個(gè)時(shí)候你想調試代碼，豈不是要瘋掉？這里有一個(gè)辦法，在不具備緩存條件的時(shí)候，在不改代碼的情況下，禁用緩存。

方法就是修改 spring*.xml 配置文件，設置一個(gè)找不到緩存就不做任何操作的標志位，如下

   <cache:annotation-driven /> 
 
   <bean id="simpleCacheManager" class="org.springframework.cache.support.SimpleCacheManager"> 
     <property name="caches"> 
       <set> 
         <bean 
           class="org.springframework.cache.concurrent.ConcurrentMapCacheFactoryBean"
           p:name="default" /> 
       </set> 
     </property> 
   </bean> 

   <bean id="cacheManager" class="org.springframework.cache.support.CompositeCacheManager">
     <property name="cacheManagers"> 
       <list> 
         <ref bean="simpleCacheManager" /> 
       </list> 
     </property> 
     <property name="fallbackToNoOpCache" value="true" /> 
   </bean> 

注意以前的 cacheManager 變?yōu)榱?simpleCacheManager，且沒(méi)有配置 accountCache 實(shí)例，后面的 cacheManager 的實(shí)例是一個(gè) CompositeCacheManager，他利用了前面的 simpleCacheManager 進(jìn)行查詢(xún)，如果查詢(xún)不到，則根據標志位 fallbackToNoOpCache 來(lái)判斷是否不做任何緩存操作。

使用 guava cache

<bean id="cacheManager" class="org.springframework.cache.guava.GuavaCacheManager">
    <property name="cacheSpecification" value="concurrencyLevel=4,expireAfterAccess=100s,expireAfterWrite=100s" />
    <property name="cacheNames">
        <list>
            <value>dictTableCache</value>
        </list>
    </property>
</bean>