【深入淺出MyBatis系列七】分頁插件

陶邦仁 發(fā)布于 2015/12/24 15:39

原文鏈接

系列目錄

Mybatis的分頁功能很弱，它是基于內(nèi)存的分頁（查出所有記錄再按偏移量和limit取結(jié)果），在大數(shù)據(jù)量的情況下這樣的分頁基本上是沒有用的。本文基于插件，通過攔截StatementHandler重寫sql語句，實(shí)現(xiàn)數(shù)據(jù)庫的物理分頁。

1 準(zhǔn)備

1.1 為什么在StatementHandler攔截## 在SQL執(zhí)行流程分析（源碼篇）章節(jié)介紹了一次sqlsession的完整執(zhí)行過程，從中可以知道sql的解析是在StatementHandler里完成的，所以為了重寫sql需要攔截StatementHandler。

1.2 MetaObject簡介

在實(shí)現(xiàn)里大量使用了MetaObject這個(gè)對(duì)象，因此有必要先介紹下它。MetaObject是Mybatis提供的一個(gè)的工具類，通過它包裝一個(gè)對(duì)象后可以獲取或設(shè)置該對(duì)象的原本不可訪問的屬性（比如那些私有屬性）。它有個(gè)三個(gè)重要方法經(jīng)常用到：

MetaObject forObject(Object object,ObjectFactory objectFactory, ObjectWrapperFactory objectWrapperFactory) 用于包裝對(duì)象；

Object getValue(String name) 用于獲取屬性的值（支持OGNL的方法）；

void setValue(String name, Object value) 用于設(shè)置屬性的值（支持OGNL的方法）；

2 攔截器簽名

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

從簽名里可以看出，要攔截的目標(biāo)類型是StatementHandler（注意：type只能配置成接口類型），攔截的方法是名稱為prepare參數(shù)為Connection類型的方法。

3 intercept實(shí)現(xiàn)

public Object intercept(Invocation invocation) throws Throwable {  
     StatementHandler statementHandler = (StatementHandler) invocation.getTarget();  
     MetaObject metaStatementHandler = MetaObject.forObject(statementHandler,  
     DEFAULT_OBJECT_FACTORY, DEFAULT_OBJECT_WRAPPER_FACTORY);  
     // 分離代理對(duì)象鏈(由于目標(biāo)類可能被多個(gè)攔截器攔截，從而形成多次代理，通過下面的兩次循環(huán)  
     // 可以分離出最原始的的目標(biāo)類)  
     while (metaStatementHandler.hasGetter("h")) {  
         Object object = metaStatementHandler.getValue("h");  
         metaStatementHandler = MetaObject.forObject(object, DEFAULT_OBJECT_FACTORY,   
         DEFAULT_OBJECT_WRAPPER_FACTORY);  
     }  
     // 分離最后一個(gè)代理對(duì)象的目標(biāo)類  
     while (metaStatementHandler.hasGetter("target")) {  
         Object object = metaStatementHandler.getValue("target");  
         metaStatementHandler = MetaObject.forObject(object, DEFAULT_OBJECT_FACTORY,   
         DEFAULT_OBJECT_WRAPPER_FACTORY);  
     }  
     Configuration configuration = (Configuration) metaStatementHandler.  
     getValue("delegate.configuration");  
     dialect = configuration.getVariables().getProperty("dialect");  
     if (null == dialect || "".equals(dialect)) {  
         logger.warn("Property dialect is not setted,use default 'mysql' ");  
         dialect = defaultDialect;  
     }  
     pageSqlId = configuration.getVariables().getProperty("pageSqlId");  
     if (null == pageSqlId || "".equals(pageSqlId)) {  
         logger.warn("Property pageSqlId is not setted,use default '.*Page$' ");  
         pageSqlId = defaultPageSqlId;  
     }  
     MappedStatement mappedStatement = (MappedStatement)   
     metaStatementHandler.getValue("delegate.mappedStatement");  
     // 只重寫需要分頁的sql語句。通過MappedStatement的ID匹配，默認(rèn)重寫以Page結(jié)尾的  
     //  MappedStatement的sql  
     if (mappedStatement.getId().matches(pageSqlId)) {  
         BoundSql boundSql = (BoundSql) metaStatementHandler.getValue("delegate.boundSql");  
         Object parameterObject = boundSql.getParameterObject();  
         if (parameterObject == null) {  
             throw new NullPointerException("parameterObject is null!");  
         } else {  
             // 分頁參數(shù)作為參數(shù)對(duì)象parameterObject的一個(gè)屬性  
             PageParameter page = (PageParameter) metaStatementHandler  
                     .getValue("delegate.boundSql.parameterObject.page");  
             String sql = boundSql.getSql();  
             // 重寫sql  
             String pageSql = buildPageSql(sql, page);  
             metaStatementHandler.setValue("delegate.boundSql.sql", pageSql);  
             // 采用物理分頁后，就不需要mybatis的內(nèi)存分頁了，所以重置下面的兩個(gè)參數(shù)  
             metaStatementHandler.setValue("delegate.rowBounds.offset",   
             RowBounds.NO_ROW_OFFSET);  
             metaStatementHandler.setValue("delegate.rowBounds.limit", RowBounds.NO_ROW_LIMIT);  
             Connection connection = (Connection) invocation.getArgs()[0];  
             // 重設(shè)分頁參數(shù)里的總頁數(shù)等  
             setPageParameter(sql, connection, mappedStatement, boundSql, page);  
         }  
     }  
     // 將執(zhí)行權(quán)交給下一個(gè)攔截器  
     return invocation.proceed();  
}

StatementHandler的默認(rèn)實(shí)現(xiàn)類是RoutingStatementHandler，因此攔截的實(shí)際對(duì)象是它。RoutingStatementHandler的主要功能是分發(fā)，它根據(jù)配置Statement類型創(chuàng)建真正執(zhí)行數(shù)據(jù)庫操作的StatementHandler，并將其保存到delegate屬性里。由于delegate是一個(gè)私有屬性并且沒有提供訪問它的方法，因此需要借助MetaObject的幫忙。通過MetaObject的封裝后我們可以輕易的獲得想要的屬性。

在上面的方法里有個(gè)兩個(gè)循環(huán)，通過他們可以分離出原始的RoutingStatementHandler（而不是代理對(duì)象）。

前面提到，簽名里配置的要攔截的目標(biāo)類型是StatementHandler攔截的方法是名稱為prepare參數(shù)為Connection類型的方法，而這個(gè)方法是每次數(shù)據(jù)庫訪問都要執(zhí)行的。因?yàn)槲沂峭ㄟ^重寫sql的方式實(shí)現(xiàn)分頁，為了不影響其他sql（update或不需要分頁的query），我采用了通過ID匹配的方式過濾。默認(rèn)的過濾方式只對(duì)id以Page結(jié)尾的進(jìn)行攔截（注意區(qū)分大小寫），如下：

<select id="queryUserByPage" parameterType="UserDto" resultType="UserDto">  
    <![CDATA[ 
    select * from t_user t where t.username = #{username} 
    ]]>  
</select>

當(dāng)然，也可以自定義攔截模式，在mybatis的配置文件里加入以下配置項(xiàng)：

<properties>  
    <property name="dialect" value="mysql" />  
    <property name="pageSqlId" value=".*Page$" />  
</properties>

其中，屬性dialect指示數(shù)據(jù)庫類型，目前只支持mysql和oracle兩種數(shù)據(jù)庫。其中，屬性pageSqlId指示攔截的規(guī)則，以正則方式匹配。

4 sql重寫

sql重寫其實(shí)在原始的sql語句上加入分頁的參數(shù)，目前支持mysql和oracle兩種數(shù)據(jù)庫的分頁。

private String buildPageSql(String sql, PageParameter page) {  
    if (page != null) {  
        StringBuilder pageSql = new StringBuilder();  
        if ("mysql".equals(dialect)) {  
            pageSql = buildPageSqlForMysql(sql, page);  
        } else if ("oracle".equals(dialect)) {  
            pageSql = buildPageSqlForOracle(sql, page);  
        } else {  
            return sql;  
        }  
        return pageSql.toString();  
    } else {  
        return sql;  
    }  
}

mysql的分頁實(shí)現(xiàn)：

public StringBuilder buildPageSqlForMysql(String sql, PageParameter page) {  
    StringBuilder pageSql = new StringBuilder(100);  
    String beginrow = String.valueOf((page.getCurrentPage() - 1) * page.getPageSize());  
    pageSql.append(sql);  
    pageSql.append(" limit " + beginrow + "," + page.getPageSize());  
    return pageSql;  
}

oracle的分頁實(shí)現(xiàn)：

public StringBuilder buildPageSqlForOracle(String sql, PageParameter page) {  
    StringBuilder pageSql = new StringBuilder(100);  
    String beginrow = String.valueOf((page.getCurrentPage() - 1) * page.getPageSize());  
    String endrow = String.valueOf(page.getCurrentPage() * page.getPageSize());  
    pageSql.append("select * from ( select temp.*, rownum row_id from ( ");  
    pageSql.append(sql);  
    pageSql.append(" ) temp where rownum <= ").append(endrow);  
    pageSql.append(") where row_id > ").append(beginrow);  
    return pageSql;  
}

5 分頁參數(shù)重寫

有時(shí)候會(huì)有這種需求，就是不但要查出指定頁的結(jié)果，還需要知道總的記錄數(shù)和頁數(shù)。我通過重寫分頁參數(shù)的方式提供了一種解決方案：

/** 
 * 從數(shù)據(jù)庫里查詢總的記錄數(shù)并計(jì)算總頁數(shù)，回寫進(jìn)分頁參數(shù)<code>PageParameter</code>,這樣調(diào)用  
 * 者就可用通過 分頁參數(shù)<code>PageParameter</code>獲得相關(guān)信息。 
 *  
 * @param sql 
 * @param connection 
 * @param mappedStatement 
 * @param boundSql 
 * @param page 
 */  
private void setPageParameter(String sql, Connection connection, MappedStatement mappedStatement,  
        BoundSql boundSql, PageParameter page) {  
    // 記錄總記錄數(shù)  
    String countSql = "select count(0) from (" + sql + ") as total";  
    PreparedStatement countStmt = null;  
    ResultSet rs = null;  
    try {  
        countStmt = connection.prepareStatement(countSql);  
        BoundSql countBS = new BoundSql(mappedStatement.getConfiguration(), countSql,  
                boundSql.getParameterMappings(), boundSql.getParameterObject());  
        setParameters(countStmt, mappedStatement, countBS, boundSql.getParameterObject());  
        rs = countStmt.executeQuery();  
        int totalCount = 0;  
        if (rs.next()) {  
            totalCount = rs.getInt(1);  
        }  
        page.setTotalCount(totalCount);  
        int totalPage = totalCount / page.getPageSize() + ((totalCount % page.getPageSize() == 0) ? 0 : 1);  
        page.setTotalPage(totalPage);  
    } catch (SQLException e) {  
        logger.error("Ignore this exception", e);  
    } finally {  
        try {  
            rs.close();  
        } catch (SQLException e) {  
            logger.error("Ignore this exception", e);  
        }  
        try {  
            countStmt.close();  
        } catch (SQLException e) {  
            logger.error("Ignore this exception", e);  
        }  
    }  
}  

/** 
 * 對(duì)SQL參數(shù)(?)設(shè)值 
 *  
 * @param ps 
 * @param mappedStatement 
 * @param boundSql 
 * @param parameterObject 
 * @throws SQLException 
 */  
private void setParameters(PreparedStatement ps, MappedStatement mappedStatement, BoundSql boundSql,  
        Object parameterObject) throws SQLException {  
    ParameterHandler parameterHandler = new DefaultParameterHandler(mappedStatement, parameterObject, boundSql);  
    parameterHandler.setParameters(ps);  
}

6 plugin實(shí)現(xiàn)

public Object plugin(Object target) {  
    // 當(dāng)目標(biāo)類是StatementHandler類型時(shí)，才包裝目標(biāo)類，否者直接返回目標(biāo)本身,減少目標(biāo)被代理的  
    // 次數(shù)  
    if (target instanceof StatementHandler) {  
        return Plugin.wrap(target, this);  
    } else {  
        return target;  
    }  
}

? 著作權(quán)歸作者所有

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容