Ehcache相关介绍

参考：
https://www.cnblogs.com/wangwiz/articles/7691381.html
https://blog.csdn.net/vbirdbest/article/details/72763048

项目中一般使用到多级缓存，就是多层缓存（二级缓存的比较多），目的都是为了减轻数据库压力。查找数据时，先在一级缓存中查找，找不到去二级，以此类推……，最后再查询数据库。

一般二级缓存可以是这样的(将Ehcache（一级）与Redis（二级）配合搭建的二级缓存)：

先查Ehcache，如果不存在，再查Redis，如果还不存在，再查数据库。（如果查到数据了，需要更新之前的相关缓存）

注：ehcache 是一个纯Java的进程内缓存框架，直接在jvm虚拟机中缓存数据，是Hibernate中默认的CacheProvider。缓存数据有两级：内存和磁盘，因此无需担心容量和数据安全问题。缓存数据会在虚拟机重启的过程中写入磁盘（即JVM关闭会自动调用shutdown()函数，ehcache需要flush或shutdown后才会持久化到磁盘）。不建议使用它的分布式缓存方式（缓存共享复杂，维护不方便）。

使用步骤：

一、在pom.xml中引入依赖

<dependency>
<groupId>net.sf.ehcache</groupId>
<artifactId>ehcache</artifactId>
<version>2.10.5</version>

</dependency>

二、在classpath根目录下创建一个配置文件 ehcache.xml，内容参考：

<?xml version="1.0" encoding="UTF-8"?>
<ehcache updateCheck="false" dynamicConfig="false">

<diskStore path="java.io.tmpdir/ehcache"/>


<defaultCache
maxEntriesLocalHeap="10000"
eternal="false"
timeToIdleSeconds="120"
timeToLiveSeconds="120"
maxEntriesLocalDisk="10000000"
diskExpiryThreadIntervalSeconds="120"
memoryStoreEvictionPolicy="LRU">
</defaultCache>


<cache name="HelloWorldCache"
maxElementsInMemory="1000"
eternal="false"
timeToIdleSeconds="5"
timeToLiveSeconds="5"
overflowToDisk="false"

memoryStoreEvictionPolicy="LRU"/>

</ehcache>

<diskStore>元素：指定一个文件目录，当EHCache把数据写到硬盘上时，将把数据写到这个文件目录下。下面的参数这样解释：
user.home – 用户主目录
user.dir – 用户当前工作目录
java.io.tmpdir – 默认临时文件路径

<defaultCache>元素：设定缓存的一些默认策略。

<cache>元素：设定具体的命名缓存的数据策略。
<cache>元素的属性
name：缓存名称。通常为缓存对象的类名（非严格标准）。
maxElementsInMemory：设置基于内存的缓存可存放对象的最大数目。
maxElementsOnDisk：设置基于硬盘的缓存可存放对象的最大数目。
eternal：如果为true，表示对象永远不会过期，此时会忽略timeToIdleSeconds和timeToLiveSeconds属性，默认为false;
timeToIdleSeconds：设定允许对象处于空闲状态的最长时间，以秒为单位。当对象自从最近一次被访问后，如果处于空闲状态的时间超过了timeToIdleSeconds属性值，这个对象就会过期。当对象过期，EHCache将把它从缓存中清空。只有当eternal属性为false，该属性才有效。如果该属性值为0，则表示对象可以无限期地处于空闲状态。
timeToLiveSeconds：设定对象允许存在于缓存中的最长时间，以秒为单位。当对象自从被存放到缓存中后，如果处于缓存中的时间超过了 timeToLiveSeconds属性值，这个对象就会过期。当对象过期，EHCache将把它从缓存中清除。只有当eternal属性为false，该属性才有效。如果该属性值为0，则表示对象可以无限期地存在于缓存中。timeToLiveSeconds必须大于timeToIdleSeconds属性，才有意义。
overflowToDisk：如果为true,表示当基于内存的缓存中的对象数目达到了maxElementsInMemory界限后，会把溢出出的对象写到基于硬盘的缓存中。
diskPersistent 是否持久化磁盘缓存, 设置成true表示缓存虚拟机重启期数据磁盘存储是否在虚拟机重启后持续存在。
diskExpiryThreadIntervalSeconds：磁盘失效线程运行时间间隔，默认是120秒。
memoryStoreEvictionPolicy：缓存对象清除策略。有三种：
1 FIFO ，first in first out ，这个是大家最熟的，先进先出。
2 LFU ， Less Frequently Used ，就是上面例子中使用的策略，直白一点就是讲一直以来最少被使用的。如上面所讲，缓存的元素有一个hit 属性，hit 值最小的将会被清出缓存。
3 LRU ，Least Recently Used ，最近最少使用的，缓存的元素有一个时间戳，当缓存容量满了，而又需要腾出地方来缓存新的元素的时候，那么现有缓存元素中时间戳离当前时间最远的元素将被清出缓存。(一般使用这个)

三、JAVA中使用EHCache：

package com.xiaomi.cashpay.userrights.util;

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

import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * @description: 缓存工具
 * @create: 2018-07-11 14:11
 **/
public class CacheUtil {

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

  // 使用默认classpath目录下配置文件创建CacheManager
  private static CacheManager manager = CacheManager.create();

  // 通过manager可以生成指定名称的Cache对象
  private static Cache defaultCache = manager.getCache("XXXX");

  //往默认cache中添加元素
  public static Boolean putInDefaultCache(String key, Object value) {
    if (StringUtils.isBlank(key) || null == value) {
      return false;
    }
    Element element = new Element(key, value);
    try {
      defaultCache.put(element);
    } catch (Exception e) {
      logger.error("往默认的cache中添加元素" + key + "失败：", e);
      return false;
    }
    return true;
  }

  //往指定cache中添加元素
  public static Boolean putInCache(String key, Object value, String cacheName) {
    if (StringUtils.isBlank(key) || null == value || StringUtils.isBlank(cacheName)) {
      return false;
    }
    Element element = new Element(key, value);
    try {
      Cache cache = manager.getCache(cacheName);
      cache.put(element);
    } catch (Exception e) {
      logger.error("往" + cacheName + "的cache中添加元素" + key + "失败：", e);
      return false;
    }
    return true;
  }

  //从默认cache中获取元素数据
  public static <T> T getDataFromDefaultCache(String key, Class<T> valueType) {
    if (StringUtils.isBlank(key) || null == valueType) {
      return null;
    }
    try {
      Element element = defaultCache.get(key);
      if (null == element) {
        return null;
      }
      Object value = element.getObjectValue();
      return (T) value;
    } catch (Exception e) {
      logger.error("从默认cache中获取元素" + key + "数据失败：", e);
      return null;
    }
  }

  //从指定cache中获取元素数据
  public static <T> T getDataFromCache(String key, Class<T> valueType, String cacheName) {
    if (StringUtils.isBlank(key) || null == valueType || StringUtils.isBlank(cacheName)) {
      return null;
    }
    try {
      Cache cache = manager.getCache(cacheName);
      Element element = cache.get(key);
      if (null == element) {
        return null;
      }
      Object value = element.getObjectValue();
      return (T) value;
    } catch (Exception e) {
      logger.error("从" + cacheName + "的cache中获取元素" + key + "数据失败：", e);
      return null;
    }
  }

  //从默认Cache中移除一个元素
  public static Boolean removeFromDefaultCache(String key) {
    if (StringUtils.isBlank(key)) {
      return false;
    }
    boolean removeBool = true;
    try {
      removeBool = defaultCache.remove(key);
    } catch (Exception e) {
      logger.error("从默认的cache中删除元素" + key + "数据失败：", e);
      removeBool = false;
    }
    return removeBool;
  }

  //从指定Cache中移除一个元素
  public static Boolean removeFromCache(String key, String cacheName) {
    if (StringUtils.isBlank(key) || StringUtils.isBlank(cacheName)) {
      return false;
    }
    boolean removeBool = true;
    try {
      Cache cache = manager.getCache(cacheName);
      removeBool = cache.remove(key);
    } catch (Exception e) {
      logger.error("从" + cacheName + "的cache中删除元素" + key + "数据失败：", e);
      removeBool = false;
    }
    return removeBool;
  }


}

创建一个工具类的好处是：以后还可以业务无感知的接入redis等其他缓存工具，不建议使用注解等方式。

相关推荐