Ehcache中核心類和方法

EhCache裡面有一個CacheManager型別，它負責管理cache。Cache裡面儲存著Element物件，Element必須是key-value對。Cache是實際物理實現的，在記憶體中或者磁碟。這些元件的邏輯表示就是下面即將要討論的類。他們的方法提供了可程式設計的訪問方式。

CacheManager

負責Cache的建立、訪問、移除。

CacheManager建立

CacheManager支援兩種建立模式：單例（Singleton mode）和例項（InstanceMode）。

在2.5之前的版本中，在同一個JVM中允許存在任意數量相同名字的CacheManager。每呼叫new CacheManager(...)一次，就會產生一個新的CacheManager例項，而不管已經存在多少個。呼叫CacheManager.create(...)，則返回的是已經存在的那個配置對應的單例CacheManager，如果不存在，則建立一個。

2.5之後的版本，不允許在同一個JVM記憶體在多個具有相同名字的CacheManager。建立非單例例項的CacheManager()建構函式可能會打破這一規則，但是會丟擲NPE異常。如果你的程式碼要在同一個JVM建立多個同名的例項，請使用靜態方法CacheManager.create()，總是返回對應名的CacheManager（如果已經存在），否則建立一個。

事實上，我們可以直接利用Spring中的EhCacheManagerFactoryBean[spring2.5.4]來幫我們完成CacheManager的建立，看看它的具體建立方式：

if (this.shared) {
			// Shared CacheManager singleton at the VM level.
			if (this.configLocation != null) {
				this.cacheManager = CacheManager.create(this.configLocation.getInputStream());
			}
			else {
				this.cacheManager = CacheManager.create();
			}
		}
		else {
			// Independent CacheManager instance (the default).
			if (this.configLocation != null) {
				this.cacheManager = new CacheManager(this.configLocation.getInputStream());
			}
			else {
				this.cacheManager = new CacheManager();
			}
		}
		if (this.cacheManagerName != null) {
			this.cacheManager.setName(this.cacheManagerName);
		}
 

EhCache2.5.2及其以上版本的建立方法歸納如下：

• CacheManager.newInstance(Configuration configuration) ：建立一個新的CacheManager 物件或者返回已經存在的對應配置中名字的CacheManager

• CacheManager.create()：建立一個新的預設配置的單例CacheManager ，或者返回一個已經存在的單例。
• CacheManager.create(Configuration configuration)，建立一個對應傳入配置檔案中名字的單例CacheManager，或者返回已經存在的單例CacheManager。
• new CacheManager(Configuration configuration)，建立一個新的CacheManager，或者如果對應配置的CacheManager已經存在或配置引數為空，丟擲異常。

在Instance Mode中，如果Cache均使用MemoryStore，則沒有什麼特別需要注意的。但是如果使用了DIskStore，那麼每個CacheManager必須具有不同的diskStore路徑。當一個新的CacheManager被建立的時候，需要檢查沒有別的CacheManager使用同樣的DiskStore路徑。如果有，就會丟擲異常CacheException。如果CacheManager是叢集中一部分，那麼其監聽埠必須唯一。

Singletonmode和Instance Mode可以混合使用，而不會產生衝突。

Ehcache

所有的cache都實現了介面Ehcache。每個cache都有名字和屬性，且包含Element。

Ehcache中的cache相當於其他快取系統中的一塊快取區域。

Element

Element是存放於cache中的原子單位。它有一個key、一個value以及關於訪問的記錄。Element被放進到cache或者從cache移除。他們也可能會由於過期被移除，這依賴於配置。

使用例項

下面給出了一個使用Ehcache的實際例子。

首先新建一個maven java工程，在pom.xml中新增Ehcache依賴。

    <!-- Ehcache -->
    <dependency>
        <groupId>net.sf.ehcache</groupId>
        <artifactId>ehcache</artifactId>
        <version>2.8.3</version>
    </dependency>

下面是java程式碼。程式碼實現的功能非常簡單，即建立CacheManager，往裡面存放一個Cache，然後往cache裡面存資料和取資料，目的是展示Ehcache的基本使用。

/**
 * XXX.com Inc.
 * Copyright (c) 2004-2014 All Rights Reserved.
 */
package com.test.encache;

import net.sf.ehcache.Cache;
import net.sf.ehcache.CacheManager;
import net.sf.ehcache.Element;

/**
 * 
 * @author XXX
 * @version $Id: EncacheTest.java, v 0.1 2014年8月8日 下午5:30:03 XXX Exp $
 */
public class EncacheTest {
    //一些配置引數
    //private final static String configFileName      = "ehcache.xml";
    //private final static int    maxEntriesLocalHeap = 1000;
    private static CacheManager cacheManager;
    static String               cacheName = "cache1";

    public static void main(String[] args) {
        ehcacheSetUp();

        ehcacheUse();
    }

    private static void ehcacheSetUp() {

        cacheManager = CacheManager.create();

        //CacheConfiguration configuration = new CacheConfiguration(configFileName,
        //    maxEntriesLocalHeap);

        //Cache cache = new Cache(configuration);
        cacheManager.addCache(cacheName);

    }

    private static void ehcacheUse() {
        Cache cache1 = cacheManager.getCache(cacheName);
        String key = "key1";
        String value = "value1";

        writeSomeData(cache1, key, value);

        Element element = readSomeData(cache1, key, value);

        System.out.println(element);
    }

    private static void writeSomeData(Cache cache, String key, String value) {
        cache.put(new Element(key, value));
    }

    private static Element readSomeData(Cache cache, String key, String value) {
        return cache.get(key);
    }
}

程式輸出：

SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
[ key = key1, value=value1, version=1, hitCount=1, CreationTime = 1411807398768, LastAccessTime = 1411807398771 ]

其中的錯誤資訊是因為沒有配置日誌相關的SLF4J所致。

下面我們要配置日誌。首先在pom.xml中新增依賴：

    <!-- SLF4J -->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-log4j12</artifactId>
        <version>1.6.1</version>
	</dependency>

然後建立log4j的配置檔案log4j.properties：

# Root logger option
log4j.rootLogger=INFO, file, stdout
log4j.logger.com.test.encache.EncacheTest=INFO,file
 
# Direct log messages to a log file
log4j.appender.file=org.apache.log4j.DailyRollingFileAppender
log4j.appender.file.File=C:\\logging.log
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n
 
# Direct log messages to stdout
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n

並且將這個檔案放置到工程的classpath下，在這裡我建立的是用Eclipse建立的maven工程，將其放置在工程主目錄下的\target\classes資料夾下。
然後在程式碼中新增logger的初始化程式碼：

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

然後就可以使用了：

logger.info("Setup ehcache");

輸出：

2014-09-27 17:22:45 INFO  EncacheTest:35 - Setup ehcache
2014-09-27 17:22:45 WARN  ConfigurationFactory:136 - No configuration found. Configuring ehcache from ehcache-failsafe.xml  found in the classpath: jar:file:/D:/MavenRepo/net/sf/ehcache/ehcache/2.8.3/ehcache-2.8.3.jar!/ehcache-failsafe.xml
2014-09-27 17:22:46 WARN  DiskStorePathManager:162 - diskStorePath 'C:\Users\xxxx\AppData\Local\Temp' is already used by an existing CacheManager either in the same VM or in a different process.
The diskStore path for this CacheManager will be set to C:\Users\xxxx\AppData\Local\Temp\ehcache_auto_created7989392067865891865diskstore.
To avoid this warning consider using the CacheManager factory methods to create a singleton CacheManager or specifying a separate ehcache configuration (ehcache.xml) for each CacheManager instance.
[ key = key1, value=value1, version=1, hitCount=1, CreationTime = 1411809766273, LastAccessTime = 1411809766276 ]

參考資料：