mybatis缓存模块分析

---

需求分析

MyBatis 缓存模块需满足如下需求：

1. MyBatis 缓存的实现是基于 Map 的，从缓存里面读写数据是缓存模块的核心基础功能；
2. 除核心功能之外，有很多额外的附加功能，如：防止缓存击穿，添加缓存清空策略（fifo、
   lru）、序列化功能、日志能力、定时清空能力等；
3. 附加功能可以以任意的组合附加到核心基础功能之上；
   基于 Map 核心缓存能力，将阻塞、清空策略、序列化、日志等等能力以任意组合的方式优
   雅的增强是Mybatis 缓存模块实现最大的难题，用动态代理或者继承的方式扩展多种附加能

力的传统方式存在以下问题：这些方式是静态的，用户不能控制增加行为的方式和时机；另
外，新功能的存在多种组合，使用继承可能导致大量子类存在。综上，MyBtis 缓存模块采用
了装饰器模式实现了缓存模块；

---

一、 装饰器模式

装饰器模式是一种用于代替继承的技术，无需通过继承增加子类就能扩展对象的新功能。使
用对象的关联关系代替继承关系，更加灵活，同时避免类型体系的快速膨胀。装饰器 UML
类图如下：

组件（Component）：组件接口定义了全部组件类和装饰器实现的行为；
 组件实现类（ConcreteComponent）：实现 Component 接口，组件实现类就是被装饰器
装饰的原始对象，新功能或者附加功能都是通过装饰器添加到该类的对象上的；
 装饰器抽象类（Decorator）：实现 Component 接口的抽象类，在其中封装了一个
Component 对象，也就是被装饰的对象；
 具体装饰器类（ConcreteDecorator）：该实现类要向被装饰的对象添加某些功能；

二、装饰器的简单使用

例如我们有一个接口女孩的接口在里面定义了跳舞的功能 ,这个就是组件 Component

public interface Girl {
	
	public void dance();

}

然后有一个默认的组件的实现类 也是装饰器抽象类

public class WangMeiLi implements Girl {

	@Override
	public void dance() {
		System.out.println("我很漂亮，开始跳舞……");

	}

}

最后就是我们具体的装饰类

public class PureGirl implements Girl {
	
	private Girl girl;
	
	

	public PureGirl(Girl girl) {
		super();
		this.girl = girl;
	}



	@Override
	public void dance() {
		System.out.println("着装清纯……");
		girl.dance();

	}

}

public class LovelyGirl implements Girl {
	
	private Girl girl;
	
	

	public LovelyGirl(Girl girl) {
		super();
		this.girl = girl;
	}



	@Override
	public void dance() {
		System.out.println("着装可爱……");
		girl.dance();

	}

}
public class SexyGirl implements Girl {
	
	private Girl girl;
	
	

	public SexyGirl(Girl girl) {
		super();
		this.girl = girl;
	}



	@Override
	public void dance() {
		System.out.println("着装性感……");
		girl.dance();

	}

}

接下来我们开始使用:

System.out.println("----------使用装饰器模式实现---------");
		Girl girl2 = new LovelyGirl(new SexyGirl(new PureGirl(new WangMeiLi())));
		girl2.dance();

这样我们就可以通过不同的装饰器来使用不同的功能

1.接着我们mybatis中用到的装饰器的应用

MyBatis 缓存模块是一个经典的使用装饰器实现的模块，类图如下：
 Cache：Cache 接口是缓存模块的核
心接口，定义了缓存的基本操作；
 PerpetualCache：在缓存模块中扮演
ConcreteComponent 角色，使用HashMap
来实现cache 的相关操作；
 BlockingCache：阻塞版本的缓存装
饰器，保证只有一个线程到数据库去查
找指定的key 对应的数据；
BlockingCache 是阻塞版本的缓存装饰器，这个装饰器通过 ConcurrentHashMap 对锁的粒度
进行了控制，提高加锁后系统代码运行的效率（注：缓存雪崩的问题可以使用细粒度锁的方
式提升锁性能），源码分析见：org.apache.ibatis.cache.decorators.BlockingCache；
除了BlockingCache 之外，缓存模块还有其他的装饰器如：

1. LoggingCache：日志能力的缓存；
2. ScheduledCache：定时清空的缓存；
3. BlockingCache：阻塞式缓存；
4. SerializedCache：序列化能力的缓存；
5. SynchronizedCache：进行同步控制的缓存；
   
   思考题：Mybatis 的缓存功能使用 HashMap 实现会不会出现并发安全的问题？
   答：MyBatis 的缓存分为一级缓存、二级缓存。二级缓存是多个会话共享的缓存，确实会出
   现并发安全的问题，因此 MyBatis 在初始化二级缓存时，会给二级缓存默认加上
   SynchronizedCache 装饰器的增强，在对共享数据 HashMap 操作时进行同步控制，所以二级
   缓存不会出现并发安全问题；而一级缓存是会话独享的，不会出现多个线程同时操作缓存数
   据的场景，因此一级缓存也不会出现并发安全的问题；
   初始化的类是CachingExecutor 类中的query方法 debug的入口
   可以看到先是去创建CacheKey然后才去执行query方法的

  @Override
  public <E> List<E> query(MappedStatement ms, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler) throws SQLException {
	//获取sql语句信息，包括占位符，参数等信息
    BoundSql boundSql = ms.getBoundSql(parameterObject);
  //拼装缓存的key值 可
    CacheKey key = createCacheKey(ms, parameterObject, rowBounds, boundSql);
    return query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
  }

缓存的唯一表示CacheKey的生成过程

缓存的唯一标识 CacheKey
MyBatis 中涉及到动态 SQL 的原因，缓存项的 key 不能仅仅通过一个 String 来表示，所以通
过 CacheKey 来封装缓存的 Key 值，CacheKey 可以封装多个影响缓存项的因素；判断两个
CacheKey 是否相同关键是比较两个对象的hash 值是否一致；构成CacheKey 对象的要素包括：

1. mappedStatment 的id
2. 指定查询结果集的范围（分页信息）
3. 查询所使用的 SQL 语句
4. 用户传递给SQL 语句的实际参数值
   CacheKey 中update 方法和 equals 方法是进行比较时非常重要的两个方法：

• update 方法：用于添加构成 CacheKey 对象的要素，每添加一个元素会对 hashcode、
  checksum、count 以及updateList 进行更新；
• equals 方法：用于比较两个元素是否相等。首先比较 hashcode、checksum、count 是否
  相等，如果这三个值相等，会循环比较 updateList 中每个元素的 hashCode 是否一致；
  按照这种方式判断两个对象是否相等，一方面能很严格的判断是否一致避免出现误判，
  另外一方面能提高比较的效率；
  
  源码处:
  org.apache.ibatis.cache.CacheKey#update,equals

---

query方法

 @Override
  public <E> List<E> query(MappedStatement ms, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql)
      throws SQLException {
	//从MappedStatement中获取二级缓存
    Cache cache = ms.getCache();
    if (cache != null) {
      flushCacheIfRequired(ms);
      if (ms.isUseCache() && resultHandler == null) {
        ensureNoOutParams(ms, boundSql);
        @SuppressWarnings("unchecked")
        List<E> list = (List<E>) tcm.getObject(cache, key);//从二级缓存中获取数据
        if (list == null) {
          //二级缓存为空，才会调用BaseExecutor.query
          list = delegate.<E> query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
          tcm.putObject(cache, key, list); // issue #578 and #116
        }
        return list;
      }
    }
    return delegate.<E> query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
  }

而在query方法中它是先从cache中获取对象,如果获取到的对象为空才去BaseExecutor里面执行query方法 org.apache.ibatis.executor.BaseExecutor#query()

public <E> List<E> query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql) throws SQLException {
    ErrorContext.instance().resource(ms.getResource()).activity("executing a query").object(ms.getId());
      //检查当前executor是否关闭
    if (closed) {
      throw new ExecutorException("Executor was closed.");
    }
     //非嵌套查询，并且FlushCache配置为true，则需要清空一级缓存
    if (queryStack == 0 && ms.isFlushCacheRequired()) {
      clearLocalCache();
    }
    List<E> list;
    try {
        //查询层次加一
      queryStack++; 
      //localCache为 protected PerpetualCache localCache;//一级缓存的实现，PerpetualCache 里面是根据map来实现的一级缓存
      list = resultHandler == null ? (List<E>) localCache.getObject(key) : null;//查询以及缓存
      if (list != null) {
    	 //针对调用存储过程的结果处理
        handleLocallyCachedOutputParameters(ms, key, parameter, boundSql);
      } else {
    	 //缓存未命中，从数据库加载数据
        list = queryFromDatabase(ms, parameter, rowBounds, resultHandler, key, boundSql);
      }
    } finally {
      queryStack--;
    }
    
    
    if (queryStack == 0) {
      for (DeferredLoad deferredLoad : deferredLoads) {//延迟加载处理
        deferredLoad.load();
      }
      // issue #601
      deferredLoads.clear();
      if (configuration.getLocalCacheScope() == LocalCacheScope.STATEMENT) {//如果当前sql的一级缓存配置为STATEMENT，查询完既清空一集缓存
        // issue #482
        clearLocalCache();
      }
    }
    return list;
  }