Mybatis-Plus實(shí)現(xiàn)SQL攔截器的示例

更新時(shí)間：2023年05月09日 14:37:25 作者：KevinQ

這篇文章主要介紹了Mybatis-Plus實(shí)現(xiàn)一個(gè)SQL攔截器,通過(guò)使用SQL攔截器，開(kāi)發(fā)人員可以在執(zhí)行SQL語(yǔ)句之前或之后對(duì)其進(jìn)行修改或記錄，從而更好地控制和優(yōu)化數(shù)據(jù)庫(kù)操作，對(duì)Mybatis-Plus?SQL攔截器相關(guān)知識(shí)感興趣的朋友一起看看吧

起源

最近公司要做多租戶(hù)，Mybatis-Plus的多租戶(hù)插件很好用，但是有一個(gè)場(chǎng)景是：字典表或者某些數(shù)據(jù)表，一些數(shù)據(jù)需要在各個(gè)租戶(hù)之間共享，而數(shù)據(jù)表本身又同時(shí)要實(shí)現(xiàn)多租戶(hù)數(shù)據(jù)隔離，比如字典表：性別等“男”/“女”基礎(chǔ)數(shù)據(jù)。

SQL攔截器是一種用于攔截和修改Mybatis執(zhí)行的SQL語(yǔ)句的工具。通過(guò)使用SQL攔截器，開(kāi)發(fā)人員可以在執(zhí)行SQL語(yǔ)句之前或之后對(duì)其進(jìn)行修改或記錄，從而更好地控制和優(yōu)化數(shù)據(jù)庫(kù)操作。例如MyBatis-Plus的基礎(chǔ)分頁(yè)插件、多租戶(hù)插件就是SQL攔截器，那么，我們是否可以實(shí)現(xiàn)自己的SQL攔截器呢？

答案當(dāng)然是肯定的。

實(shí)現(xiàn)攔截器接口InnerInterceptor

InnerInterceptor 這個(gè)接口是MyBaitsPlus的攔截器接口類(lèi)，實(shí)現(xiàn)它之后，并且通過(guò)MybatisPlusInterceptor配置后，就可以實(shí)現(xiàn)SQL執(zhí)行攔截。

MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
// 多租戶(hù)攔截器
interceptor.addInnerInterceptor(new TenantLineInnerInterceptor(new TenantDatabaseInterceptor(tenantProperties)));
// 多租戶(hù)部分表數(shù)據(jù)共享攔截器
interceptor.addInnerInterceptor(new TenantDatabaseShareInterceptor(new TenantShareHandlerImpl(tenantProperties)));

那么如何實(shí)現(xiàn)該接口以及修改SQL呢？

下面是一個(gè)樣例：

import com.baomidou.mybatisplus.core.interceptor.InnerInterceptor;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.core.parser.SqlParserHelper;
import com.baomidou.mybatisplus.extension.plugins.inner.InnerInterceptorChain;
import net.sf.jsqlparser.parser.CCJSqlParserUtil;
import net.sf.jsqlparser.statement.Statement;
import net.sf.jsqlparser.statement.select.Select;
public class MyInterceptor implements InnerInterceptor {
    @Override
    ```
    @Override
    public void beforeQuery(Executor executor, MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) throws SQLException {
        if (InterceptorIgnoreHelper.willIgnoreTenantLine(ms.getId())) return;
        PluginUtils.MPBoundSql mpBs = PluginUtils.mpBoundSql(boundSql);
        mpBs.sql(parserSingle(mpBs.sql(), null));
    }
}

通過(guò)修改beforeQuery函數(shù)中的代碼，即可修改執(zhí)行的SQL。

修改sql常用的工具類(lèi)

JsqlParserSupport該類(lèi)用于解析與修改SQL，并且MybatisPlus的多租戶(hù)插件更是直接繼承了該類(lèi)。 CCJSqlParserUtil是JSqlParser中用于解析SQL語(yǔ)句的工具類(lèi)。它提供了一些靜態(tài)方法，可以將SQL語(yǔ)句解析為Statement對(duì)象、Select對(duì)象、Update對(duì)象、Insert對(duì)象、Delete對(duì)象等。

常用的類(lèi)還有Expression, Statement等類(lèi)。

例如，使用Expression實(shí)現(xiàn)一個(gè)IN語(yǔ)句：

import net.sf.jsqlparser.expression.Expression;
import net.sf.jsqlparser.expression.LongValue;
import net.sf.jsqlparser.expression.StringValue;
import net.sf.jsqlparser.expression.operators.relational.InExpression;
import net.sf.jsqlparser.expression.operators.relational.ItemsList;
import net.sf.jsqlparser.expression.operators.relational.MultiExpressionList;
import net.sf.jsqlparser.expression.operators.relational.NamedParameter;
import net.sf.jsqlparser.expression.operators.relational.SubSelect;
import net.sf.jsqlparser.parser.CCJSqlParserUtil;
public class JSqlParserExample {
    public static void main(String[] args) throws Exception {
        // IN語(yǔ)句
        InExpression inExpr = new InExpression();
        inExpr.setLeftExpression(CCJSqlParserUtil.parseExpression("age"));
        ItemsList valueList = new MultiExpressionList();
        ((MultiExpressionList) valueList).addExpressions(new LongValue(18), new LongValue(21), new LongValue(30));
        inExpr.setItemsList(valueList);
        System.out.println(inExpr.toString());
        // 子查詢(xún)
        InExpression subqueryInExpr = new InExpression();
        subqueryInExpr.setLeftExpression(CCJSqlParserUtil.parseExpression("age"));
        SubSelect subquery = new SubSelect();
        subquery.setSelectBody(CCJSqlParserUtil.parse("SELECT age FROM users WHERE country = 'US'"));
        subqueryInExpr.setRightExpression(subquery);
        System.out.println(subqueryInExpr.toString());
    }
}

到此這篇關(guān)于Mybatis-Plus實(shí)現(xiàn)一個(gè)SQL攔截器的文章就介紹到這了,更多相關(guān)Mybatis-Plus SQL攔截器內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: