MyBatis使用Ehcache作为二级缓存

特别说明：由于二级缓存是基于Mapper的，当你在不同的mapper中查询了相同的数据，例如不同的Mapper中有多表查询时结果中有相同的数据，当其中一个Mapper进行插入更新缓存时，另一个并没有插入更新，那么使用两个mapper查询出来的数据会出现数据不一致的情况，所以MyBatis默认的二级缓存的实现方式需要慎用，也因此MyBatis的二级缓存都默认关闭。

主要步骤（基于springboot+mybatis）

1 导入依赖

        <!-- mybatis -->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.2</version>
        </dependency>
        <!-- 数据库驱动 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.8</version>
        </dependency>
        <!--mybatis适配ehcache-->
        <dependency>
            <groupId>org.mybatis.caches</groupId>
            <artifactId>mybatis-ehcache</artifactId>
            <version>1.1.0</version>
        </dependency>

2 开启全局缓存

开启全局配置

3 配置ehcache.xml

注意：ehcache.xml必须放在classpath路径下，并且名字必须是ehcache.xml（因为CacheManager默认就是加载classpath路径下的ehcache.xml文件，当然也可以自己设置，这就需要自己继承EhcacheCache自己写逻辑）


    <defaultCache
            maxElementsInMemory="10000"
            maxElementsOnDisk="0"
            eternal="true"
            overflowToDisk="true"
            diskPersistent="true"
            timeToIdleSeconds="0"
            timeToLiveSeconds="0"
            diskSpoolBufferSizeMB="50"
            diskExpiryThreadIntervalSeconds="120"
            memoryStoreEvictionPolicy="LFU"
    />

    <cache
            name="user_cache"
            maxElementsInMemory="5000"
            overflowToDisk="false"
            diskPersistent="true"
            timeToIdleSeconds="1800"
            timeToLiveSeconds="1800"
            memoryStoreEvictionPolicy="LRU"/>

</ehcache>

这里最重要的就是<defaultCache>默认缓存配置，因为CacheManager.addCache(name)添加的缓存就是通过默认配置创建的，具体每个属性代表的意思可以查询Ehcache的属性配置，网上很多，这里不细述。

4 在mapper中开启缓存并指定使用Ehcache

在一个mapper中通过以下代码添加缓存。

<cache type="org.mybatis.caches.ehcache.EhcacheCache"></cache>

假设通过<cache>引入缓存的mapper的namespache为“com.dahuici.zyb.Dao.UserDao”，其他mapper可以通过如下标签与其共享缓存。

<cache-ref namespace="com.dahuici.zyb.Dao.UserDao"/>

通过<cache>与<cache-ref>配合使用，可以让所有的mapper都共用一个缓存。

特别提示，如果使用的是mybatis-plus，使用上面的步骤配置的话，会发现调用mybatis-plus已经封装好的api，缓存无效，只有自己在mapper中定义的sql方法才有效。个人理解就是这些api是mybatis-plus自己封装好的，封装的时候没有开启缓存，解决办法是如下，在dao层使用注解引用其他mapper的缓存，共享缓存

mybatis-plus共享缓存

EhcacheCache源代码研究

public class EhcacheCache extends AbstractEhcacheCache {
    public EhcacheCache(String id) {
        super(id);
        if (!CACHE_MANAGER.cacheExists(id)) {
            //根据默认配置创建缓存
            CACHE_MANAGER.addCache(id);
        }

        this.cache = CACHE_MANAGER.getEhcache(id);
    }
}

对于mybatis，也可以自定义缓存，只需实现org.apache.ibatis.cache接口，需要注意的是必须要有一个传入String类型的一个构造方法，mybatis会自动调用并将namespace的值作为id传入。

package org.apache.ibatis.cache;
import java.util.concurrent.locks.ReadWriteLock;
public interface Cache {
  //获取缓存id
  String getId();
  //往缓存中放入对象
  void putObject(Object key, Object value);
  //获取对象
  Object getObject(Object key);
  //移除对象
  Object removeObject(Object key);
  //清除缓存数据
  void clear();
  //获取缓存尺寸
  int getSize();
  //获取读写锁
  ReadWriteLock getReadWriteLock();
}