mybatis框架下物理分页的实现（整个工程采用的是springmvc、spring、mybatis框架，数据库是mysql数据库）

2022-10-21 21:16:36

(一）关于分页拦截器的简单理解

首先，要开发MyBatis的插件需要实现org.apache.ibatis.plugin.Interceptor接口，这个接口将会要求实现几个方法：intercept（）、plugin（）及setProperties（），intercept方法是开发人员所要执行的操作，plugin是将你插件放入到MyBatis的插件集合中去，而setProperties这是在你配置你插件的时候将plugins/plugin/properties的值设置到该插件中。
    该方法的第一句话就是获得Intercepts注解，接下来将获得在Intercepts里面的参数@Signature注解内容，在该注解中包含三个参数，分别是type，method，args。Type指定要拦截的类对象，method是指明要拦截该类的哪个方法，第三个是指明要拦截的方法参数集合。在Intercepts中可以配置多个@Signature。那么便对这写值进行遍历，已获得对应的type、method以及args。最终是获得一个HashMap对象，这些对象里面的键是类对象，而值是指定的类中方法对象。执行该端程序之后，更具target的classLoader和接口，来创建一个代理，并且，InvocationHandler是创建一个新的Plugin对象，同时将target，interceptor以及signatureMap传递给Plugin对象，当然，这里的Plugin也实现了Invocation接口。那么target对象所有的方法调用都会触发Plugin中的invoke方法，那么这里将执行开发者所有插入的操作。

另外对拦截器类里面几个关键的类做出解释：

（1）BoundSql类 ，封装mybatis最终产生sql的类，包括sql语句，参数，参数源数据等。
（2）MappedStatement类，MappedStatement类在Mybatis框架中用于表示XML文件中一个sql语句节点，即一个<select />、<update />或者<insert />标签。Mybatis框架在初始化阶段会对XML配置文件进行读取，将其中的sql语句节点对象化为一个个MappedStatement对象。

总结，本拦截器实现的目标就是在进行数据库查询操作之前，从配置文件读出相应的sql语句，将相应的参数拼接到其中，然后再进行查询。当然在拼接sql语句之前，先查询了一下数据库中相应记录的总数

（二）拦截器类PageIntercepter.java：

  1. package cn.zyy.paging.intercepter;
  2. import java.sql.Connection;
  3. import java.sql.PreparedStatement;
  4. import java.sql.ResultSet;
  5. import java.sql.SQLException;
  6. import java.util.List;
  7. import java.util.Properties;
  8. import org.apache.ibatis.mapping.BoundSql;
  9. import org.apache.ibatis.mapping.MappedStatement;
  10. import org.apache.ibatis.mapping.ParameterMapping;
  11. import org.apache.ibatis.mapping.ParameterMode;
  12. import org.apache.ibatis.mapping.SqlSource;
  13. import org.apache.ibatis.plugin.Interceptor;
  14. import org.apache.ibatis.plugin.Intercepts;
  15. import org.apache.ibatis.plugin.Invocation;
  16. import org.apache.ibatis.plugin.Plugin;
  17. import org.apache.ibatis.reflection.MetaObject;
  18. import org.apache.ibatis.session.Configuration;
  19. import org.apache.ibatis.session.RowBounds;
  20. import org.apache.ibatis.type.TypeHandler;
  21. import org.apache.ibatis.type.TypeHandlerRegistry;
  22. import cn.zyy.paging.vo.PageObject;
  23. @Intercepts({@org.apache.ibatis.plugin.Signature(method="query", type=org.apache.ibatis.executor.Executor.class, args={MappedStatement.class, Object.class, RowBounds.class, org.apache.ibatis.session.ResultHandler.class})})
  24. public class PageIntercepter implements Interceptor{
  25. @Override
  26. public Object intercept(Invocation invocation) throws Throwable {
  27. MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];
  28. Object object = invocation.getArgs()[1];
  29. if(object instanceof PageObject){
  30. PageObject pageObject = (PageObject) object;
  31. BoundSql boundSql = mappedStatement.getBoundSql(object);
  32. String sql = boundSql.getSql();
  33. int count = getCount(mappedStatement,boundSql);
  34. pageObject.setCount(count);
  35. int pages = (pageObject.getCount()+pageObject.getNumber()-1)/pageObject.getNumber();
  36. pageObject.setPages(pages>0?pages:1);
  37. int offset = (pageObject.getPage() - 1) * pageObject.getNumber();
  38. int limit = pageObject.getNumber();
  39. String pageSql = pageSql(sql, offset, limit);
  40. BoundSql pageBoundSql = new BoundSql(mappedStatement.getConfiguration(), pageSql, boundSql.getParameterMappings(), boundSql.getParameterObject());
  41. MappedStatement pageMappedStatement = pageMappedStatement(mappedStatement, new PageSqlSource(pageBoundSql));
  42. invocation.getArgs()[0] = pageMappedStatement;
  43. invocation.getArgs()[2] = RowBounds.DEFAULT;
  44. }
  45. return invocation.proceed();
  46. }
  47. @Override
  48. public Object plugin(Object object) {
  49. // TODO Auto-generated method stub
  50. return Plugin.wrap(object, this);
  51. }
  52. @Override
  53. public void setProperties(Properties properties) {
  54. // TODO Auto-generated method stub
  55. }
  56. private int getCount(MappedStatement mappedStatement, BoundSql boundSql) throws SQLException {
  57. Connection connection = null;
  58. PreparedStatement ps = null;
  59. ResultSet rs = null;
  60. try {
  61. String countSql = countSql(boundSql.getSql());
  62. connection = mappedStatement.getConfiguration().getEnvironment().getDataSource().getConnection();
  63. ps = connection.prepareStatement(countSql);
  64. BoundSql countBoundSql = new BoundSql(mappedStatement.getConfiguration(), countSql, boundSql.getParameterMappings(), boundSql.getParameterObject());
  65. setCountParameters(ps, mappedStatement, countBoundSql);
  66. rs = ps.executeQuery();
  67. int count = 0;
  68. if (rs.next())
  69. {
  70. count = rs.getInt(1);
  71. }
  72. return count;
  73. } catch (Exception e) {
  74. return 1000;
  75. }finally{
  76. try {
  77. rs.close();
  78. } catch (Exception localException4) {
  79. }
  80. try {
  81. ps.close();
  82. } catch (Exception localException5) {
  83. }
  84. try {
  85. connection.close();
  86. }
  87. catch (Exception localException6) {
  88. }
  89. }
  90. }
  91. private static String countSql(String sql){
  92. sql = sql.toUpperCase();
  93. StringBuffer countSql = new StringBuffer();
  94. countSql.append("SELECT COUNT(1) FROM (");
  95. countSql.append(sql.substring(0, sql.indexOf("ORDER BY")==-1?sql.length():sql.indexOf("ORDER BY")-1));
  96. countSql.append(") PAY_PAGE_T");
  97. return countSql.toString();
  98. }
  99. private static void setCountParameters(PreparedStatement ps, MappedStatement mappedStatement, BoundSql boundSql) throws SQLException {
  100. List<ParameterMapping> parameterMappingList = boundSql.getParameterMappings();
  101. if (parameterMappingList != null)
  102. {
  103. Configuration configuration = mappedStatement.getConfiguration();
  104. TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
  105. Object parameterObject = boundSql.getParameterObject();
  106. MetaObject metaObject = parameterObject == null ? null : configuration.newMetaObject(parameterObject);
  107. int n = 1;
  108. for (ParameterMapping parameterMapping : parameterMappingList)
  109. {
  110. if ((parameterMapping.getMode() == ParameterMode.IN) || (parameterMapping.getMode() == ParameterMode.INOUT))
  111. {
  112. String property = parameterMapping.getProperty();
  113. Object value = null;
  114. if (parameterObject != null)
  115. {
  116. if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass()))
  117. {
  118. value = parameterObject;
  119. }
  120. else
  121. {
  122. value = metaObject == null ? null : metaObject.getValue(property);
  123. }
  124. }
  125. TypeHandler typeHandler = parameterMapping.getTypeHandler();
  126. typeHandler.setParameter(ps, n, value, parameterMapping.getJdbcType());
  127. }
  128. n++;
  129. }
  130. }
  131. }
  132. private String pageSql(String sql, int offset, int limit) {
  133. sql = sql.toUpperCase();
  134. StringBuffer pageSql = new StringBuffer();
  135. pageSql.append(sql);
  136. pageSql.append(" LIMIT ");
  137. pageSql.append(offset);
  138. pageSql.append(", ");
  139. pageSql.append(limit);
  140. return pageSql.toString();
  141. }
  142. private MappedStatement pageMappedStatement(MappedStatement mappedStatement, SqlSource sqlSource)
  143. {
  144. MappedStatement.Builder builder = new MappedStatement.Builder(
  145. mappedStatement.getConfiguration(),
  146. mappedStatement.getId(),
  147. sqlSource,
  148. mappedStatement.getSqlCommandType());
  149. builder.resource(mappedStatement.getResource());
  150. builder.fetchSize(mappedStatement.getFetchSize());
  151. builder.statementType(mappedStatement.getStatementType());
  152. builder.keyGenerator(mappedStatement.getKeyGenerator());
  153. builder.timeout(mappedStatement.getTimeout());
  154. builder.parameterMap(mappedStatement.getParameterMap());
  155. builder.resultMaps(mappedStatement.getResultMaps());
  156. builder.cache(mappedStatement.getCache());
  157. builder.resultSetType(mappedStatement.getResultSetType());
  158. builder.flushCacheRequired(mappedStatement.isFlushCacheRequired());
  159. builder.useCache(mappedStatement.isUseCache());
  160. builder.resultOrdered(mappedStatement.isResultOrdered());
  161. builder.databaseId(mappedStatement.getDatabaseId());
  162. builder.lang(mappedStatement.getLang());
  163. if (mappedStatement.getKeyProperties() != null)
  164. {
  165. for (String keyProperty : mappedStatement.getKeyProperties())
  166. {
  167. builder.keyProperty(keyProperty);
  168. }
  169. }
  170. if (mappedStatement.getKeyColumns() != null)
  171. {
  172. for (String keyColumn : mappedStatement.getKeyColumns())
  173. {
  174. builder.keyColumn(keyColumn);
  175. }
  176. }
  177. return builder.build();
  178. }
  179. public static class PageSqlSource implements SqlSource {
  180. private BoundSql boundSql;
  181. public PageSqlSource(BoundSql boundSql) {
  182. this.boundSql = boundSql;
  183. }
  184. public BoundSql getBoundSql(Object parameterObject)
  185. {
  186. return this.boundSql;
  187. }
  188. }
  189. }

（三）spring配置文件和mybatis配置文件

mybatis配置文件中主要是配置相关的vo类和拦截器

[html] view plain copy

上一篇：(翻译玩)在使用flask-script的应用上使用gunicorn


下一篇：10.tesseract