包含关键字 jeesite 的文章-1

Myth丶恋晨 2022-06-10 05:25 54阅读 0赞

### [关于Ehcache][Ehcache] ###

作者：  | 时间：January 14, 2015 | 分类： [框架相关][Link 1] | 评论： [0 评论][Ehcache]

## Ehcache简介 ##

[Ehcache][Ehcache 1]是一个纯Java的进程内缓存框架,是Hibernate中默认的CacheProvider,主要面向通用缓存,Java EE和轻量级容器。主要特性有：

1.  简单快速
2.  多种缓存策略,支持LRU、LFU和FIFO。
3.  支持内存和硬盘作为缓存存储
4.  缓存数据会在虚拟机重启的过程中写入磁盘
5.  具有缓存和缓存管理器的侦听接口
6.  可以通过RMI、可插入API等方式进行分布式缓存
7.  可与spring、Hibernate、shiro等框架组件进行整合

## 项目中Ehcache的配置 ##

Jeesite中Ehcache的配置文件主要在资源目录下的cache文件夹中，默认使用的是`ehcache-local.xml`和`ehcahce-hibernate-xml`，前者是ehcache的配置文件，后者是针对hibernate的配置文件。下面先看一下`ehcache-local.xml`的内容：

其中，syscache和cmscache分别是针对系统管理模块和内容管理模块的缓存。SimplePageCachingFilter是页面缓存。各缓存项的含义如下：

*  diskStore path: 缓存保存到磁盘的位置
 *  maxElementsInMemory：缓存中允许创建的最大对象数
 *  eternal：缓存中对象是否为永久的，如果是，超时设置将被忽略，对象从不过期。
 *  timeToIdleSeconds：缓存数据的钝化时间，也就是在一个元素消亡之前，两次访问时间的最大时间间隔值，这只能在元素不是永久驻留时有效。
 *  timeToLiveSeconds：缓存数据的生存时间，也就是一个元素从构建到消亡的最大时间间隔值，这只能在元素不是永久驻留时有效。
 *  overflowToDisk：内存不足时，是否启用磁盘缓存。

而`ehcahce-hibernate-xml`则是针对sys模块中的实体类通过hibernate来缓存，包括User、Role、Menu、Office、Area、Dict以及userList、MenuList、roleList等实体类。下面列举几个配置，其他的以此类推：

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>&lt;cache name="com.thinkgem.jeesite.modules.sys.entity.Area" maxEntriesLocalHeap="100" eternal="false" overflowToDisk="true" maxEntriesLocalDisk="100000" /&gt;</code> 
     </div> 
     <div> 
      <code>&lt;cache name="com.thinkgem.jeesite.modules.sys.entity.Area.childList" maxEntriesLocalHeap="100" eternal="false" overflowToDisk="true" maxEntriesLocalDisk="100000" /&gt;</code> 
     </div> 
     <div> 
      <code>&lt;cache name="com.thinkgem.jeesite.modules.sys.entity.Area.officeList" maxEntriesLocalHeap="100" eternal="false" overflowToDisk="true" maxEntriesLocalDisk="100000" /&gt;</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

对于页面缓存来说，还要在Servlet容器的`web.xml`这个配置文件中配置：

这里只针对站点首页和html静态页面做了缓存，对应的缓存类是common.filter包下的PageCacheingFilter类。下面就看一下项目中的缓存工具类

## 项目中的ehcache缓存代码。 ##

首先要针对页面缓存作一下说明，页面缓存主要用Filter过滤器对请求的url进行过滤，如果该url在缓存中出现。那么页面数据就从缓存对象中获取，并以gzip压缩后返回。其速度是没有压缩缓存时速度的3-5倍，效率相当之高！其中页面缓存的过滤器有CachingFilter，一般要扩展filter或是自定义Filter都继承该CachingFilter。CachingFilter功能可以对HTTP响应的内容进行缓存。这种方式缓存数据的粒度比较粗，例如缓存整张页面。EHCache使用SimplePageCachingFilter类实现Filter缓存。现在看一下Jeesite中的Filter：

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>public class PageCachingFilter extends SimplePageCachingFilter { </code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>@Override</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>protected CacheManager getCacheManager() { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>return CacheUtils.getCacheManager();</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>}&nbsp;&nbsp; </code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

这里的页面缓存过滤器继承了ehcache提供的SimplePageCachingFilter，通过自己写的缓存工具类CacheUtils来获得缓存管理器CacheManager，下面先介绍Ehcache的基本用法，然后对应分析一下CacheUtils类：

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div> 
    <div>
      11 
    </div> 
    <div>
      12 
    </div> 
    <div>
      13 
    </div> 
    <div>
      14 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>//获取缓存管理器</code> 
     </div> 
     <div> 
      <code>CacheManager cacheManager = CacheManager.create();</code> 
     </div> 
     <div> 
      <code>cacheManager = CacheManager.getInstance();</code> 
     </div> 
     <div> 
      <code>cacheManager = CacheManager.newInstance("/config/ehcache.xml");</code> 
     </div> 
     <div> 
      <code>//通过缓存管理器获取ehcache配置文件中的一个cache</code> 
     </div> 
     <div> 
      <code>Cache sample = cacheManager.getCache("sample");</code> 
     </div> 
     <div> 
      <code>//添加数据到缓存中</code> 
     </div> 
     <div> 
      <code>Element element = new Element("key", "val");</code> 
     </div> 
     <div> 
      <code>sample.put(element);</code> 
     </div> 
     <div> 
      <code>//获取缓存中的对象，注意添加到cache中对象要序列化 实现Serializable接口</code> 
     </div> 
     <div> 
      <code>Element result = sample.get("key");</code> 
     </div> 
     <div> 
      <code>// 删除缓存</code> 
     </div> 
     <div> 
      <code>sample.remove("key");</code> 
     </div> 
     <div> 
      <code>sample.removeAll();</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

CahceUtils类就是对这些Ehcache的基本缓存操作做了封装：

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div> 
    <div>
      11 
    </div> 
    <div>
      12 
    </div> 
    <div>
      13 
    </div> 
    <div>
      14 
    </div> 
    <div>
      15 
    </div> 
    <div>
      16 
    </div> 
    <div>
      17 
    </div> 
    <div>
      18 
    </div> 
    <div>
      19 
    </div> 
    <div>
      20 
    </div> 
    <div>
      21 
    </div> 
    <div>
      22 
    </div> 
    <div>
      23 
    </div> 
    <div>
      24 
    </div> 
    <div>
      25 
    </div> 
    <div>
      26 
    </div> 
    <div>
      27 
    </div> 
    <div>
      28 
    </div> 
    <div>
      29 
    </div> 
    <div>
      30 
    </div> 
    <div>
      31 
    </div> 
    <div>
      32 
    </div> 
    <div>
      33 
    </div> 
    <div>
      34 
    </div> 
    <div>
      35 
    </div> 
    <div>
      36 
    </div> 
    <div>
      37 
    </div> 
    <div>
      38 
    </div> 
    <div>
      39 
    </div> 
    <div>
      40 
    </div> 
    <div>
      41 
    </div> 
    <div>
      42 
    </div> 
    <div>
      43 
    </div> 
    <div>
      44 
    </div> 
    <div>
      45 
    </div> 
    <div>
      46 
    </div> 
    <div>
      47 
    </div> 
    <div>
      48 
    </div> 
    <div>
      49 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>public class CacheUtils { </code> 
     </div> 
     <div> 
      <code>//通过Spring来获取缓存管理器</code> 
     </div> 
     <div> 
      <code>private static CacheManager cacheManager = ((CacheManager)SpringContextHolder.getBean("cacheManager"));</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>//对应ehcache-local.xml配置的系统模块缓存</code> 
     </div> 
     <div> 
      <code>private static final String SYS_CACHE = "sysCache";</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>//以下是针对系统模块缓存的操作</code> 
     </div> 
     <div> 
      <code>public static Object get(String key) { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>return get(SYS_CACHE, key);</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
     <div> 
      <code>public static void put(String key, Object value) { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>put(SYS_CACHE, key, value);</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
     <div> 
      <code>public static void remove(String key) { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>remove(SYS_CACHE, key);</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
     <div> 
      <code>//封装Ehcache的get put remove操作</code> 
     </div> 
     <div> 
      <code>public static Object get(String cacheName, String key) { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>Element element = getCache(cacheName).get(key);</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>return element==null?null:element.getObjectValue();</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>public static void put(String cacheName, String key, Object value) { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>Element element = new Element(key, value);</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>getCache(cacheName).put(element);</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>public static void remove(String cacheName, String key) { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>getCache(cacheName).remove(key);</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>/**</code> 
     </div> 
     <div> 
      <code>&nbsp;</code> 
      <code>* 获得一个Cache，没有则创建一个。</code> 
     </div> 
     <div> 
      <code>&nbsp;</code> 
      <code>* @param cacheName</code> 
     </div> 
     <div> 
      <code>&nbsp;</code> 
      <code>* @return</code> 
     </div> 
     <div> 
      <code>&nbsp;</code> 
      <code>*/</code> 
     </div> 
     <div> 
      <code>private static Cache getCache(String cacheName){ </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>Cache cache = cacheManager.getCache(cacheName);</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>if (cache == null){ </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>cacheManager.addCache(cacheName);</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>cache = cacheManager.getCache(cacheName);</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>cache.getCacheConfiguration().setEternal(true);</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>return cache;</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>public static CacheManager getCacheManager() { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>return cacheManager;</code> 
     </div> 
     <div> 
      <code>}&nbsp;&nbsp; </code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

[Ehcache]: http://www.nohup.cc/article/73/
[Link 1]: http://www.nohup.cc/category/frame_related/
[Ehcache 1]: http://ehcache.org/