2. 程式人生 > >利用Mybatis攔截器實現分頁查詢

利用Mybatis攔截器實現分頁查詢

阿新 • • 發佈：2018-12-11

手寫Mybatis攔截器

版本 Spring Boot 2.0.3.RELEASE

Mybatis自定義攔截器

如果有閱讀過我之前一篇部落格 Hibernate 重新整理上下文 的朋友應該還記得 Hibernate 的上下文中可以新增自定義的事件監聽器。當初是為了解決一個類似於二段提交的的問題，後面我利用 Hibernate 自帶的上下文事件監聽器算是比較優雅的處理了。所以當時就想看看 Mybatis 這邊有沒有什麼類似的方式處理，於是就有了這篇文章。

我看可以來先看看Mybatis 官網上對攔截器的介紹。Mybatis 官網對攔截器稱呼為外掛（plugins）官網的介紹也比較簡單，關鍵就是一個小 demo 如下

// ExamplePlugin.java
@Intercepts({@Signature(
  type= Executor.class,
  method = "update",
  args = {MappedStatement.class,Object.class})})
public class ExamplePlugin implements Interceptor {
  public Object intercept(Invocation invocation) throws Throwable {
    return invocation.proceed();
  }
  public
 
 Object plugin(Object target) {
    return Plugin.wrap(target, this);
  }
  // 可以通過 Properties 獲取到你想要的一些配置資訊
  public void setProperties(Properties properties) {
  }
}

<!-- mybatis-config.xml -->
<plugins>
  <plugin interceptor="org.mybatis.example.ExamplePlugin">
    <property name
 
="someProperty" value="100"/>
  </plugin>
</plugins>

Spring Boot 自定義 Mybatis 攔截器

我們可以根據官網上的介紹來自己寫一個簡單的 Mybatis 攔截器，我寫的簡易程式碼如下。在攔截上直接宣告@Component即可註冊

@Intercepts({
        @Signature(
                type = Executor.class,
                method = "update", args = {MappedStatement.class, Object.class}
        )
})
@Component
public class MyIntertceptor implements Interceptor {
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        System.out.println("進入攔截器");
        return invocation.proceed();
    }

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

    @Override
    public void setProperties(Properties properties) {
    }
}

可以看出核心就是實現 public Object intercept(Invocation invocation) throws Throwable這麼一個方法。效果就當執行 update 相關操作（insert ，update 語句）時會觸發執行，打印出進入攔截器。

MyBatis 允許你在已對映語句執行過程中的某一點進行攔截呼叫。預設情況下，MyBatis 允許使用外掛來攔截的方法呼叫包括：

Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed) ParameterHandler (getParameterObject, setParameters) ResultSetHandler (handleResultSets, handleOutputParameters) StatementHandler (prepare, parameterize, batch, update, query)

我這裡是使用了 Executor 執行時處理的攔截器，有對應著上面幾種情況時的處理。

實現簡易的分頁查詢

設計思路

  • 呼叫形式
  • 資料庫方言
  • 攔截器邏輯

呼叫方法

有使用過Mybatis分頁外掛 PageHelper的應該都知道是先呼叫一個靜態方法，對下條sql語句進行攔截，在new 一個分頁物件時自動處理。

在PageHelper中是利用了ThreadLocal 本地執行緒變數副本來處理的，當執行那個方法時往ThreadLocal設定一個分頁引數值，所以它每次只對下一條SQL語句有效。所以這裡我也準備這麼做。在new 分頁物件時remove掉ThreadLocal中的變數值 程式碼如下

public class PageResult <T>{
    private long total;

    private List<T> data;

    public PageResult(List<T> data) {
        this.data = data;
        PageInterceptor.PageParm pageParm = PageInterceptor.PARM_THREAD_LOCAL.get();
        if(pageParm != null){
            total = pageParm.totalSize;
            PageInterceptor.PARM_THREAD_LOCAL.remove();
        }
    }

    public long getTotal() {
        return total;
    }

    public List<T> getData() {
        return data;
    }
}


@Intercepts({
        @Signature(
                type = Executor.class,method = "query",
                args = {MappedStatement.class,Object.class,RowBounds.class,ResultHandler.class}
        )
})
@Component
public class PageInterceptor implements Interceptor {
	...
	
	static final ThreadLocal<PageParm> PARM_THREAD_LOCAL = new ThreadLocal<>();

    static class PageParm{
        // 分頁開始位置
        int offset;
        // 分頁數量
        int limit;
        // 總數
        long totalSize;
    }

    /**
     * 開始分頁
     * @param pageNum 當前頁碼 從0開始
     * @param pageSize 每頁長度
     */
    public static void startPage(int pageNum,int pageSize){
        int offset = pageNum * pageSize;
        int limit = pageSize;
        PageParm pageParm = new PageParm();
        pageParm.offset = offset;
        pageParm.limit = limit;
        PARM_THREAD_LOCAL.set(pageParm);
    }
}

資料庫方言問題 構建分頁SQL

我這裡用了一個策略模式，定義好一個方言介面，不同的資料使用不同的方言實現，在注入時生宣告，目前我只有一個MySQL所以也不算完全的策略模式。一個分頁是需要兩條語句的，一個是count 一個是 limit。

public interface Dialect {

    /**
     * 獲取countSQL語句
     * @param targetSql
     * @return
     */
    default String getCountSql(String targetSql){
        return String.format("select count(1) from (%s) tmp_count",targetSql);
    }

    String getLimitSql(String targetSql, int offset, int limit);
}

@Component //我這裡直接指定了，當然最好是使用 @bean 這樣把它new出來更好一些
public class MysqlDialect implements Dialect {

    private static final String PATTERN = "%s limit %s, %s";

    private static final String PATTERN_FIRST = "%s limit %s";

    @Override
    public String getLimitSql(String targetSql, int offset, int limit) {
        if (offset == 0) {
            return String.format(PATTERN_FIRST, targetSql, limit);
        }

        return String.format(PATTERN, targetSql, offset, limit);
    }
}

攔截器核心邏輯

在貼出程式碼之前，我想先感謝一下 buzheng同學，因為這裡面的攔截器核心邏輯有很大一部分就是參考他寫的Mybatis分頁中攔截器的實現。

@Override
public Object intercept(Invocation invocation) throws Throwable {
    final Object[] args = invocation.getArgs();
    PageParm pageParm = PARM_THREAD_LOCAL.get();
    //判斷是否需要進分頁
    if(pageParm != null){
        final MappedStatement ms = (MappedStatement)args[MAPPED_STATEMENT_INDEX];
        Object param = args[PARAMETER_INDEX];
        BoundSql boundSql = ms.getBoundSql(param);
        // 獲取總數
        pageParm.totalSize = queryTotal(ms,boundSql);
        // 重新設定SQL語句對映
        args[MAPPED_STATEMENT_INDEX] = copyPageableMappedStatement(ms,boundSql);
    }
    Object proceed = invocation.proceed();
    return proceed;
}

獲取資料的總數量 -> count

/**
 * 查詢總記錄數 基本上屬於直接抄的
 * @param mappedStatement
 * @param boundSql
 * @return
 * @throws SQLException
 */
private long queryTotal(MappedStatement mappedStatement, BoundSql boundSql) throws SQLException {

    Connection connection = null;
    PreparedStatement countStmt = null;
    ResultSet rs = null;
    try {

        connection = mappedStatement.getConfiguration().getEnvironment().getDataSource().getConnection();

        String countSql = this.dialect.getCountSql(boundSql.getSql());

        countStmt = connection.prepareStatement(countSql);
        BoundSql countBoundSql = new BoundSql(mappedStatement.getConfiguration(), countSql,
                boundSql.getParameterMappings(), boundSql.getParameterObject());

        setParameters(countStmt, mappedStatement, countBoundSql, boundSql.getParameterObject());

        rs = countStmt.executeQuery();
        long totalCount = 0;
        if (rs.next()) {
            totalCount = rs.getLong(1);
        }

        return totalCount;
    } catch (SQLException e) {
        logger.error("查詢總記錄數出錯", e);
        throw e;
    } finally {
        if (rs != null) {
            try {
                rs.close();
            } catch (SQLException e) {
                logger.error("exception happens when doing: ResultSet.close()", e);
            }
        }

        if (countStmt != null) {
            try {
                countStmt.close();
            } catch (SQLException e) {
                logger.error("exception happens when doing: PreparedStatement.close()", e);
            }
        }

        if (connection != null) {
            try {
                connection.close();
            } catch (SQLException e) {
                logger.error("exception happens when doing: Connection.close()", e);
            }
        }
    }
}
/**
 * 對SQL引數(?)設值
 *
 * @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);
}

利用方言介面替換原始的SQL語句

private MappedStatement copyPageableMappedStatement(MappedStatement ms, BoundSql boundSql) {
    PageParm pageParm = PARM_THREAD_LOCAL.get();
    String pageSql = dialect.getLimitSql(boundSql.getSql(),pageParm.offset,pageParm.limit);
    SqlSource source = new StaticSqlSource(ms.getConfiguration(),pageSql,boundSql.getParameterMappings());
    return copyFromMappedStatement(ms,source);
}

/**
 * 利用新生成的SQL語句去替換原來的MappedStatement
 * @param ms
 * @param newSqlSource
 * @return
 */
private MappedStatement copyFromMappedStatement(MappedStatement ms,SqlSource newSqlSource) {
    MappedStatement.Builder builder = new MappedStatement.Builder(ms.getConfiguration(),ms.getId(),newSqlSource,ms.getSqlCommandType());

    builder.resource(ms.getResource());
    builder.fetchSize(ms.getFetchSize());
    builder.statementType(ms.getStatementType());
    builder.keyGenerator(ms.getKeyGenerator());
    if(ms.getKeyProperties() != null && ms.getKeyProperties().length !=0){
        StringBuffer keyProperties = new StringBuffer();
        for(String keyProperty : ms.getKeyProperties()){
            keyProperties.append(keyProperty).append(",");
        }
        keyProperties.delete(keyProperties.length()-1, keyProperties.length());
        builder.keyProperty(keyProperties.toString());
    }

    //setStatementTimeout()
    builder.timeout(ms.getTimeout());

    //setStatementResultMap()
    builder.parameterMap(ms.getParameterMap());

    //setStatementResultMap()
    builder.resultMaps(ms.getResultMaps());
    builder.resultSetType(ms.getResultSetType());

    //setStatementCache()
    builder.cache(ms.getCache());
    builder.flushCacheRequired(ms.isFlushCacheRequired());
    builder.useCache(ms.isUseCache());

    return builder.build();
}

這樣在執行了分頁查詢的時候，會額外執行一條count語句，並且把原來的SQL換成帶有limit的語句最終查詢的結果就如下

@GetMapping("/all")
public Object all(){
    PageInterceptor.startPage(1,2);
    List<Model> all = dao.findAll();
    PageResult<Model> modelPageResult = new PageResult<>(all);
    return modelPageResult;
}


{  
   total:3,
   data:-   [  
      -      {  
         id:"2",
         name:null,
         code:"123"
      }
   ]
}

我的程式碼已經放在了github上歡迎大家隨時star

github 地址https://github.com/newShiJ/Mybatis-Pageable

相關推薦

利用Mybatis攔截器實現分頁查詢

手寫Mybatis攔截器 版本 Spring Boot 2.0.3.RELEASE Mybatis自定義攔截器 如果有閱讀過我之前一篇部落格 Hibernate 重新整理上下文 的朋友應該還記得 Hibernate 的上下文中可以新增自定義的事件監聽器。當初是為

myBatis學習筆記（10）——使用攔截器實現分頁查詢

條件 iba execute rri itl alias property gen func 1. Page package com.sm.model; import java.util.List; public class Page<T&g

Maven+Mybatis+Spring+SpringMVC實現分頁查詢

XML lec www tails odin build 效果 servle lpad 轉載：http://www.cnblogs.com/zhangtan/p/5846955.html 一、項目搭建 關於項目搭建，小寶鴿以前寫過一篇Spirng+SpringMVC+Ma

java 分頁工具類+Mybatis攔截SQL實現分頁

轉載！一個比較好的分頁！ /**  * 對Page<E>結果進行包裝  * <p/>  * 新增分頁的多項屬性，主要參考:http://bbs.csdn.net/topics/360010907  * @version 3.3.0

關於我個人mybatis攔截器對於分頁的看法

一、對於mybaits的認知 二、關於mybatis的分頁 三、mybatis攔截器分頁對專案各方面效率的影響 總結 一、對於mybaits的認知 由於我還是一個學生，mybatis是我自學的，所以下面的話我說的可能會比較通俗點。 我在

使用插件pagehelper在mybatis中實現分頁查詢

通過 否則 跟著 jar包 自動識別 lds equals 數值 可用 快速參考步驟： 　　1.　　引入jar包 <dependency>　　<groupId>com.github.pagehelper</groupId>　　<a

springmvc+mybatis 實現分頁查詢

一、開發前準備 　　1.參考：https://www.cnblogs.com/liandy0906/p/9985453.html 　　2.目的：為簡化分頁功能，設計了一個分頁的JSP標籤，只需要在頁面使用分頁標籤，就可以完成所有頁面的分頁功能。   二、建立類　　 　　1.實體類

Mybatis-plus之RowBounds實現分頁查詢

物理分頁和邏輯分頁 物理分頁：直接從資料庫中拿出我們需要的資料，例如在Mysql中使用limit。 邏輯分頁：從資料庫中拿出所有符合要求的資料，然後再從這些資料中拿到我們需要的分頁資料。 優缺點 物理分頁每次都要訪問資料庫，邏輯分頁只訪問一次。 物理分頁佔用記憶體少，邏輯分頁相對較多。 物理分頁資

mybatis實現分頁查詢的功能

基本的步驟就是 （1）查詢總共有多少條 （2）分頁查詢，當前頁，一頁查多少，一共多少頁 （3）外圍需要迴圈呼叫，獲取所有頁的資料，或者分頁展示 首先寫一個分頁的基礎類 public class Pagination<T> { /**

Sprinboot2.0整合Mybatis實現分頁查詢

轉自這篇部落格： https://blog.csdn.net/Winter_chen001/article/details/80010967 內容就不copy了，折騰了半天，剛開始是由於更改了其中的包結構，導致啟動時報錯，提示UserController類建立b

MyBatis程式碼例項系列-10：MyBatis通過PageHelper外掛實現分頁查詢

本章主要記錄MyBatis通過PageHelper外掛實現分頁查詢，涉及到的技術點有： - com.github.pagehelper：開源的MyBatis分頁外掛 1.SQL drop table apple; create table `a

利用vue.js實現分頁查詢

利用vue.js實現資料庫分頁 最新專案有一個分頁功能，畫面風格很簡樸給的樣圖就用【1】表示頁碼了， 因此，我沒有上網上找外掛，自己簡單的做了一個。作為菜鳥，程式碼可能有點青澀，請見諒。 除了vue我還引用了Bootstrap的類和圖示

mybatis關聯字表分頁查詢實現（物理分頁）

 mapper.xml <resultMap id="BaseResultMapOneToManey" type="cn.howso.resume.resume.entity.ResumeInfo">         <id column="ID" j

初識Vue.js 利用iview實現分頁查詢和條件查詢

最近新專案前端框架用的jquery+vue+iview  起初可以說是對vue一無所知，但是，經過近十天的應用，也掌握了一些東西，今天主要梳理一下關於自己今天用到vue做查詢和分頁，用於分享給大家以及給自己以後作為review。廢話不說，直接懟程式碼。前臺頁面如下：這些標籤是

SSH——基於datagrid實現分頁查詢

sel 雙擊 datagrid auto roman .... img order 信息 1. 修改頁面中datagrid的URL地址，訪問action // 取派員信息表格 $(‘#grid‘).datagrid( {

通過spring抽象路由數據源+MyBatis攔截器實現數據庫自動讀寫分離

註入 兩個 -- 事情 rem 使用註解 connect key值 -m 前言 之前使用的讀寫分離的方案是在mybatis中配置兩個數據源，然後生成兩個不同的SqlSessionTemplate然後手動去識別執行sql語句是操作主庫還是從庫。如下圖所示： 好處是，你

在Spring Boot中使用Spring-data-jpa實現分頁查詢（轉）

分頁查詢 log def inpu database ext identity odin btn 在我們平時的工作中，查詢列表在我們的系統中基本隨處可見，那麽我們如何使用jpa進行多條件查詢以及查詢列表分頁呢？下面我將介紹兩種多條件查詢方式。 1、引入起步依賴

mybatis攔截器實現查看sql執行效率

nth 內部 設置 work check sel nts mage view package cc.zeelan.common.utils; import java.lang.reflect.Field; import java.sql.Statement; impor

Mongodb系列- 使用spring-data-mongodb實現分頁查詢

mon 分頁查詢 rep template list pre pri 自動生成 aging 在用spring-data-mongodb框架開發的過程中,需要實現分頁查詢,就百度了下,沒找到滿意的又google了下,找到了思路. 在spring-data-mongodb 官

動態sql實現分頁查詢

類對象 span ecp IT clas listitem 結果 創建 sku 1.創建實體類對象需要查詢的條件com.rl.ecps.model.QueryCondition 　　private Long brandId; 　　private Short auditSta