mybatis分页拦截器

阅读更多

     最近看了一下项目中代码，发现系统中使用的mybatis分页使用的是mybatis自带的分页，即使用RowBounds来进行分页，而这种分页是基于内存分页，即一次查出所有的数据，然后再返回分页需要的数据。断点跟踪mybatis的源码可以看到是这个方法中org.apache.ibatis.executor.resultset.FastResultSetHandler.skipRows(ResultSet, RowBounds)决定是将resultset的游标从哪个地方开始返回数据.

     如果我们在mybatis执行sql之前，动态的将普通的sql语句换成分页的sql即可解决问题。那么我们就要找到mybatis是合适进行预编译sql的。

     通过在程序中打断点，我们知道先是MapperProxy进行处理->然后是创建MapperMethod->然后执行mapperMethod的execute方法，在这个方法中判断我们是那种执行操作，比如增加，修改等，假如是查询操作(SELECT),然后就会根据mapperMethod中的sqlSessionTemplete参数，进行查询(selectList)操作，在该方法中进行SqlSession的获取，获取sqlSession时，会创建Exector对象（默认是SimpleExecutor）最终返回DefaultSqlSession, 然后经过一系列的操作，执行DefaultSqlSession中的selectList方法，在该方法中会执行executor的query方法，再经过一系列的操作，会执行org.apache.ibatis.executor.SimpleExecutor.doQuery(MappedStatement, Object, RowBounds, ResultHandler, BoundSql)这个方法，在该方法中会创建StatementHandler对象，跟踪断点知道创建的是RoutingStatementHandler，在RoutingStatementHandler的构造方法中，会根据StatementType判断创建那种Statement，默认是创建PreparedStatementHandler，在RoutingStatementHandler创建成功后，就会执行RoutingStatementHandler的prepare方法，在该方法中就会执行connection.prepareStatement(sql);最终返回java.sql.Statement对象。那么我们只要在connection.prepareStatement(sql)执行之前将不是分页的sql替换成分页的sql即可实现数据库的分页。

    （上述流程建议，打一个断点跟踪一下mybatis的执行过程。）

     经过上述分析，我们知道sql语句是由org.apache.ibatis.executor.statement.StatementHandler.prepare(Connection)这个方法来执行预编译的。那么我们就可以写一个拦截器拦截prepare方法，在sql语句预编译之前改变sql,这正好可以借助mybatis的插件来实现。

    在mybatis中编写一个插件需要实现org.apache.ibatis.plugin.Interceptor这个接口，然后在该接口上使用注解（@Intercepts）来标注要拦截的方法

    解释一下插件中可能要用到的几个类：

    MetaObject：mybatis提供的一个基于返回获取属性值的对象的类

    BoundSql : 在这个里面可以获取都要执行的sql和执行sql要用到的参数

    MappedStatement ： 这个可以得到当前执行的sql语句在xml文件中配置的id的值

    RowBounds : 是mybatis内存分页要用到的。

    ParameterHandler ： 是mybatis中用来替换sql中?出现的值的.

    那么我就说一下，我在我们项目中实现分页的实现：

    1.基于oracel分页

    2.拦截select操作，其余的操作放行，即根据mappedStatement.getId()方法来判断

    3.对分页中的参数进行一个判断，只要参数的类型是map，并且存在pageNo和pageSize这2个属性，即任务是分页sql（我们系统中的参数都是以map的方式传递的）

    4.计算出总的记录数，然后放回到传递参数的map中

   

@Intercepts({ @Signature(type = StatementHandler.class, method = "prepare", args = { Connection.class }) })
public class PageInterceptor implements Interceptor {

	@Override
	public Object intercept(Invocation invocation) throws Throwable {
		StatementHandler statementHandler = (StatementHandler) invocation.getTarget();
		MetaObject metaStatementHandler = MetaObject.forObject(statementHandler, SystemMetaObject.DEFAULT_OBJECT_FACTORY, SystemMetaObject.DEFAULT_OBJECT_WRAPPER_FACTORY);
		BoundSql boundSql = statementHandler.getBoundSql();
		MappedStatement mappedStatement = (MappedStatement) metaStatementHandler.getValue("delegate.mappedStatement");
		String id = mappedStatement.getId();
		System.out.println("sql语句的id : " + id);
		Object param = boundSql.getParameterObject();
		if (null != param && Map.class.isAssignableFrom(param.getClass())) {
			Map paramMap = (Map) param;
			Object _pageSize = paramMap.get("pageSize");
			Object _pageNo = paramMap.get("pageNo");
			if (_pageNo != null && _pageSize != null) {
				int pageSize = (Integer) _pageSize;
				int pageNo = (Integer) _pageNo;
				setTotalResult(boundSql, (Connection) invocation.getArgs()[0], metaStatementHandler, paramMap);
				String sql = getPageSql(pageSize, pageNo, boundSql);
				metaStatementHandler.setValue("delegate.boundSql.sql", sql);
				metaStatementHandler.setValue("delegate.rowBounds.offset", RowBounds.NO_ROW_OFFSET);
				metaStatementHandler.setValue("delegate.rowBounds.limit", RowBounds.NO_ROW_LIMIT);
			}
		}
		return invocation.proceed();
	}

        // 这个分页方法是借助于网上的
	private String getPageSql(int pageSize, int pageNo, BoundSql boundSql) {
		StringBuffer sql = new StringBuffer(boundSql.getSql());
		sql.insert(0, "select u.*, rownum r from (").append(") u where rownum < ").append(pageSize * pageNo);
		sql.insert(0, "select * from (").append(") where r >= ").append((pageSize - 1) * pageNo);
		return sql.toString();
	}
	private void setTotalResult(BoundSql boundSql, Connection conn, MetaObject metaObject, Map param) throws SQLException {
		String countSql = "select count(*) from ( " + boundSql.getSql() + " ) total";
		PreparedStatement prepareStatement = conn.prepareStatement(countSql);
		ParameterHandler parameterHandler = (ParameterHandler) metaObject.getValue("delegate.parameterHandler");
		parameterHandler.setParameters(prepareStatement); // 给sql语句设置参数
		ResultSet resultSet = prepareStatement.executeQuery();
		if (resultSet.next()) {
			param.put("total", resultSet.getObject(1));
		}
		if (resultSet != null) {
			resultSet.close();
		}
		if (prepareStatement != null) {
			prepareStatement.close();
		}
	}

	@Override
	public Object plugin(Object target) {
		return Plugin.wrap(target, this);
	}
	@Override
	public void setProperties(Properties properties) {

	}
}

    插件写好之后，在配置文件中进行配置：

   

	
	
	
		
			  // 插件所在的类中的全路径