2. 程式人生 > >Mybatis之攔截器Interceptor

Mybatis之攔截器Interceptor

阿新 • • 發佈：2019-06-16

    使用mybatis時用PageHelper進行分頁，用到了PageInterceptor，藉此瞭解下mybatis的interceptor。Mybatis的版本是3.4.6，MybatisHelper的版本是5.1.3。

1、PageInterceptor

    先上一段程式碼，如下List-1:

    List-1

@Test
public void testPage() {
    PageHelper.startPage(2, 3);
    List<Person> all = personMapper.findAll();
    PageInfo<Person> personPageInfo = new PageInfo<>(all,3);
    log.info(all.toString());
    int pageNum = personPageInfo.getPageNum();
    int pageSize = personPageInfo.getSize();
    int pages = personPageInfo.getPages();
    log.info("pageNum:"+pageNum+" size:"+ pageSize +" pages:"+ pages);
}

    List-1中，查詢所有的Person，不過分頁查詢，注意使用PageHelper後，得到的List型別的all是com.github.pagehelper.Page，它繼承了JDK的ArrayList，如下List-2所示，我在使用時一開始也以為是JDK的List實現，直到在看PageInfo時出現一些情況，深入瞭解後才發現是PageHelper繼承的ArrayList:

    List-2

public class Page<E> extends ArrayList<E> implements Closeable {
    private static final long serialVersionUID = 1L;
    private int pageNum;
    private int pageSize;
    private int startRow;
    private int endRow;
    private long total;
    private int pages;
    private boolean count;
    private Boolean reasonable;
    private Boolean pageSizeZero;
    private String countColumn;
    private String orderBy;
    private boolean orderByOnly;
......

    mybatis的Interceptor如下List-3所示，PageInterceptor實現了這個介面：

    List-3

public interface Interceptor {

  Object intercept(Invocation invocation) throws Throwable;

  Object plugin(Object target);

  void setProperties(Properties properties);

}

    來看PageInterceptor如何實現intercept介面的，如下List-4

    List-4

@Override
public Object intercept(Invocation invocation) throws Throwable {
    try {
        Object[] args = invocation.getArgs();
        MappedStatement ms = (MappedStatement) args[0];
        Object parameter = args[1];
        RowBounds rowBounds = (RowBounds) args[2];
        ResultHandler resultHandler = (ResultHandler) args[3];
        Executor executor = (Executor) invocation.getTarget();
        CacheKey cacheKey;
        BoundSql boundSql;
        //由於邏輯關係，只會進入一次
        if(args.length == 4){
            //4 個引數時
            boundSql = ms.getBoundSql(parameter);
            cacheKey = executor.createCacheKey(ms, parameter, rowBounds, boundSql);
        } else {
            //6 個引數時
            cacheKey = (CacheKey) args[4];
            boundSql = (BoundSql) args[5];
        }
        List resultList;
        //呼叫方法判斷是否需要進行分頁，如果不需要，直接返回結果
        if (!dialect.skip(ms, parameter, rowBounds)) {
            //反射獲取動態引數
            String msId = ms.getId();
            Configuration configuration = ms.getConfiguration();
            Map<String, Object> additionalParameters = (Map<String, Object>) additionalParametersField.get(boundSql);
            //判斷是否需要進行 count 查詢
            if (dialect.beforeCount(ms, parameter, rowBounds)) {
                String countMsId = msId + countSuffix;
                Long count;
                //先判斷是否存在手寫的 count 查詢
                MappedStatement countMs = getExistedMappedStatement(configuration, countMsId);
                if(countMs != null){
                    count = executeManualCount(executor, countMs, parameter, boundSql, resultHandler);
                } else {
                    countMs = msCountMap.get(countMsId);
                    //自動建立
                    if (countMs == null) {
                        //根據當前的 ms 建立一個返回值為 Long 型別的 ms
                        countMs = MSUtils.newCountMappedStatement(ms, countMsId);
                        msCountMap.put(countMsId, countMs);
                    }
                    count = executeAutoCount(executor, countMs, parameter, boundSql, rowBounds, resultHandler);
                }
                //處理查詢總數
                //返回 true 時繼續分頁查詢，false 時直接返回
                if (!dialect.afterCount(count, parameter, rowBounds)) {
                    //當查詢總數為 0 時，直接返回空的結果
                    return dialect.afterPage(new ArrayList(), parameter, rowBounds);
                }
            }
            //判斷是否需要進行分頁查詢
            if (dialect.beforePage(ms, parameter, rowBounds)) {
                //生成分頁的快取 key
                CacheKey pageKey = cacheKey;
                //處理引數物件
                parameter = dialect.processParameterObject(ms, parameter, boundSql, pageKey);
                //呼叫方言獲取分頁 sql
                String pageSql = dialect.getPageSql(ms, boundSql, parameter, rowBounds, pageKey);
                BoundSql pageBoundSql = new BoundSql(configuration, pageSql, boundSql.getParameterMappings(), parameter);
                //設定動態引數
                for (String key : additionalParameters.keySet()) {
                    pageBoundSql.setAdditionalParameter(key, additionalParameters.get(key));
                }
                //執行分頁查詢
                resultList = executor.query(ms, parameter, RowBounds.DEFAULT, resultHandler, pageKey, pageBoundSql);
            } else {
                //不執行分頁的情況下，也不執行記憶體分頁
                resultList = executor.query(ms, parameter, RowBounds.DEFAULT, resultHandler, cacheKey, boundSql);
            }
        } else {
            //rowBounds用引數值，不使用分頁外掛處理時，仍然支援預設的記憶體分頁
            resultList = executor.query(ms, parameter, rowBounds, resultHandler, cacheKey, boundSql);
        }
        return dialect.afterPage(resultList, parameter, rowBounds);
    } finally {
        dialect.afterAll();
    }
}

    我們來分析下List-4的內容，"if (!dialect.skip(ms, parameter, rowBounds)) {"判斷是否需要進行分頁，這個dialect就是PageHelper，如下List-5，有興趣可以看下"pageParams.getPage(parameterObject, rowBounds);"，

    List-5

public class PageHelper extends PageMethod implements Dialect {
    private PageParams pageParams;
    private PageAutoDialect autoDialect;

    @Override
    public boolean skip(MappedStatement ms, Object parameterObject, RowBounds rowBounds) {
        if(ms.getId().endsWith(MSUtils.COUNT)){
            throw new RuntimeException("在系統中發現了多個分頁外掛，請檢查系統配置!");
        }
        Page page = pageParams.getPage(parameterObject, rowBounds);
        if (page == null) {
            return true;
        } else {
            //設定預設的 count 列
            if(StringUtil.isEmpty(page.getCountColumn())){
                page.setCountColumn(pageParams.getCountColumn());
            }
            autoDialect.initDelegateDialect(ms);
            return false;
        }
    }
...

    List-4中如果不需要分頁，則直接呼叫executor的query方法。需要分頁情況下，首先會看是否需要進行count查詢——List-4中的"if (dialect.beforeCount(ms, parameter, rowBounds))"，dialect.beforeCount的最終實現是在AbstractHelperDialect的beforeCount方法，如下List-6，getLocalPage()呼叫PageHelper.getLocalPage()，得到com.github.pagehelper.Page——isOrderByOnly預設返還false，isCount預設返還true。

    List-6

public abstract class AbstractHelperDialect extends AbstractDialect implements Constant {
...

    @Override
    public boolean beforeCount(MappedStatement ms, Object parameterObject, RowBounds rowBounds) {
        Page page = getLocalPage();
        return !page.isOrderByOnly() && page.isCount();
    }
...

    List-4中，需要count查詢後，判斷手寫的count已存在，不存在則呼叫mybatis的builder等工具類構造，之後進行count查詢，得到結果後呼叫dialect的afterCount方法，實現在AbstractHelperDialect的afterCount方法，如下List-7，getLocalPage()獲取PageInfo中的Page，之後設定total。在分頁的時候，我們會對PageHelper進行pageSize的設定，所以只要count的結果大於0，就會返還true。

    List-7

@Override
public boolean afterCount(long count, Object parameterObject, RowBounds rowBounds) {
    Page page = getLocalPage();
    page.setTotal(count);
    if (rowBounds instanceof PageRowBounds) {
        ((PageRowBounds) rowBounds).setTotal(count);
    }
    //pageSize < 0 的時候，不執行分頁查詢
    //pageSize = 0 的時候，還需要執行後續查詢，但是不會分頁
    if (page.getPageSize() < 0) {
        return false;
    }
    return count > 0;
}

    List-4中查詢到count，且大於0，則繼續後續，先判斷是否需要進行分頁查詢——List-4中的"dialect.beforePage(ms, parameter, rowBounds)"，實現是在AbstractHelperDialect中，這裡不再深入這點，只要我們的pageSize設定大於0，該方法預設是返還true的。

    進行分頁查詢，會呼叫AbstractHelperDialect的getPageSql方法獲取資料庫執行的sql，以mysql為例子，AbstractHelperDialect在呼叫子類MySqlDialect的getPageSql方法，如下List-8，會在sql的最後加上limit語句。AbstractHelperDialect的子類有很多種，對應不同的資料庫，這裡使用了模板設計模式。之後再將這個sql交給executor執行，達到分頁的操作。有些人說mybatis的分頁查詢外掛底層上是全部查出到記憶體之後進行切分，但是我看到的是通過limit進行分頁，沒有什麼問題的，控制檯列印的sql也是帶有limit的。

    List-8

@Override
public String getPageSql(String sql, Page page, CacheKey pageKey) {
    StringBuilder sqlBuilder = new StringBuilder(sql.length() + 14);
    sqlBuilder.append(sql);
    if (page.getStartRow() == 0) {
        sqlBuilder.append(" LIMIT ? ");
    } else {
        sqlBuilder.append(" LIMIT ?, ? ");
    }
    pageKey.update(page.getPageSize());
    return sqlBuilder.toString();
}

    List-4中，分頁查詢到結果後，呼叫"dialect.afterPage(resultList, parameter, rowBounds)"，即AbstractHelperDialect的afterPage方法，如下List-9，從PageHelper中得到Page，之後將分頁查詢的結果放入到Page中。

    List-9

@Override
public Object afterPage(List pageList, Object parameterObject, RowBounds rowBounds) {
    Page page = getLocalPage();
    if (page == null) {
        return pageList;
    }
    page.addAll(pageList);
    if (!page.isCount()) {
        page.setTotal(-1);
    } else if ((page.getPageSizeZero() != null && page.getPageSizeZero()) && page.getPageSize() == 0) {
        page.setTotal(pageList.size());
    } else if(page.isOrderByOnly()){
        page.setTotal(pageList.size());
    }
    return page;
}

    List-4中最後的finally塊呼叫dialect.afterAll()，我們來看下實現，如下的PageHelper的afterAll()，清理各項清理。

    List-10

@Override
public void afterAll() {
    //這個方法即使不分頁也會被執行，所以要判斷 null
    AbstractHelperDialect delegate = autoDialect.getDelegate();
    if (delegate != null) {
        delegate.afterAll();
        autoDialect.clearDelegate();
    }
    clearPage();
}

    最終，這個PageInterceptor的intercept方法返還的是自己定義的Page。

2、PageHelper

    來看看PageHelper，它的父類PageMethod，如下的List-10，使用ThreadLocal來儲存Page，如果熟悉JDK的ThreadLocal那麼，對其要注意的點，在PageInterceptor的使用時也要注意，這裡不再深究。

    List-10

public abstract class PageMethod {
    protected static final ThreadLocal<Page> LOCAL_PAGE = new ThreadLocal<Page>();
    protected static boolean DEFAULT_COUNT = true;

    /**
     * 設定 Page 引數
     *
     * @param page
     */
    protected static void setLocalPage(Page page) {
        LOCAL_PAGE.set(page);
    }

    /**
     * 獲取 Page 引數
     *
     * @return
     */
    public static <T> Page<T> getLocalPage() {
        return LOCAL_PAGE.get();
    }

    /**
     * 移除本地變數
     */
    public static void clearPage() {
        LOCAL_PAGE.remove();
    }
...

3、在哪裡呼叫Interceptor

    什麼時候呼叫Interceptor呢，來看mybatis的Configuration的幾個方法，這幾個方法最後都呼叫了interceptorChain，如List-12所示，使用責任鏈模式，呼叫plugin方法，最後呼叫Interceptor的intercept方法。

    List-11

public ParameterHandler newParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {
  ParameterHandler parameterHandler = mappedStatement.getLang().createParameterHandler(mappedStatement, parameterObject, boundSql);
  parameterHandler = (ParameterHandler) interceptorChain.pluginAll(parameterHandler);
  return parameterHandler;
}

public ResultSetHandler newResultSetHandler(Executor executor, MappedStatement mappedStatement, RowBounds rowBounds, ParameterHandler parameterHandler,
    ResultHandler resultHandler, BoundSql boundSql) {
  ResultSetHandler resultSetHandler = new DefaultResultSetHandler(executor, mappedStatement, parameterHandler, resultHandler, boundSql, rowBounds);
  resultSetHandler = (ResultSetHandler) interceptorChain.pluginAll(resultSetHandler);
  return resultSetHandler;
}

public StatementHandler newStatementHandler(Executor executor, MappedStatement mappedStatement, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
  StatementHandler statementHandler = new RoutingStatementHandler(executor, mappedStatement, parameterObject, rowBounds, resultHandler, boundSql);
  statementHandler = (StatementHandler) interceptorChain.pluginAll(statementHandler);
  return statementHandler;
}

public Executor newExecutor(Transaction transaction) {
  return newExecutor(transaction, defaultExecutorType);
}

public Executor newExecutor(Transaction transaction, ExecutorType executorType) {
  executorType = executorType == null ? defaultExecutorType : executorType;
  executorType = executorType == null ? ExecutorType.SIMPLE : executorType;
  Executor executor;
  if (ExecutorType.BATCH == executorType) {
    executor = new BatchExecutor(this, transaction);
  } else if (ExecutorType.REUSE == executorType) {
    executor = new ReuseExecutor(this, transaction);
  } else {
    executor = new SimpleExecutor(this, transaction);
  }
  if (cacheEnabled) {
    executor = new CachingExecutor(executor);
  }
  executor = (Executor) interceptorChain.pluginAll(executor);
  return executor;
}

    List-12

public class InterceptorChain {

  private final List<Interceptor> interceptors = new ArrayList<Interceptor>();

  public Object pluginAll(Object target) {
    for (Interceptor interceptor : interceptors) {
      target = interceptor.plugin(target);
    }
    return target;
  }

  public void addInterceptor(Interceptor interceptor) {
    interceptors.add(interceptor);
  }
  
  public List<Interceptor> getInterceptors() {
    return Collections.unmodifiableList(interceptors);
  }
}

    思考，外掛還可以做其它什麼呢，我們可以用來進行sql效能耗時的統計，或者對更新操作統一的加上更新者、時間等。

Reference

  1. 原始碼
  2. https://blog.csdn.net/top_code/article/details

相關推薦

Mybatis之攔截器Interceptor

    使用mybatis時用PageHelper進行分頁，用到了PageInterceptor，藉此瞭解下m

Mybatis之攔截器--獲取執行SQL實現多客戶端數據同步

gin sign factor 方便 完成後 動態代理 exc batis 包安裝 最近的一個項目是將J2EE環境打包安裝在客戶端(使用 nwjs + NSIS 制作安裝包)運行, 所有的業務操作在客戶端完成, 數據存儲在客戶端數據庫中. 服務器端數據庫匯總各客戶端的數據進

Mybatis之攔截器原理（jdk動態代理優化版本）

在介紹Mybatis攔截器程式碼之前，我們先研究下jdk自帶的動態代理及優化 其實動態代理也是一種設計模式...優於靜態代理，同時動態代理我知道的有兩種，一種是面向介面的jdk的代理，第二種是基於第三方的非面向介面的cglib. 我們現在說的是jdk的動態代理，因為mybatis攔截器也是基於這個實現的。

SpringMVC總結之攔截器Interceptor（例：登入攔截器）

目錄   1.前言 2.HandleInterceptor介面 3.攔截器實現使用者登入攔截 1.前言 使用攔截器，主要是為了攔截使用者的請求並進行相應的處理，比如通過攔截器進行使用者登入驗證，使用者許可權驗證等；SpringMVC中的攔截器攔截請求是通過實

OkHttp3原始碼分析之攔截器Interceptor

前言 在上一篇部落格中，我們從原始碼分析了，一次非同步網路請求的整個大概表面的流程，但是涉及到某些具體的內容呢，就直接帶過了。本篇文章我們就先來了解一下在發起一次網路請求時，OkHttp是怎麼發起請求獲取響應的。這裡邊就涉及到OkHttp的一個很棒的設計——攔

Java三大器之攔截器(Interceptor)的實現原理及程式碼示例

轉載 https://blog.csdn.net/reggergdsg/article/details/52962774 1，攔截器的概念     java裡的攔截器是動態攔截Action呼叫的物件，它提供了一種機制可以使開發者在一個Action執行的前後執行一段程式碼，也可以在一個Action 執

Struts2最新版(2.5.12)快速入門(四) struts2之攔截器（Interceptor）

一、初識攔截器            1、攔截器原理                    "攔截器"顧名即可思義，它是對ac

springMVC之攔截器

urn html request ora 異常處理 bool class 用戶 name 有兩種方法配置spring的攔截器 1. 實現接口: HandleInterceptor public class MyInterceptor1 implements Handl

spring mvc 配置 mybatis sql攔截器

mybatis直接上代碼：mybatis配置中 添加 <property name="plugins"> 如下： <bean id="sqlSessionFactory" class="com.hotent.core.mybatis.SqlSessionFactoryFactoryBea

【Spring】SpringMVC之攔截器

https javax request orm bin 支持 exceptio 賬號 intern Spring的HandlerMapping處理器支持攔截器應用。當需要為某些請求提供特殊功能時，例如實現對用戶進行身份認證、登錄檢查等功能。 攔截器必須實現HandlerI

spring security 單一賬戶多地方登陸提醒, ajax 攔截器 Interceptor

lean odi true window post 錯誤 img commons 會話管理 spring-security.xml部分代碼： <http auto-config="false" > <access-denied-h

SpringMVC之攔截器實現登錄驗證

一個 throw idt 判斷 sed XML auto 也有 登錄驗證 今天回頭看之前發的javaweb學習路線圖，發現把路線圖中的也學的有一半多了,不過還是路漫漫。在前面的博客中有學習過spring的aop,它利用動態代理實現，在springmvc中也是一樣，今天使用H

webservice之攔截器

trac stack hand name static actor 攔截 extend fault 記錄一次webservice添加攔截器，來達到修改xml報文的目的 import org.apache.cxf.endpoint.Client; import org.ap

struts2框架之攔截器（參考第二天學習筆記）

xxx java clas 完成 攔截 銷毀 == 情況 配置 攔截器 1. 什麽是攔截器 1). 與JavaWeb中的Filter比較相似。 2). 攔截器只能攔截Action!!! 2. Struts中定義了很多攔截器，其中defaultStack中的攔截器會在每個

springboot成神之——攔截器

ref type pri quest exceptio ack min 路由 urn 本文介紹spring boot攔截器 創建攔截器類LogInterceptor.java 創建攔截器類OldLoginInterceptor.java 攔截器配置類WebMvcConf

Spring Boot （Web 篇）：整合攔截器Interceptor

目錄 說在前面 在pom.xml加入相關依賴 定義攔截器 編寫攔截器 Interceptor 註冊攔截器 Interceptor 頁面訪問（專案啟動） 總結 原始碼下載 說在前面 Struts2（Interceptor篇）：攔截器的實現

Spring MVC 中整合攔截器Interceptor

目錄 Interceptor 簡介 Interceptor 實現方法 HandlerInterceptor 介面 HandlerInterceptor 介面 AsyncHandlerInterceptor 介面 HandlerInterceptorAdapter 

javaWeb開發之攔截器和過濾器的區別

攔截器和過濾的關係圖   攔截器和過濾器簡要區別 1、攔截器是基於java的反射機制的，而過濾器是基於函式回撥。2、攔截器不依賴與servlet容器，過濾器依賴與servlet容器。3、攔截器只能對action請求起作用，而過濾器則可以對幾乎所有的請求起作用。4、攔截器可以訪問action

第四十章：Spring MVC框架之攔截器10

第八章 攔截器 攔截器最典型的用法是檢查使用者是否登入，登入後可以執行目標handler方法，未登入則跳轉到登入頁面。這樣的操作要是在每個攔截器內部來寫就太麻煩了，統一提取到攔截器中是明智之舉。 1.HandlerInterceptor介面 ①preHandle()方法 簽名：b

Mybatis（攔截器實現）通用mapper及全ORM實現（四）

到目前為止，我們通過mybatis的攔截器完成了一些基礎mapper的功能，接下來我們來看看如何能夠實現一個物件關係對映的全ORM操作。 實體與表、列的定義已經完成了，那剩下要做的就是： 1、定義如何通過物件方式編寫sql語句 2、把查詢物件轉譯成sql去查詢 3、把查詢結