mybatis 攔截器

mybatis攔截器優先級

@Order

@DependsOn

@PostConstruct

ApplicationRunner

前端的菜單和按鈕權限都可以通過配置來實現，但很多時候，后臺查詢數據庫數據的權限需要通過手動添加SQL來實現。

比如員工打卡記錄表，有 id、name、dpt_id、company_id 等字段，后兩個表示部門 ID 和分公司 ID。

查看員工打卡記錄 SQL 為：select id,name,dpt_id,company_id from t_record

當一個總部賬號可以查看全部數據此時，sql 無需改變。因為他可以看到全部數據。

當一個部門管理員權限員工查看全部數據時，sql 需要在末屬添加 where dpt_id = #{dpt_id}

如果每個功能模塊都需要手動寫代碼去拿到當前登陸用戶的所屬部門，然后手動添加where條件，就顯得非常的繁瑣。

因此，可以通過 mybatis 的攔截器拿到查詢 sql 語句，再自動改寫 sql。

mybatis 攔截器

MyBatis 允許你在映射語句執行過程中的某一點進行攔截調用。默認情況下，MyBatis 允許使用插件來攔截的方法調用包括：

Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)

ParameterHandler (getParameterObject, setParameters)

ResultSetHandler (handleResultSets, handleOutputParameters)

StatementHandler (prepare, parameterize, batch, update, query)

這些類中方法的細節可以通過查看每個方法的簽名來發現，或者直接查看 MyBatis 發行包中的源代碼。如果你想做的不僅僅是監控方法的調用，那么你最好相當了解要重寫的方法的行為。因為在試圖修改或重寫已有方法的行為時，很可能會破壞 MyBatis 的核心模塊。這些都是更底層的類和方法，所以使用插件的時候要特別當心。

通過 MyBatis 提供的強大機制，使用插件是非常簡單的，只需實現 Interceptor 接口，并指定想要攔截的方法簽名即可。

分頁插件 pagehelper 就是一個典型的通過攔截器去改寫 SQL 的。

可以看到它通過注解 @Intercepts 和簽名 @Signature 來實現，攔截 Executor 執行器，攔截所有的 query 查詢類方法。

我們可以據此也實現自己的攔截器。

importcom.skycomm.common.util.user.Cpip2UserDeptVo;
importcom.skycomm.common.util.user.Cpip2UserDeptVoUtil;
importlombok.extern.slf4j.Slf4j;
importorg.apache.commons.lang3.StringUtils;
importorg.apache.ibatis.cache.CacheKey;
importorg.apache.ibatis.executor.Executor;
importorg.apache.ibatis.mapping.BoundSql;
importorg.apache.ibatis.mapping.MappedStatement;
importorg.apache.ibatis.mapping.SqlSource;
importorg.apache.ibatis.plugin.Interceptor;
importorg.apache.ibatis.plugin.Intercepts;
importorg.apache.ibatis.plugin.Invocation;
importorg.apache.ibatis.plugin.Signature;
importorg.apache.ibatis.session.ResultHandler;
importorg.apache.ibatis.session.RowBounds;
importorg.springframework.stereotype.Component;
importorg.springframework.web.context.request.RequestAttributes;
importorg.springframework.web.context.request.RequestContextHolder;
importorg.springframework.web.context.request.ServletRequestAttributes;

importjavax.servlet.http.HttpServletRequest;
importjava.lang.reflect.Method;

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

@Override
publicObjectintercept(Invocationinvocation)throwsThrowable{
MappedStatementstatement=(MappedStatement)invocation.getArgs()[0];
Objectparameter=invocation.getArgs()[1];
BoundSqlboundSql=statement.getBoundSql(parameter);
StringoriginalSql=boundSql.getSql();
ObjectparameterObject=boundSql.getParameterObject();

SqlLimitsqlLimit=isLimit(statement);
if(sqlLimit==null){
returninvocation.proceed();
}

RequestAttributesreq=RequestContextHolder.getRequestAttributes();
if(req==null){
returninvocation.proceed();
}

//處理request
HttpServletRequestrequest=((ServletRequestAttributes)req).getRequest();
Cpip2UserDeptVouserVo=Cpip2UserDeptVoUtil.getUserDeptInfo(request);
StringdepId=userVo.getDeptId();

Stringsql=addTenantCondition(originalSql,depId,sqlLimit.alis());
log.info("原SQL：{}，數據權限替換后的SQL：{}",originalSql,sql);
BoundSqlnewBoundSql=newBoundSql(statement.getConfiguration(),sql,boundSql.getParameterMappings(),parameterObject);
MappedStatementnewStatement=copyFromMappedStatement(statement,newBoundSqlSqlSource(newBoundSql));
invocation.getArgs()[0]=newStatement;
returninvocation.proceed();
}

/**
*重新拼接SQL
*/
privateStringaddTenantCondition(StringoriginalSql,StringdepId,Stringalias){
Stringfield="dpt_id";
if(StringUtils.isNoneBlank(alias)){
field=alias+"."+field;
}

StringBuildersb=newStringBuilder(originalSql);
intindex=sb.indexOf("where");
if(indexcls=Class.forName(className);
finalMethod[]method=cls.getMethods();
for(Methodme:method){
if(me.getName().equals(methodName)&&me.isAnnotationPresent(SqlLimit.class)){
sqlLimit=me.getAnnotation(SqlLimit.class);
}
}
}catch(Exceptione){
e.printStackTrace();
}
returnsqlLimit;
}

publicstaticclassBoundSqlSqlSourceimplementsSqlSource{

privatefinalBoundSqlboundSql;

publicBoundSqlSqlSource(BoundSqlboundSql){
this.boundSql=boundSql;
}

@Override
publicBoundSqlgetBoundSql(ObjectparameterObject){
returnboundSql;
}
}
}

順便加了個注解 @SqlLimit，在 mapper 方法上加了此注解才進行數據權限過濾。同時注解有兩個屬性，

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public@interfaceSqlLimit{
/**
*sql表別名
*@return
*/
Stringalis()default"";

/**
*通過此列名進行限制
*@return
*/
StringcolumnName()default"";
}

columnName 表示通過此列名進行限制，一般來說一個系統，各表當中的此列是統一的，可以忽略。

alis 用于標注 sql 表別名，如 針對 sql select * from tablea as a left join tableb as b on a.id = b.id 進行改寫，如果不知道表別名，會直接在后面拼接 where dpt_id = #{dptId},那此 SQL 就會錯誤的，通過別名 @SqlLimit(alis = "a") 就可以知道需要拼接的是 where a.dpt_id = #{dptId}

執行結果。

原 SQL：select * from person， 數據權限替換后的SQL：select * from person where dpt_id = 234。

原 SQL：select * from person where id > 1， 數據權限替換后的 SQL：select * from person where dpt_id = 234 and id > 1。

但是在使用 PageHelper 進行分頁的時候還是有問題。

可以看到先執行了 _COUNT 方法也就是 PageHelper，再執行了自定義的攔截器。

在我們的業務方法中注入 SqlSessionFactory。

@Autowired
@Lazy
privateListsqlSessionFactoryList;

PageInterceptor 為 1，自定義攔截器為 0，跟 order 相反，PageInterceptor 優先級更高，所以越先執行。

基于 Spring Boot + MyBatis Plus + Vue & Element 實現的后臺管理系統 + 用戶小程序，支持 RBAC 動態權限、多租戶、數據權限、工作流、三方登錄、支付、短信、商城等功能

項目地址：https://github.com/YunaiV/ruoyi-vue-pro

視頻教程：https://doc.iocoder.cn/video/

mybatis攔截器優先級

@Order

通過 @Order 控制 PageInterceptor 和 MySqlInterceptor 可行嗎？

將 MySqlInterceptor 的加載優先級調到最高，但測試證明依然不行。

定義 3 個類。

@Component
@Order(2)
publicclassOrderTest1{

@PostConstruct
publicvoidinit(){
System.out.println("00000init");
}
}
@Component
@Order(1)
publicclassOrderTest2{

@PostConstruct
publicvoidinit(){
System.out.println("00001init");
}
}
@Component
@Order(0)
publicclassOrderTest3{

@PostConstruct
publicvoidinit(){
System.out.println("00002init");
}
}

OrderTest1，OrderTest2，OrderTest3 的優先級從低到高。

順序預期的執行順序應該是相反的：

00002init
00001init
00000init

但事實上執行的順序是

00000init
00001init
00002init

@Order 不控制實例化順序，只控制執行順序。@Order 只跟特定一些注解生效 如：@Compent、 @Service、@Aspect … 不生效的如：@WebFilter

所以這里達不到預期效果。

@Priority 類似，同樣不行。

@DependsOn

使用此注解將當前類將在依賴類實例化之后再執行實例化。

在 MySqlInterceptor 上標記@DependsOn("queryInterceptor")

啟動報錯，

這個時候 queryInterceptor 還沒有實例化對象。

@PostConstruct

@PostConstruct 修飾的方法會在服務器加載 Servlet 的時候運行，并且只會被服務器執行一次。在同一個類里，執行順序為順序如下：Constructor > @Autowired > @PostConstruct。

但它也不能保證不同類的執行順序。

PageHelper 的 springboot start 也是通過這個來初始化攔截器的。

ApplicationRunner

在當前 springboot 容器加載完成后執行，那么這個時候 pagehelper 的攔截器已經加入，在這個時候加入自定義攔截器，就能達到我們想要的效果。

仿照 PageHelper 來寫。

@Component
publicclassInterceptRunnerimplementsApplicationRunner{

@Autowired
privateListsqlSessionFactoryList;

@Override
publicvoidrun(ApplicationArgumentsargs)throwsException{
MySqlInterceptormybatisInterceptor=newMySqlInterceptor();
for(SqlSessionFactorysqlSessionFactory:sqlSessionFactoryList){
org.apache.ibatis.session.Configurationconfiguration=sqlSessionFactory.getConfiguration();
configuration.addInterceptor(mybatisInterceptor);
}
}
}

再執行，可以看到自定義攔截器在攔截器鏈當中下標變為了 1（優先級與 order 剛好相反）

后臺打印結果，達到了預期效果。