ehcache缓存实战

落日映苍穹つ 2022-09-21 05:40 67阅读 0赞

前面在介绍MyBatis二级缓存的时候简单的介绍了ehcache，以及ehcache如何配置为Mybatis的二级缓存等。这篇文章介绍ehcache在更为上层的应用。  
尽快使用ehcache的二级缓存可以优化Mybatis的查询效率，但这个有几个限制。

**1. 只能在【只有单表操作】的表上使用缓存**

不只是要保证这个表在整个系统中只有单表操作，而且和该表有关的全部操作必须全部在一个namespace下。

**2. 在可以保证查询远远大于insert,update,delete操作的情况下使用缓存**

这一点不需要多说，所有人都应该清楚。记住，这一点需要保证在1的前提下才可以！

在实际中其实应该避免使用二级缓存,mybatis下的二级缓存具有如下几点特点:

>*  缓存是以namespace为单位的，不同namespace下的操作互不影响。
    
    >*  insert,update,delete操作会清空所在namespace下的全部缓存。
    
    >*  通常使用MyBatis Generator生成的代码中，都是各个表独立的，每个表都有自己的namespace。

**为什么避免使用二级缓存**

在符合最开始说的二级缓存的限制时，并没有什么影响。

其他情况就会有很多危害了。

针对一个表的某些操作不在他独立的namespace下进行。

例如在UserMapper.xml中有大多数针对user表的操作。但是在一个XXXMapper.xml中，还有针对user单表的操作。

这会导致user在两个命名空间下的数据不一致。如果在UserMapper.xml中做了刷新缓存的操作，在XXXMapper.xml中缓存仍然有效，如果有针对user的单表查询，使用缓存的结果可能会不正确。

更危险的情况是在XXXMapper.xml做了insert,update,delete操作时(此时会清空所有的缓存)，会导致UserMapper.xml中的各种操作充满未知和风险。

有关这样单表的操作可能不常见。但是你也许想到了一种常见的情况。

**多表操作一定不能使用缓存**

为什么不能？

首先不管多表操作写到那个namespace下，都会存在某个表不在这个namespace下的情况。

例如两个表：role和user\_role，如果我想查询出某个用户的全部角色role，就一定会涉及到多表的操作。

<select id="selectUserRoles" resultType="UserRoleVO">
        select * from user_role a,role b where a.roleid = b.roleid and a.userid = #{userid}
    </select>

像上面这个查询，你会写到那个xml中呢？？

不管是写到RoleMapper.xml还是UserRoleMapper.xml，或者是一个独立的XxxMapper.xml中。如果使用了二级缓存，都会导致上面这个查询结果可能不正确。

如果你正好修改了这个用户的角色，上面这个查询使用缓存的时候结果就是错的。

这点应该很容易理解。

在我看来，就以MyBatis目前的缓存方式来看是无解的。多表操作根本不能缓存。

如果你让他们都使用同一个namespace（通过`<cache-ref>`）来避免脏数据，那就失去了缓存的意义。

挽救二级缓存？

**想更高效率的使用二级缓存是解决不了了。**

但是解决多表操作避免脏数据还是有法解决的。解决思路就是通过拦截器判断执行的sql涉及到那些表（可以用jsqlparser解析），然后把相关表的缓存自动清空。但是这种方式对缓存的使用效率是很低的。

设计这样一个插件是相当复杂的，既然我没想着去实现，就不废话了。

最后还是建议，放弃二级缓存，在业务层使用可控制的缓存代替更好。

**业务层使用ehcache实战:**

需要添加如下jar包到lib目录下

ehcache-core-2.5.2.jar
    
    ehcache-web-2.0.4.jar //主要针对页面缓存

3、 当前工程的src目录中加入配置文件

ehcache.xml
    
    ehcache.xsd

这些配置文件在ehcache-core这个jar包中可以找到

Ehcache基本用法

CacheManager cacheManager = CacheManager.create();
    // 或者
    cacheManager = CacheManager.getInstance();
    // 或者
    cacheManager = CacheManager.create("/config/ehcache.xml");
    // 或者
    cacheManager = CacheManager.create("http://localhost:8080/test/ehcache.xml");
    cacheManager = CacheManager.newInstance("/config/ehcache.xml");
    // .......
    
    // 获取ehcache配置文件中的一个cache
    Cache sample = cacheManager.getCache("sample");
    // 获取页面缓存
    BlockingCache cache = new BlockingCache(cacheManager.getEhcache("SimplePageCachingFilter"));
    // 添加数据到缓存中
    Element element = new Element("key", "val");
    sample.put(element);
    // 获取缓存中的对象，注意添加到cache中对象要序列化 实现Serializable接口
    Element result = sample.get("key");
    // 删除缓存
    sample.remove("key");
    sample.removeAll();
    
    // 获取缓存管理器中的缓存配置名称
    for (String cacheName : cacheManager.getCacheNames()) {
        System.out.println(cacheName);
    }
    // 获取所有的缓存对象
    for (Object key : cache.getKeys()) {
        System.out.println(key);
    }
    
    // 得到缓存中的对象数
    cache.getSize();
    // 得到缓存对象占用内存的大小
    cache.getMemoryStoreSize();
    // 得到缓存读取的命中次数
    cache.getStatistics().getCacheHits();
    // 得到缓存读取的错失次数
    cache.getStatistics().getCacheMisses();

三、页面缓存

页面缓存主要用Filter过滤器对请求的url进行过滤，如果该url在缓存中出现。那么页面数据就从缓存对象中获取，并以gzip压缩后返回。其速度是没有压缩缓存时速度的3-5倍，效率相当之高！其中页面缓存的过滤器有CachingFilter，一般要扩展filter或是自定义Filter都继承该CachingFilter。  
CachingFilter功能可以对HTTP响应的内容进行缓存。这种方式缓存数据的粒度比较粗，例如缓存整张页面。它的优点是使用简单、效率高，缺点是不够灵活，可重用程度不高。

EHCache使用SimplePageCachingFilter类实现Filter缓存。该类继承自CachingFilter，有默认产生cache key的calculateKey()方法，该方法使用HTTP请求的URI和查询条件来组成key。也可以自己实现一个Filter，同样继承CachingFilter类,然后覆写calculateKey()方法，生成自定义的key。

CachingFilter输出的数据会根据浏览器发送的Accept-Encoding头信息进行Gzip压缩。

在使用Gzip压缩时，需注意两个问题：

>  *  1.  Filter在进行Gzip压缩时，采用系统默认编码，对于使用GBK编码的中文网页来说，需要将操作系统的语言设置为：zh\_CN.GBK，否则会出现乱码的问题。
>  *  1.  默认情况下CachingFilter会根据浏览器发送的请求头部所包含的Accept-Encoding参数值来判断是否进行Gzip压缩。虽然IE6/7浏览器是支持Gzip压缩的，但是在发送请求的时候却不带该参数。为了对IE6/7也能进行Gzip压缩，可以通过继承CachingFilter，实现自己的Filter，然后在具体的实现中覆写方法acceptsGzipEncoding。

具体实现参考：

protected boolean acceptsGzipEncoding(HttpServletRequest request) {
    
    boolean ie6 = headerContains(request, "User-Agent", "MSIE 6.0");
    
    boolean ie7 = headerContains(request, "User-Agent", "MSIE 7.0");
    
    return acceptsEncoding(request, "gzip") || ie6 || ie7;
    
    }

ehcache.xml中的配置如下:

<?xml version="1.0" encoding="gbk"?>
    <ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="ehcache.xsd">
        <diskStore path="java.io.tmpdir"/>
    
        <defaultCache maxElementsInMemory="10000" eternal="false" timeToIdleSeconds="30" timeToLiveSeconds="30" overflowToDisk="false"/>
        
        <cache name="SimplePageCachingFilter" 
            maxElementsInMemory="10000" 
            eternal="false"
            overflowToDisk="false" 
            timeToIdleSeconds="900" 
            timeToLiveSeconds="1800"
            memoryStoreEvictionPolicy="LFU" />
    
    </ehcache>

在web.xml中加入如下配置

<filter>
            <filter-name>SimplePageCachingFilter</filter-name>
            <filter-class>net.sf.ehcache.constructs.web.filter.SimplePageCachingFilter
            </filter-class>
          </filter>
    
      
         <filter-mapping>
            <filter-name>SimplePageCachingFilter</filter-name>
            <url-pattern>*.do</url-pattern>
         </filter-mapping>

注意： ehcache.xml文件中配置的缓存名称 必须和web.xml配置的缓存filter名字一致 不然会抛出找不到配置的异常 。

当第一次请求这些页面后，这些页面就会被添加到缓存中，以后请求这些页面将会从缓存中获取。你可以在cache.jsp页面中用小脚本来测试该页面是否被缓存。<%=new Date()%>如果时间是变动的，则表示该页面没有被缓存或是缓存已经过期，否则则是在缓存状态了。

对象缓存

对象缓存就是将查询的数据，添加到缓存中，下次再次查询的时候直接从缓存中获取，而不去数据库中查询。

对象缓存一般是针对方法、类而来的，结合Spring的Aop对象、方法缓存就很简单。这里需要用到切面编程，用到了Spring的MethodInterceptor或是用@Aspect。

public class MethodCacheInterceptor implements MethodInterceptor, InitializingBean {
        
    
        private static final Logger log = Logger.getLogger(MethodCacheInterceptor.class);
    
        private Cache cache;
    
        public void setCache(Cache cache) {
            this.cache = cache;
        }
    
        public void afterPropertiesSet() throws Exception {
            log.info(cache + " A cache is required. Use setCache(Cache) to provide one.");
        }
    
        public Object invoke(MethodInvocation invocation) throws Throwable {
            String targetName = invocation.getThis().getClass().getName();
            String methodName = invocation.getMethod().getName();
            Object[] arguments = invocation.getArguments();
            Object result;
    
            String cacheKey = getCacheKey(targetName, methodName, arguments);
            Element element = null;
            synchronized (this) {
                element = cache.get(cacheKey);
                if (element == null) {
                    log.info(cacheKey + "加入到缓存： " + cache.getName());
                    // 调用实际的方法
                    result = invocation.proceed();
                    element = new Element(cacheKey, (Serializable) result);
                    cache.put(element);
                } else {
                    log.info(cacheKey + "使用缓存： " + cache.getName());
                }
            }
            return element.getValue();
        }
    
        /**
         * <b>function:</b> 返回具体的方法全路径名称 参数
         * @param targetName 全路径
         * @param methodName 方法名称
         * @param arguments 参数
         * @return 完整方法名称
         */
        private String getCacheKey(String targetName, String methodName, Object[] arguments) {
            StringBuffer sb = new StringBuffer();
            sb.append(targetName).append(".").append(methodName);
            if ((arguments != null) && (arguments.length != 0)) {
                for (int i = 0; i < arguments.length; i++) {
                    sb.append(".").append(arguments[i]);
                }
            }
            return sb.toString();
        }
    }

这里的方法拦截器主要是对你要拦截的类的方法进行拦截，然后判断该方法的类路径+方法名称+参数值组合的cache key在缓存cache中是否存在。如果存在就从缓存中取出该对象，转换成我们要的返回类型。没有的话就把该方法返回的对象添加到缓存中即可。值得主意的是当前方法的参数和返回值的对象类型需要序列化。

我们需要在src目录下添加applicationContext.xml完成对MethodCacheInterceptor拦截器的配置，该配置主要是注入我们的cache对象，哪个cache来管理对象缓存，然后哪些类、方法参与该拦截器的扫描。

<bean id="cacheManager" class="org.springframework.cache.ehcache.EhCacheManagerFactoryBean"/>
    
    
    <bean id="simpleCache" class="org.springframework.cache.ehcache.EhCacheFactoryBean">
        <property name="cacheManager" ref="cacheManager" />
        
        <property name="cacheName" value="mobileCache" />
    </bean>
    
    
    <bean id="methodCacheInterceptor" class="com.common.interceptor.MethodCacheInterceptor">
        <property name="cache" ref="simpleCache"/>
    </bean>
    
    
    <bean id="methodCachePointCut" class="org.springframework.aop.support.RegexpMethodPointcutAdvisor">
        
        <property name="advice" ref="methodCacheInterceptor" />
        
                         
        
        <property name="patterns">
            <list>
                <value>com.hoo.rest.*RestService*\.*get.*</value>
                <value>com.hoo.rest.*RestService*\.*search.*</value>
            </list>
        </property>
    </bean>

在ehcache.xml中添加如下cache配置

参考: [http://blog.csdn.net/isea533/article/details/44566257][http_blog.csdn.net_isea533_article_details_44566257]  
参考: [http://www.cnblogs.com/hoojo/archive/2012/07/12/2587556.html][http_www.cnblogs.com_hoojo_archive_2012_07_12_2587556.html]

[http_blog.csdn.net_isea533_article_details_44566257]: http://blog.csdn.net/isea533/article/details/44566257
[http_www.cnblogs.com_hoojo_archive_2012_07_12_2587556.html]: http://www.cnblogs.com/hoojo/archive/2012/07/12/2587556.html