Mybatis 分页插件实现

Mybatis 分页插件实现

有数据的地方就有分页，分页的sql基本大加都会写，mysql可以用limit,oracle可以用ronum，sql server可以用top。这些基本大家都会用，但是一个程序中需要用到分页的地方无疑是很多的，每个地方都作这样的处理则显示的很繁琐，存在大量的重复工作，如果能统一无疑会方便很多。

对mybatis插件开发感兴趣的同学，可以参考mybatis官方文档。

现在话不多说，直接上干货。

分页需要哪些属性呢 
当前页 pageNo 
每页条数 pageSize 
总条数 totalCount
第一个和第二个属性基本所有分页都需要的，总条数呢？可能大多地方也是需要的，因为大多场景需要计算所有数据一共可以分多少页；但也有一些地方不需要的，比如说我在首页只需要展示我最近五条动态。 
所以我在这里加了个属性needTotalCount ，可能有些同学会认为直接都查出来，不需要不用就ok了，但是考虑到查询总条数需要执行额外的sql，带来性能的损耗，所以这个属性了加上去了。

针对分页查询，这里我建立了一个分页的基类 ,get与set方法太占版面，所以没贴

/** * Base class for query */public class PageQuery<T> implements Serializable {    public static final int DEFAULT_PAGE_SIZE=10;    public static final int DEFAULT_PAGE_NO=1;    /**     * 是否分页,默认不分页     */    boolean isPage=false;    /**     * 每页条数     */    int pageSize=DEFAULT_PAGE_SIZE;    /**     * 当前页数数     */    int pageNo=DEFAULT_PAGE_NO;    /**     * 数据集     */    List<T> items;    /**     * 是否需要总条数，查询总条数会额外增加一次查询     */    boolean isNeedTotalCount=true;    /**     * 总条数     */    int totalCount=0;    /**     * 获取偏移量     * @return 偏移量     */    public int getOffset() {        return (pageNo-1)*pageSize;    }}

大家可以注意到这里多了一个items属性和getOffest方法，items就是你需要的数据列表，offset是根据当前页数计算当前偏移量。

这是查询分页的基类，也是查询分页需要的条件，所有分页查询条件继承此基类。

这里我们以查询用户为例（get和set方法同样省略）:

/** * Condition for UserPageQuery Query */public class UserPageQuery extends PageQuery<User> {    private String username;    }

我们这里增加了一个条件用户名username，那我们只需要关注这个用户名即可，

Dao层方法：

List<User> queryUser(UserPageQuery userQuery);

Mapper配置：

<select id="queryUser" parameterType="UserPageQuery" resultType="User">
select <include refid="Base_Column_List"/> from User u where username=#{username}
</select>

接下来就是考虑怎样写插件了，mybatis的Plugin需要继承Interceptor接口，接口如下

public interface Interceptor {  Object intercept(Invocation invocation) throws Throwable;  Object plugin(Object target);  void setProperties(Properties properties);}

接口共有三个方法，我们先看第二个方法plugin, plugin方法就是把你实现这个接口的类加入插件，写法基本固定

@Overridepublic Object plugin(Object target) {    return Plugin.wrap(target,this);}

我们看wrap方法的源码基本可以发现，就是就是将拦截的方法通过动态代理的方式由第一个方法plugin执行。

再看第三个方法setPrpperties()，顾明思义，即设置属性,我们要使插件起作用，需要在mybatis配置文件中配置，配置如下

<plugins>    <plugin interceptor="com.lsf.twnb.dao.plugins.PagePlugin">        <property name="dbType" value="mysql"/>    </plugin></plugins>

这里增加的property即可以在setProperties的参数中取到。

最后我们来说核心的intercept方法，前面我们说过plugin方法是将指定的方法动态代理，那具体要拦截什么方法了，我们增加分页，无非是对sql作一下调整，所以有很多地方可以拦截，这里我们对Executor的query方法进行拦截，配置注解如下

@Intercepts({@Signature(type = Executor.class, method = "query",        args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class})})

intercept方法如下

@Overridepublic Object intercept(Invocation invocation) throws Throwable {    //若查询参数不为分页参数，不作处理，按原计划执行    if (!(invocation.getArgs()[1] instanceof PageQuery)) {        return invocation.proceed();    }    MappedStatement ms = (MappedStatement) invocation.getArgs()[0];    List<SqlNode> textSqlNodes = (List<SqlNode>)            SystemMetaObject.forObject(ms).getValue("sqlSource.rootSqlNode.contents");    if (textSqlNodes.lastIndexOf(mysqlPageNode) != textSqlNodes.size() - 1) {        textSqlNodes.add(mysqlPageNode);    }    PageQuery pageQuery = (PageQuery) invocation.getArgs()[1];    BoundSql boundSql = ms.getBoundSql(pageQuery);    //条件未继承分页查询类PageQuery的sql按原有逻辑处理    if (!(boundSql.getParameterObject() instanceof PageQuery)) {        return invocation.proceed();    }    Executor executor= (Executor) invocation.getTarget();    Connection connection = executor.getTransaction().getConnection();    //查询总条数会额外执行一条sql，影响性能    if (pageQuery.isNeedTotalCount()) {        //查询总条数        int totalCount = getPageQueryCount(connection,ms,boundSql,pageQuery);        pageQuery.setTotalCount(totalCount);        if(totalCount==0){            return Collections.EMPTY_LIST;        }    }    return invocation.proceed();}

我们拦截的是

<E> List<E> query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler)

第二个参数即查询的参数，分页时即继承了PageQuery的类，若未继承，则按原有逻辑处理；

mybatis会将一条sql划分为许多块，而textSqlNodes为这些块的集合，

比如

select <include refid="Base_Column_List"/> from User u where username=#{username}

就被划分成了

select 

id,username

from User 

where username=#{username}
四块，而我们要做分页，只需要在这个集合里面加入分页数据即可

textSqlNodes.add(mysqlPageNode);

声明如下

private final TextSqlNode mysqlPageNode = new TextSqlNode(" limit #{offset},#{pageSize} ");

，如果是oracle，则在前后加上rownum的块。

这里的pageSize和offset我们的rownum里面都有了的。

注意这个判断

if (textSqlNodes.lastIndexOf(mysqlPageNode) != textSqlNodes.size() - 1)

只有第一次查询分页的方法时需要加，因为这个已经写进内存了，所以第二次调用时就不用加了，最后，如果你不需要总条数，可以直接

return invocation.proceed();

执行被代理的方法，game over。

如果需要总条数，则继续往下看，调用方法getPageQueryCount查询总条数

private int getPageQueryCount(Connection connection, MappedStatement ms, BoundSql boundSql, PageQuery pageQuery) throws Throwable {    //获取绑定sql    String sql = boundSql.getSql();    //数据库连接    //查询数据总条数    PreparedStatement countQuery = connection.prepareStatement(            dialect.generateCountSql(sql));    //记录当前页数和每页条数（查询总条数时offset和limit要去掉）    int pageSize= pageQuery.getPageSize();    int pageNo= pageQuery.getPageNo();    pageQuery.setPageNo(PageQuery.DEFAULT_PAGE_NO);    pageQuery.setPageSize(RowBounds.NO_ROW_LIMIT);    ParameterHandler parameterHandler = new DefaultParameterHandler(ms,            pageQuery, boundSql);    parameterHandler.setParameters(countQuery);    ResultSet rs = countQuery.executeQuery();    int totalCount = 0;    try {        if (rs.next()) {            totalCount = rs.getInt(1);        }    } finally {        rs.close();        countQuery.close();        pageQuery.setPageNo(pageNo);        pageQuery.setPageSize(pageSize);    }    return totalCount;}

这里用PreparedStatemetn执行预处理查询总条数，这里需要注意的是因为前面我们已经加入了分页条件，所以这里把分页条件的值设置为最大。如果数据集为空，则直接返回空集合。