深入浅出Mybatis-改造Cache

为了方便修改BUG，我在github上创建了一个仓库，地址：https://github.com/hupanfeng/hdd。欢迎大家在留言里提交问题，我会尽快修复，并将修复的代码提交至github上。

在前面的文章里，我开发了两个插件：根据注解实现的sql自动生成插件和分页插件。这两个插件在没有开启cache的情况下可以很好的使用，但开启cache后却出现了一些问题，为了解决这些问题，我编写了拦截cache的插件，通过这个拦截器修正了这些问题。

问题

什么问题

最容易出现的问题是开启cache后，分页查询时无论查询哪一页都返回第一页的数据。另外，使用sql自动生成插件生成get方法的sql时，传入的参数不起作用，无论传入的参数是多少，都返回第一个参数的查询结果。

 

为什么出现这些问题

在之前讲解Mybatis的执行流程的时候提到，在开启cache的前提下，Mybatis的executor会先从缓存里读取数据，读取不到才去数据库查询。问题就出在这里，sql自动生成插件和分页插件执行的时机是在statementhandler里，而statementhandler是在executor之后执行的，无论sql自动生成插件和分页插件都是通过改写sql来实现的，executor在生成读取cache的key（key由sql以及对应的参数值构成）时使用都是原始的sql，这样当然就出问题了。

解决问题

找到问题的原因后，解决起来就方便了。只要通过拦截器改写executor里生成key的方法，在生成可以时使用自动生成的sql（对应sql自动生成插件）或加入分页信息（对应分页插件）就可以了。

拦截器签名

[java] view plain copy 

1. @Intercepts({@Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class})})  
2. public class CacheInterceptor implements Interceptor {  
3. ...  
4. }  

从签名里可以看出，要拦截的目标类型是Executor（注意：type只能配置成接口类型），拦截的方法是名称为query的方法。

intercept的实现

[java] view plain copy 

1. public Object intercept(Invocation invocation) throws Throwable {  
2.         Executor executorProxy = (Executor) invocation.getTarget();  
3.         MetaObject metaExecutor = MetaObject.forObject(executorProxy, DEFAULT_OBJECT_FACTORY, DEFAULT_OBJECT_WRAPPER_FACTORY);  
4.         // 分离代理对象链  
5.         while (metaExecutor.hasGetter("h")) {  
6.             Object object = metaExecutor.getValue("h");  
7.             metaExecutor = MetaObject.forObject(object, DEFAULT_OBJECT_FACTORY, DEFAULT_OBJECT_WRAPPER_FACTORY);  
8.         }  
9.         // 分离最后一个代理对象的目标类  
10.         while (metaExecutor.hasGetter("target")) {  
11.             Object object = metaExecutor.getValue("target");  
12.             metaExecutor = MetaObject.forObject(object, DEFAULT_OBJECT_FACTORY, DEFAULT_OBJECT_WRAPPER_FACTORY);  
13.         }  
14.         Object[] args = invocation.getArgs();  
15.         return this.query(metaExecutor, args);  
16.     }  
17.   
18.     public <E> List<E> query(MetaObject metaExecutor, Object[] args) throws SQLException {  
19.         MappedStatement ms = (MappedStatement) args[0];  
20.         Object parameterObject = args[1];  
21.         RowBounds rowBounds = (RowBounds) args[2];  
22.         ResultHandler resultHandler = (ResultHandler) args[3];  
23.         BoundSql boundSql = ms.getBoundSql(parameterObject);  
24.         // 改写key的生成  
25.         CacheKey cacheKey = createCacheKey(ms, parameterObject, rowBounds, boundSql);  
26.         Executor executor = (Executor) metaExecutor.getOriginalObject();  
27.         return executor.query(ms, parameterObject, rowBounds, resultHandler, cacheKey, boundSql);  
28.     }  
29.   
30.     private CacheKey createCacheKey(MappedStatement ms, Object parameterObject, RowBounds rowBounds, BoundSql boundSql) {  
31.         Configuration configuration = ms.getConfiguration();  
32.         pageSqlId = configuration.getVariables().getProperty("pageSqlId");  
33.         if (null == pageSqlId || "".equals(pageSqlId)) {  
34.             logger.warn("Property pageSqlId is not setted,use default '.*Page$' ");  
35.             pageSqlId = defaultPageSqlId;  
36.         }  
37.         CacheKey cacheKey = new CacheKey();  
38.         cacheKey.update(ms.getId());  
39.         cacheKey.update(rowBounds.getOffset());  
40.         cacheKey.update(rowBounds.getLimit());  
41.         List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();  
42.         // 解决自动生成SQL，SQL语句为空导致key生成错误的bug  
43.         if (null == boundSql.getSql() || "".equals(boundSql.getSql())) {  
44.             String id = ms.getId();  
45.             id = id.substring(id.lastIndexOf(".") + 1);  
46.             String newSql = null;  
47.             try {  
48.                 if ("select".equals(id)) {  
49.                     newSql = SqlBuilder.buildSelectSql(parameterObject);  
50.                 }  
51.                 SqlSource sqlSource = buildSqlSource(configuration, newSql, parameterObject.getClass());  
52.                 parameterMappings = sqlSource.getBoundSql(parameterObject).getParameterMappings();  
53.                 cacheKey.update(newSql);  
54.             } catch (Exception e) {  
55.                 logger.error("Update cacheKey error.", e);  
56.             }  
57.         } else {  
58.             cacheKey.update(boundSql.getSql());  
59.         }  
60.   
61.         MetaObject metaObject = MetaObject.forObject(parameterObject, DEFAULT_OBJECT_FACTORY, DEFAULT_OBJECT_WRAPPER_FACTORY);  
62.   
63.         if (parameterMappings.size() > 0 && parameterObject != null) {  
64.             TypeHandlerRegistry typeHandlerRegistry = ms.getConfiguration().getTypeHandlerRegistry();  
65.             if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {  
66.                 cacheKey.update(parameterObject);  
67.             } else {  
68.                 for (ParameterMapping parameterMapping : parameterMappings) {  
69.                     String propertyName = parameterMapping.getProperty();  
70.                     if (metaObject.hasGetter(propertyName)) {  
71.                         cacheKey.update(metaObject.getValue(propertyName));  
72.                     } else if (boundSql.hasAdditionalParameter(propertyName)) {  
73.                         cacheKey.update(boundSql.getAdditionalParameter(propertyName));  
74.                     }  
75.                 }  
76.             }  
77.         }  
78.         // 当需要分页查询时，将page参数里的当前页和每页数加到cachekey里  
79.         if (ms.getId().matches(pageSqlId) && metaObject.hasGetter("page")) {  
80.             PageParameter page = (PageParameter) metaObject.getValue("page");  
81.             if (null != page) {  
82.                 cacheKey.update(page.getCurrentPage());  
83.                 cacheKey.update(page.getPageSize());  
84.             }  
85.         }  
86.         return cacheKey;  
87. }   

plugin的实现

[java] view plain copy 

1. public Object plugin(Object target) {  
2.     // 当目标类是CachingExecutor类型时，才包装目标类，否者直接返回目标本身,减少目标被代理的  
3.     // 次数  
4.     if (target instanceof CachingExecutor) {  
5.         return Plugin.wrap(target, this);  
6.     } else {  
7.         return target;  
8.     }  
9. }  

源码

下载地址：http://download.csdn.net/detail/hupanfeng/6609263