Ehcache使用用例

 

Ehcache使用用例（一）

Singleton创建方式

Java代码

//Ehcache1.2版本之后，都可以使用singleton（工厂创建方法）去创建一个singleton的CacheManager实例。

CacheManager.create();
String[] cacheNames = CacheManager.getInstance().getCacheNames();

//使用默认配置创建CacheManager

CacheManager manager = new CacheManager();
String[] cacheNames = manager.getCacheNames();

//使用配置文件创建指定的CacheManager

CacheManager manager1 = new CacheManager(“src/config/ehcache1.xml”);
CacheManager manager2 = new CacheManager(“src/config/ehcache2.xml”);
String[] cacheNamesForManager1 = manager1.getCacheNames();
String[] cacheNamesForManager2 = manager2.getCacheNames();

配置文件加载方式

Java代码

CacheManager manager = new CacheManager();//会在classpath路径下找ehcache.xml配置文件。

CacheManager manager = new CacheManager(“src/config.ehcache.xml”); //也可以根据相对文件路径来加载配置文件.

//通过URL加载

URL url = getClass().getResource(“/anotherconfigurationname.xml”);
CacheManager manager = new CacheManager(url);

//通过流加载

InputSream fis = new FileInputStream(new File(“src/config/ehcache.xml”).getAbsolutePath());
Try {
CacheManager manager = new CacheManager(fis);
} finally {
Fis.close();
}

编码实现添加和缓存

Java代码

//Ehcache中不仅可以用配置文件来配置缓存，而在代码中也可以实现同样的功能。

CacheManager singletonManager = CacheManager.create();
Cache memoryOnlyCache = new Cache(“testCache”, 50000, false, false, 8, 2);
Cache test = singletonManager.getCache(“testCache”);

//删除只需要调用
singletonManager.removeCache(“testCache”);

Shotdown CacheManager

在使用完Ehcache后，必须要shutdown缓存。Ehcache中有自己的关闭机制，不过最好在你的代码中显示调用CacheManager.getInstance().shutdown();

Ehcache使用实例（二）

Cache使用
l 得到一个Cache引用

获得一个sampleCache1的引用，从官方下载ehcache.xml，在ehcache.xml中已经有配置好的缓存，大家直接使用就可以，或是做测试，如果说真正使用的时候，最后自己手动配置一个比较好。

Java代码

Cache cache = manager.getCache(“sampleCache1”);

l 使用Cache

Put一个Element到cache中

Java代码

Cache cache = manager.getCache(“sampleCache1”);
Element element = new Element(“key1”,”value1”);
cache.put(element);

update一个element时，只要在构造element时将相同的key传入，在调用cache.put(element)，这是Ehcache会根据key到缓存中找到对应的element并做更新。

Java代码

Cache cache = manager.getCache(“sampleCache1”)；
Cache.put(new Element(“key1”, “value1”));
//更新element
Cache.put(new Element(“key1”, “value2”));

根据key取得对应element的序列化value值

Java代码

Cache cache = manager.getCache(“sampleCache1”);
Element element = cache.get(“key1”);
Serializable value = element.getValue();

根据key取得对应element的非序列化value值

Java代码

Cache cache = manager.getcache(“samplecache1”);
Element element = cache.get(“key1”);
Ojbect value = element.getObjectValue();

从cache中移除key对应的element

Java代码

Cache cache = manager.getCache(“sampleCache”);
Element element = new Element(“key1”, “value1”);
Cache.reomve(“key1”);

l 磁盘持久化

SampleCache1的配置是支持磁盘持久化的。如果想要保证element即时的被输出到磁盘，可以调用cache.flush();

Java代码

Cache cache = manager.getcache(“samplecache1”);
Cache.flush();

l Cache Sizes

获得当前cache中的element数量。

Java代码

Cache cache = manager.getCache(“sampleCache1”);
Int elementsInMemory = cache.getSize();

获得当前MemoryStore中的element数量。

Java代码

Cache cache = manager.getCache(“sampleCache1”);
long elementsInMemory = cache.getMemoryStoreSize();

获得当前DiskStore中element数量。

Java代码

Cache cache = manager.getCache(“sampleCache1”);
long elementsInMemory = cache.getDiskStoreSize();

l Cache Hits and Misses

所谓的hits就是缓存访问次数，而misses就是缓存中每个element的丢失次数。这些参数对优化缓存配置有很大的帮助。

获得缓存中请求的element被找到的次数。

Java代码

Cache cache = manager.getCache(“sampleCache1”);
Int hits = cache.getHitCount();

获得请求的element在MemoryStore中被找到的次数。

Java代码

Cache cache = manager.getCache(“sampleCache1”);
Int hits = cache.getMemoryStoreHitCount();

获得请求的element在DiskStore中被找到的次数。

Java代码

Cache cache = manager.getCache(“sampleCache1”);
Int hits = cache.getDiskStoreHitCount();

获得请求的element在MemoryStore中没有被找到的次数。

Java代码

Cache cache = manager.getCache(“sampleCache1”);
Int hits = cache.getMissCountNotFound();

获得请求的element在MemoryStore中没有被找到的次数。

Java代码

Cache cache = manager.getCache(“sampleCache1”);
Int hits = cache.getMissCountNotFound();

获得缓存中失效element没有被找到的次数。

Java代码

Cache cache = manager.getcache(“samplecache1”);
Int hits = cache.getMissCountExpired();

创建一个默认配置cache
manager.addCache(String cachename);这个方法可以说是Ehcache很灵活的体现，通常我们想要添加一个新的cache到CacheManager中时，应该调用manager.addCache(Cache cache);可以看到入参是一个Cache类型对象，而前面那段代码，Ehcache会自动使用默认配置创建一个名字为输出参数的cache供使用，是不是很方面呢。

使用自定义参数创建一个cache
Ehcache允许通过编码的方式创建一个自定义Cache，也就是调用构造方法。

Java代码

PublicCache(String name, int maxElementsInMemory, MemoryStoreEvictionPolicymemoryStoreEvictionPolicy, Boolean overflowToDisk, Boolean eternal,long timeToLiveSeconds, long timeToIdleSeconds, Boolean isdkPersistent,long diskExpiryThreadIntervalSeconds) {}

//以上就是Cache的构造函数。
CacheManager manager = CacheManager.create();
Cache cache = new Cache(“test”, maxElements, MemoryStoreEvictionPolicy.LFU, true, false, 60, 30, false, 0);
Manager.addCache(testCache);

以上代码是创建一个缓存添加到cachemanager中，缓存名字为test，内存驱逐策略是LFU，允许输出到磁盘，element不是永久有效的，element最大存活时间是60秒，element最大闲置时间30秒，不会持久化到磁盘，失效element清理线程运行时间间隔是0秒。

Ehcache使用实例（三）

   注: 跟笔者其它研究源码的博客一样, Ehcache系列也是基于一个例子来debug地跟踪, 例子详见Ehcache(一): Spring + Ehcache开场白中的附件.如果没有例子作参照,阅读过程中可能有些摸不着头绪.
------------------------------
  
Ehcache(二): 从EhCacheManagerFactoryBean说起中,我们看到一个EhCacheManagerFactoryBean的创建并由此启用一个CacheManager实例.结合ehcache的配置文件和CacheManager的名字,不难猜出这个实例是管理Cache的.那么这个CacheManager实例用在了哪?配置文件中的org.springframework.cache.ehcache.EhCacheFactoryBean实例的创建中.那么又用这个CacheManager实例做了些什么呢?这得看EhCacheFactoryBean类的afterPropertiesSet方法.

    方法afterPropertiesSet中有这么一段代码:        

Java代码

if (this.cacheManager.cacheExists(this.cacheName)) {
            if (logger.isDebugEnabled()) {
                 logger.debug("Using existing EHCache cache region '" + this.cacheName + "'");
             }
            this.cache = this.cacheManager.getEhcache(this.cacheName);
         }

    也就是说, cacheManager会检查下配置的cacheName(即,ehcache.xml文件中名为com.rmn190.MethodCache的cache)对应的cache是否已经存在. 如果存在,就直接get出来.

    这只是get了下cacheManager中已有的cache,那么那个已有的cache是怎么创建出来的? 也就是本例中的名为com.rmn190.MethodCache的cache的cache是何时/如何创建的?

    一番顺藤模瓜后, 找到了ConfigurationHelper类中的createCache(CacheConfiguration cacheConfiguration)方法. 这里真真切切地看到了"new Cache"的调用.

    上面我们深层次地体会到Cache实例的创建并通过cacheManager给get了出来,get出来后,在Spring中就set给了例子中MethodCacheInterceptor类属性cache. 不过这里又有问题了:MethodCacheInterceptor类属性cache是一net.sf.ehcache.Cache类型的,但Spring配置文件中set来的实例是一个org.springframework.cache.ehcache.EhCacheFactoryBean,类型不匹配的,EhCacheFactoryBean与Cache有继承或实现关系? 看源码,没有发现. 那Spring又是怎么解决这个类型不匹配问题的?

    我们在EhCacheFactoryBean类实现的接口FactoryBean上找到了答案: getObject和getObjectType. 通过FactoryBean接口定义两个方法给出的信息,Spring就很自然而流畅地解决了类型匹配问题.