MyBatis：简单物理分页实现（Plugin）
1、必要性
java
首先，介绍一下使用自定义拦截器来进行物理分页的必要性。咱们知道MyBatis中的SqlSession接口中提供一个带分页功能的方法：正则表达式
public interface SqlSession extends Closeable {
<E> List<E> selectList(String statement, Object parameter, RowBounds rowBounds);
// ....
}
使用该方法，咱们在查询时能够经过为selectList(..)方法提供一个RowBounds参数，来使该语句带有分页功能，举个例如，假设我须要取出查询记录的前三条记录，能够这样：sql
// 获取sqlSession的步骤略，statement略，mapper中的映射语句为 select * from users List<User> list = sqlSession.selectList(statement, null, new RowBounds(0,3));
这时咱们获取到的记录就是查询记录的前三条记录（select * from users的查询结果）数据库
这时咱们会有个疑问，既然MyBatis已经为咱们提供了分页的处理类，为什么咱们还要再重复造轮子（再手动写一个拦截器）呢？apache
这是由于MyBatis内置的分页处理器，是经过内存进行分页，结合上面的例子就是MyBatis首先执行select * from users，而后获取结果集ResultSet，接着经过传入的RowBounds中的offset和limit属性来对ResultSet进行加工。若是记录量大的话，这种效率无疑是至关低的。想证明上面这个结论，能够查看MyBatis中的DefaultResultSetHandler类session
public class DefaultResultSetHandler implements ResultSetHandler {
// ....
private void handleRowValuesForSimpleResultMap(ResultSetWrapper rsw, ResultMap resultMap,
ResultHandler<?> resultHandler, RowBounds rowBounds, ResultMapping parentMapping) throws SQLException {
DefaultResultContext<Object> resultContext = new DefaultResultContext<Object>();
// 经过skipRows来使ResusltSet指向rowBounds中的offset所指定的位置
skipRows(rsw.getResultSet(), rowBounds);
while (shouldProcessMoreRows(resultContext, rowBounds) && rsw.getResultSet().next()) {
ResultMap discriminatedResultMap = resolveDiscriminatedResultMap(rsw.getResultSet(), resultMap, null);
Object rowValue = getRowValue(rsw, discriminatedResultMap);
storeObject(resultHandler, resultContext, rowValue, parentMapping, rsw.getResultSet());
}
}
private void skipRows(ResultSet rs, RowBounds rowBounds) throws SQLException {
// 若是ResultSet中的光标支持先后移动
if (rs.getType() != ResultSet.TYPE_FORWARD_ONLY) {
// 若是rowBounds中的offset值不为0
if (rowBounds.getOffset() != RowBounds.NO_ROW_OFFSET) {
// 将rs的光标移至rowBounds中的offset指定的位置
rs.absolute(rowBounds.getOffset());
}
} else { // 若是ResultSet只支持向前移动
// 将光标从0的位置使用rs.next()来每次向前移动一位，直至rowBounds中offset指定的位置
for (int i = 0; i < rowBounds.getOffset(); i++) {
rs.next();
}
}
}
// ....
}
欲证明可在这个类中的handleRowValuesForSimpleResultMap(...)中的skipRows(...)方法上打个断点，在skipRows(...)中的rs.absolute(...)和rs.next()分别打上断点，而后经过debug方式执行mybatis
List<User> list = sqlSession.selectList(statement, null, new RowBounds(0,3));
便可看到程序确实进入了skipRows(...)方法中，咱们能够看到在skipRows(...)中，MyBatis是经过执行select * from users再对ResultSet结果集进行加工处理，而不是直接执行select * from users limit 0,3（假设是MySql数据库），这样效率显然是极低的，因此咱们若是在实际应用中，有两种方式来解决这个问题app
1）在mapper映射文件中手动将每次执行的语句改成select * from users limit #{offset},#{limit}dom
2）自定义一个拦截器，来将底层的最终查询语句变动为select * from users limit 0,3ide
下面将介绍第2种解决方式。
2、自定义分页插件
MyBatis 容许你在已映射语句执行过程当中的某一点进行拦截调用。默认状况下，MyBatis 容许使用插件来拦截的方法调用包括：
// 前面是容许用插件拦截的类名，括号里是容许用插件拦截的方法名 Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed) ParameterHandler (getParameterObject, setParameters) ResultSetHandler (handleResultSets, handleOutputParameters) StatementHandler (prepare, parameterize, batch, update, query)
MyBatis是在StatementHandler中的prepare(...)方法中完成对sql的解析，因此咱们须要在这个方法前设置一个拦截器也就是plugin来进行sql语句的置换，下面是具体的代码：
package cn.kolbe.mybatis.plugin;
import java.lang.reflect.Field;
import java.sql.Connection;
import java.util.Properties;
import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.plugin.Interceptor;
import org.apache.ibatis.plugin.Intercepts;
import org.apache.ibatis.plugin.Invocation;
import org.apache.ibatis.plugin.Plugin;
import org.apache.ibatis.plugin.Signature;
import org.apache.ibatis.session.RowBounds;
@Intercepts(@Signature(type = StatementHandler.class, method = "prepare", args = { Connection.class }))
public class PagePlugin implements Interceptor {
// select语句正则表达式匹配： ^表明开头位置 \s表明空格 $表明结尾位置 *表明任意多个 .表明任意字符
private final static String REGEX = "^\\s*[Ss][Ee][Ll][Ee][Cc][Tt].*$";
@Override
public Object intercept(Invocation inv) throws Throwable {
// 此时的target为RoutingStatementHandler类的实例
StatementHandler target = (StatementHandler)inv.getTarget();
// BoundSql类中有一个sql属性，即为待执行的sql语句
BoundSql boundSql = target.getBoundSql();
String sql = boundSql.getSql();
// 若是sql语句是select语句的话，则进行查看是否须要分页处理
if (sql.matches(REGEX)) {
// delegate是RoutingStatementHandler经过mapper映射文件中设置的statementType来指定具体的StatementHandler
Object delegate = readField(target, "delegate");
// rowBounds中绑定了咱们自定义的分页信息，包括起始位置offset和取出记录条数limit
RowBounds rowBounds = (RowBounds)readField(delegate, "rowBounds");
// 若是rowBound不为空，且rowBounds的起始位置不为0，则表明咱们须要进行分页处理
if (rowBounds != null && rowBounds.getOffset() != RowBounds.NO_ROW_OFFSET) {
// assemSql(...)完成对sql语句的装配及rowBounds的重置操做
writeField(boundSql, "sql", assemSql(sql, rowBounds));
}
}
return inv.proceed();
}
/**
* 装配SQL语句，并重置RowBounds中的offset和limit
* @param oldSql
* @param rowBounds
* @return
*/
public String assemSql(String oldSql, RowBounds rowBounds) throws Exception {
String sql = oldSql + " limit " + rowBounds.getOffset() + "," + rowBounds.getLimit();
// 这两步是必须的，由于在前面置换好sql语句之后，实际的结果集就是咱们想要的因此offset和limit必须重置为初始值
writeField(rowBounds, "offset", RowBounds.NO_ROW_OFFSET);
writeField(rowBounds, "limit", RowBounds.NO_ROW_LIMIT);
return sql;
}
/**
* 利用反射获取指定对象的指定属性
* @param target
* @param fieldName
* @return
* @throws Exception
*/
private Object readField(Object target, String fieldName) throws Exception {
Field field = null;
// 遍历target的属性及其父类的属性
for (Class<?> c = target.getClass(); c != null; c = c.getSuperclass()) {
try {
field = c.getDeclaredField(fieldName);
} catch (NoSuchFieldException ex) {
// 没找到该属性，则继承查找父类的属性，因此不处理该异常
}
}
field.setAccessible(true);
return field.get(target);
}
/**
* 利用反射为指定对象的指定属性写入值
* @param target
* @param fieldName
* @param value
* @throws Exception
*/
private void writeField(Object target, String fieldName, Object value) throws Exception {
Field field = null;
// 遍历target的属性及其父类的属性
for (Class<?> c = target.getClass(); c != null; c = c.getSuperclass()) {
try {
field = c.getDeclaredField(fieldName);
} catch (NoSuchFieldException ex) {
// 没找到该属性，则继承查找父类的属性，因此不处理该异常
}
}
field.setAccessible(true);
field.set(target, value);
}
@Override
public Object plugin(Object target) {
// 经过Plugin的wrap(...)方法来实现代理类的生成操做
return Plugin.wrap(target, this);
}
@Override
public void setProperties(Properties props) {}
}
注：
1）代码中为了尽可能保持简单易懂，没有使用过多的工具集，具体应用中对对象的私有属性赋值获取和赋值操做能够经过MyBatis内置的类或apache的commons-lang工具来处理
2）该例子使用MySql做为示例，没有考虑其它数据库，具体应用中能够考虑经过配置文件中来设置数据库，并动态的根据配置文件来决定sql语句的具体装配，一样为了简单性，在此就不举例了
在MyBatis的配置文件mybatis-config.xml中配置该插件
<plugins> <plugin interceptor="cn.kolbe.mybatis.plugin.PagePlugin"></plugin> </plugins>
在映射文件中添加查询语句
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/mybatis-3-mapper.dtd"> <mapper namespace="cn.kolbe.mybatis.domain.UserMapper"> <select id="getAll" resultType="User"> select * from users </select> </mapper>
在应用中使用
package cn.kolbe.mybatis;
import java.io.FileInputStream;
import java.io.InputStream;
import java.util.List;
import org.apache.ibatis.session.RowBounds;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Test;
import cn.kolbe.mybatis.domain.User;
public class MyBatisTest {
@Test
public void queryByPage() throws Exception {
InputStream in = new FileInputStream("src/main/java/mybatis-config.xml");
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);
SqlSession session = factory.openSession();
String statement = "cn.kolbe.mybatis.domain.UserMapper.getAll";
List<User> list = session.selectList(statement, null, new RowBounds(0,3));
System.out.println(list);
}
}
相关文章
- 1. Mybatis 实现物理分页的简单实现
- 2. mybatis实现物理分页
- 3. 简单实现ibatis的物理分页
- 4. MyBatis物理分页的代码实现
- 5. MyBatis物理分页封装实现
- 6. mybatis物理分页（常用）
- 7. springboot+mybatis+mybatis-plus分页查询（简单实现）
- 8. 【Web】分页简单实现
- 9. iscroll.js实现简单分页
- 10. 简单的分页实现
- 更多相关文章...
- • Git 分支管理 - Git 教程
- • 物理地址（MAC地址）是什么？ - TCP/IP教程
- • ☆基于Java Instrument的Agent实现
- • Spring Cloud 微服务实战(三) - 服务注册与发现
相关标签/搜索
每日一句
-
每一个你不满意的现在，都有一个你没有努力的曾经。
欢迎关注本站公众号,获取更多信息
相关文章