mybatis實戰之攔截器解讀

2023-03-21 06:02:22

mybatis實戰之攔截器

在服務的開發過程中，往往存在這樣的需求，針對業務，實現對資料庫操作語句做統一的處理。

比如對某些敏感資料如使用者姓名、手機號等坐脫敏處理儲存和查詢、對未實現許可權的查詢通過新增關聯查詢實現許可權控制查詢結果等等。

這時，mybatis框架提供了攔截器的方式，允許在對映語句執行過程中的某一點進行攔截呼叫，進行自己的業務處理。

1、使用方法

這裡參考了官網的使用說明，只需實現 Interceptor 介面，並在類中指定想要攔截的方法簽名即可。

比如：

@Intercepts({@Signature(
  type= Executor.class,
  method = "update",
  args = {MappedStatement.class,Object.class})})
public class ExamplePlugin implements Interceptor {
  private Properties properties = new Properties();
  public Object intercept(Invocation invocation) throws Throwable {
    // implement pre processing if need
    Object returnObject = invocation.proceed();
    // implement post processing if need
    return returnObject;
  }
  public void setProperties(Properties properties) {
    this.properties = properties;
  }
}

然後在mybatis的組態檔中，新增外掛的對應設定即可。

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

我們也可以在程式碼中新增，下面給出在spring中

//通過spring查詢SqlSessionFactory物件的邏輯在此省略
SqlSessionFactory sqlSessionFactory = (SqlSessionFactory) var3;
org.apache.ibatis.session.Configuration c = sqlSessionFactory.getConfiguration();
c.addInterceptor(interceptor);

分別加上處理的業務邏輯，這個攔截器就可以使用了。

2、需要注意的地方

第一節簡單介紹了，攔截器的使用方法，但在實際專案中這樣還遠遠不夠。

筆者在本節列舉了一些需要注意的地方，供大家思考討論。

攔截器的執行順序

攔截器的呼叫順序分為兩大種，第一種是攔截的不同物件，第二種是指攔截同一種物件的同一個方法。

第一種情況，例如攔截 Executor 和攔截 StatementHandler 就屬於不同的攔截物件，這兩類的攔截器在整體執行的邏輯上是不同的。

StatementHandler 屬於 Executor 執行過程中的一個子過程。

所以這兩種不同類別的外掛在設定時，一定是先執行 Executor 的攔截器，然後才會輪到 StatementHandler。

所以這種情況下設定攔截器的順序就不重要了，在 MyBatis 邏輯上就已經控制了先後順序。

第二種情況，例如都攔截 Executor 的 query 方法，這時你設定攔截器的順序就會對這裡有影響了。比如設定如下。

<plugins>
    <plugin interceptor="com.github.pagehelper.ExecutorQueryInterceptor1"/>
    <plugin interceptor="com.github.pagehelper.ExecutorQueryInterceptor2"/>
    <plugin interceptor="com.github.pagehelper.ExecutorQueryInterceptor3"/>
</plugins>

前面我們設定攔截器的順序是1，2，3。在這裡也會按照 1，2，3 的順序被層層代理，代理後的結構如下：

Interceptor3:{
    Interceptor2: {
        Interceptor1: {
            target: Executor
        }
    }
}

然後到執行的邏輯：

Interceptor3 前置處理
Interceptor2 前置處理
Interceptor1 前置處理
Object result = executor.query(4個引數方法);
Interceptor1 後續處理
Interceptor2 後續處理
Interceptor3 後續處理
return result;

順序就是 3>2>1>Executor>1>2>3。MyBatis的攔截器採用責任鏈設計模式，多個攔截器之間的責任鏈是通過動態代理組織的。

我們一般都會在攔截器中的intercept方法中往往會有invocation.proceed()語句，其作用是將攔截器責任鏈向後傳遞，本質上便是動態代理的invoke。

與常用外掛的整合遇到的問題

pageHelper造成分頁失效的問題

通過檢視pagehelper原始碼，可以看到其inercept方法直接獲取了excutor然後開始分頁查詢，當查詢到結果時，便返回了。

就是pagehelper的intercept方法中沒有invocation.proceed()，這意味著什麼？

//com.github.pagehelper.PageInterceptor#intercept
.....
                resultList = executor.query(ms, parameter, rowBounds, resultHandler, cacheKey, boundSql);
            }
            return dialect.afterPage(resultList, parameter, rowBounds);
        } finally {
            dialect.afterAll();
        }

這意味著pagehelper沒有繼續向後傳遞責任鏈，而是自行處理直接返回。

由此，我們可以猜出該問題大概率與攔截器的執行順序有關。

通過斷點偵錯，驗證了該猜想，當遇到分頁查詢時，執行到pagehelper就結束了，沒有進入我們的自定義攔截器。這就可能造成我們自定義攔截器失效。

解決方案

因為PageHelper是Excetor型別的攔截器，所以我們如果想要在PageHelper攔截器前面執行，就必須要將我們自己的攔截器新增到他的攔截器後面。

這裡只介紹最簡單最優雅的一種方式：

註冊一個ApplicationListener監聽器，監聽 ContextRefreshedEvent 事件，當所有的bean都初始化完成後（即PageHelper也已經註冊好了），再把我們的自定義 MyBatis 攔截器註冊到 SqlSessionFactory 中。

可以提升的點

Interceptor介面提供了三個方法分別是攔截器處理邏輯的主要方法、判斷是否要進行攔截，然後做出決定是否生成一個代理的方法及設定引數的方法。

package org.apache.ibatis.plugin;

import java.util.Properties;

public interface Interceptor {

  Object intercept(Invocation invocation) throws Throwable;

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

  default void setProperties(Properties properties) {
    // NOP
  }
}

這裡說的提升點，就是在實現介面的實現類中，我們可以在plugin方法里加上一個判斷，因為預設情況下，攔截器根據順序攔截後，就可以去處理對應邏輯了，這裡加上一個判斷攔截的條件，可以減少代理類的建立。

    @Override
    public Object plugin(Object target) {
        if (target instanceof StatementHandler && checkIfNeeded((StatementHandler) target)) {
            return Plugin.wrap(target, this);
        } else {
            return target;
        }
    }

參考檔案：

總結

以上為個人經驗，希望能給大家一個參考，也希望大家多多支援it145.com。

mybatis實戰之攔截器解讀

目錄