ehcache入门

一. ehcache是什么

Ehcache 是现在最流行的纯Java开源缓存框架，配置简单、结构清晰、功能强大

注1：本章介绍的是2.X版本，3.x的版本和2.x的版本API差异比较大

二. 为什么需要缓存
拉高程序的性能

关系型数据库：数据与数据之间存在关系（联系）的数据库 mysql/Oracle、sqlserver
非关系型数据库：数据与数据之间是不存在关系的，key-value
1、基于文件存储的数据库：ehcache
2、基于内存存储的数据库：redis、memcache
3、基于文档存储的数据库：mongodb

三. 什么样的数据需要缓存
很少被修改或根本不改的数据 数据字典

业务场景比如：耗时较高的统计分析sql、电话账单查询sql等

四. ehcache的特点

1. 够快
   Ehcache的发行有一段时长了，经过几年的努力和不计其数的性能测试，Ehcache终被设计于large, high concurrency systems.
2. 够简单
   开发者提供的接口非常简单明了，从Ehcache的搭建到运用运行仅仅需要的是你宝贵的几分钟。其实很多开发者都不知道自己用在用Ehcache，Ehcache被广泛的运用于其他的开源项目
   3.够袖珍
   关于这点的特性，官方给了一个很可爱的名字small foot print ，一般Ehcache的发布版本不会到2M，V 2.2.3 才 668KB。
3. 够轻量
   核心程序仅仅依赖slf4j这一个包，没有之一！
4. 好扩展
   Ehcache提供了对大数据的内存和硬盘的存储，最近版本允许多实例、保存对象高灵活性、提供LRU、LFU、FIFO淘汰算法，基础属性支持热配置、支持的插件多
5. 监听器
   缓存管理器监听器 （CacheManagerListener）和 缓存监听器（CacheEvenListener）,做一些统计或数据一致性广播挺好用的
6. 分布式缓存
   从Ehcache 1.2开始，支持高性能的分布式缓存，兼具灵活性和扩展性

下图是ehcache缓存的原理

五.ehcache的使用

1. 导入相关依赖
   
   net.sf.ehcache
   ehcache
   2.10.0
   

2. 创建配置文件 ehcache.xml

<?xml version="1.0" encoding="UTF-8"?>

<!--defaultCache：默认的管理策略-->
<!--eternal：设定缓存的elements是否永远不过期。如果为true，则缓存的数据始终有效，如果为false那么还要根据timeToIdleSeconds，timeToLiveSeconds判断-->
<!--maxElementsInMemory：在内存中缓存的element的最大数目-->
<!--overflowToDisk：如果内存中数据超过内存限制，是否要缓存到磁盘上-->
<!--diskPersistent：是否在磁盘上持久化。指重启jvm后，数据是否有效。默认为false-->
<!--timeToIdleSeconds：对象空闲时间(单位：秒)，指对象在多长时间没有被访问就会失效。只对eternal为false的有效。默认值0，表示一直可以访问-->
<!--timeToLiveSeconds：对象存活时间(单位：秒)，指对象从创建到失效所需要的时间。只对eternal为false的有效。默认值0，表示一直可以访问-->
<!--memoryStoreEvictionPolicy：缓存的3 种清空策略-->
<!--FIFO：first in first out (先进先出)-->
<!--LFU：Less Frequently Used (最少使用).意思是一直以来最少被使用的。缓存的元素有一个hit 属性，hit 值最小的将会被清出缓存-->
<!--LRU：Least Recently Used(最近最少使用). (ehcache 默认值).缓存的元素有一个时间戳，当缓存容量满了，而又需要腾出地方来缓存新的元素的时候，那么现有缓存元素中时间戳离当前时间最远的元素将被清出缓存-->
<defaultCache eternal="false" maxElementsInMemory="1000" overflowToDisk="false" diskPersistent="false"
              timeToIdleSeconds="0" timeToLiveSeconds="600" memoryStoreEvictionPolicy="LRU"/>


<!--name： Cache的名称，必须是唯一的(ehcache会把这个cache放到HashMap里)-->
<cache name="testEhcache" eternal="false" maxElementsInMemory="100"
       overflowToDisk="false" diskPersistent="false" timeToIdleSeconds="0"
       timeToLiveSeconds="300" memoryStoreEvictionPolicy="LRU"/>

3. 核心接口
   CacheManager：缓存管理器
   Cache：缓存对象，缓存管理器内可以放置若干cache，存放数据的实质，所有cache都实现了Ehcache接口
   Element：单条缓存数据的组成单位
   

4. 测试类

package com.zking.hibernate.dao;

import static org.junit.Assert.*;

import org.hibernate.Session;
import org.hibernate.Transaction;
import org.hibernate.query.Query;
import org.junit.AfterClass;
import org.junit.Test;

import com.zking.hibernate.entity.User;
import com.zking.hibernate.util.EhcacheUtil;
import com.zking.hibernate.util.HibernateUtils;

public class EhcacheTest {

@Test
public void test() {
	get();	
}
public void get() {
	 // 1. 创建缓存管理器
            InputStream is = EhcacheUtil.class.getResourceAsStream("/ehcache.xml");
            CacheManager cacheManager = CacheManager.create(is);

            // 2. 获取缓存对象
            Cache cache = cacheManager.getCache("testEhcache");

            // 3. 创建元素
            Element element = new Element("key1", "value1");

            // 4. 将元素添加到缓存
            cache.put(element);

            // 5. 获取缓存
            Element value = cache.get("key1");
            System.out.println(value);
            System.out.println(value.getObjectValue());

            // 6. 删除元素
            cache.remove("key1");

            // 7. 刷新缓存
            cache.flush();

            // 8. 关闭缓存管理器
            cacheManager.shutdown();
}

}
下面是自己写的一个ehcache的工具类，可供参考和使用。

package com.hibernate.util;
 
import net.sf.ehcache.Cache;
import net.sf.ehcache.CacheManager;
import net.sf.ehcache.Element;
 
import java.io.InputStream;
 
public class EhcacheUtil {
 
    private static CacheManager cacheManager;
 
    static {
        try {
            InputStream is = EhcacheUtil.class.getResourceAsStream("/ehcache.xml");
            cacheManager = CacheManager.create(is);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }
 
    private EhcacheUtil() {
    }
 
    public static void put(String cacheName, Object key, Object value) {
        Cache cache = cacheManager.getCache(cacheName);
        if (null == cache) {
            //以默认配置添加一个名叫cacheName的Cache
            cacheManager.addCache(cacheName);
            cache = cacheManager.getCache(cacheName);
        }
        cache.put(new Element(key, value));
    }
 
 
    public static Object get(String cacheName, Object key) {
        Cache cache = cacheManager.getCache(cacheName);
        Element element = cache.get(key);
        return null == element ? null : element.getValue();
    }
 
    public static void remove(String cacheName, Object key) {
        Cache cache = cacheManager.getCache(cacheName);
        cache.remove(key);
    }
}