mybatis-plus拦截delete类型的SQL

背景在一些对数据安全要求比较高的系统中,因为业务的需要,我们需要对mybatis中delete语句进行一些业务拦截或者校验。
实现:通过Mybatis-Plus的Interceptor接口实现,拦截StatementHandler,判断sql语句的前缀是否是delete关键字,从而实现拦截逻辑

package com.example.demo.mybatisplus;

import com.baomidou.mybatisplus.core.toolkit.CollectionUtils;
import com.google.common.base.Joiner;
import lombok.extern.slf4j.Slf4j;
import net.sf.jsqlparser.parser.CCJSqlParserUtil;
import net.sf.jsqlparser.statement.Statement;
import net.sf.jsqlparser.statement.Statements;
import net.sf.jsqlparser.statement.delete.Delete;
import org.apache.ibatis.executor.parameter.ParameterHandler;
import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.reflection.DefaultReflectorFactory;
import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.reflection.ReflectorFactory;
import org.apache.ibatis.reflection.factory.DefaultObjectFactory;
import org.apache.ibatis.reflection.factory.ObjectFactory;
import org.apache.ibatis.reflection.wrapper.DefaultObjectWrapperFactory;
import org.apache.ibatis.reflection.wrapper.ObjectWrapperFactory;
import org.apache.ibatis.scripting.defaults.DefaultParameterHandler;

import java.sql.*;
import java.util.*;

@Intercepts({@Signature(type = StatementHandler.class, method = "prepare",
        args = {Connection.class, Integer.class})})
@Slf4j
public class DeleteEventInterceptor implements Interceptor {

    private static final ReflectorFactory REFLECTOR_FACTORY = new DefaultReflectorFactory();
    private static final DefaultObjectFactory OBJECT_FACTORY = new DefaultObjectFactory();
    private static final DefaultObjectWrapperFactory OBJECT_WRAPPER_FACTORY = new DefaultObjectWrapperFactory();

    private final static String ADDITIONAL_PARAMETERS = "additionalParameters";

    /**
     * 不需要拦截的表
     */
    private final HashSet<String> tableExcluded = new HashSet<>();

    public DeleteEventInterceptor(Collection<String> tableExcluded) {
        if (CollectionUtils.isNotEmpty(tableExcluded)) {
            tableExcluded.forEach(tableName -> this.tableExcluded.add(tableName.toLowerCase()));
        }
    }

    /**
     * 删掉特殊符号`
     */
    private String trimSpecificSymbol(String str) {
        return str.replaceAll("`", "");
    }

/**
*1、intercept()方法是Interceptor的核心业务逻辑
**/
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
//获取代理对象
        final Object target = invocation.getTarget();
        if (target instanceof StatementHandler) {
            StatementHandler delegate = (StatementHandler) target;
//StatementHandler对象可以回去我们需要运行的sql以及sql的参数
            BoundSql boundSql = delegate.getBoundSql();
            String sql = boundSql.getSql().trim();

//判断sql是不是delete类型的sql
            if ("delete".equalsIgnoreCase(sql.substring(0, 6))) {

                Statements statements = CCJSqlParserUtil.parseStatements(sql);
                Statement statement = statements.getStatements().get(0);

                //获取删掉特殊符号`后的表名
                String tableName = trimSpecificSymbol(((Delete) statement).getTable().getName());

                //判断当前表是否配置允许删除
                if (tableExcluded.contains(tableName.toLowerCase())) {
                    return invocation.proceed();
                }
               //Invocation居然还可以获取到当前mybatis同数据库的连接
                Connection conn = (Connection) invocation.getArgs()[0];
              //我们的业务逻辑,把需要删除的数据插入到另一个表保存
                insertToDeletedTable(conn, delegate, (Delete) statement, tableName);
            }
        }
        return invocation.proceed();
    }

/**
*1、plugin()方法是Inteceptor接口实现类的逻辑入口,
*2、Plugin.wrap(target, this)返回的是target的动态代理对象
*3、StatementHandler的方法调用时会先调用其对应的拦截器,也就是上面@Intercepts里面的信息,调用拦截器时,会调用intercept()方法的逻辑
**/
    @Override
    public Object plugin(Object target) {
        if (target instanceof StatementHandler && "delete"
                .equalsIgnoreCase(((StatementHandler) target).getBoundSql().getSql().substring(0, 6))) {
            return Plugin.wrap(target, this);
        } else {
            return target;
        }
    }

    @Override
    public void setProperties(Properties properties) {

    }

    private void insertToDeletedTable(Connection conn, StatementHandler delegate,
                                      Delete statement, String tableName) throws SQLException {
        final MetaObject metaStatementHandler = getMetaObject(delegate);
        MappedStatement mappedStatement = (MappedStatement) metaStatementHandler
                .getValue("delegate.mappedStatement");

//可以通过这个判断拦截我们的delete是否有写where条件
        if (statement.getWhere() == null) {
            throw new IllegalArgumentException("删除操作必须填写WHERE条件");
        }

        List<String> columns = getTableColumns(conn, tableName);
        if (columns.isEmpty()) {
            return;
        }

        //拼接 `column1`,`column2` 串
        String insertColumns = "`" + Joiner.on("`,`").join(columns) + "`";

        String where = statement.getWhere().toString();

        String limit = statement.getLimit() != null ? statement.getLimit().toString() : "";

        // 获取相关delete表名
        String deletedTable = "d" + tableName.substring(1);
        // 生成插入delete表的sql
        String insertSql = String
                .format("INSERT INTO %s (%s) SELECT %s FROM %s WHERE %s %s",
                        deletedTable, insertColumns, insertColumns, tableName, where, limit);
        BoundSql boundSql = delegate.getBoundSql();

        // 构造插入delete表的mybatis sql

        BoundSql insertBoundSql = new BoundSql(mappedStatement.getConfiguration(), insertSql,
                boundSql.getParameterMappings(), boundSql.getParameterObject());

        Map<String, Object> additionalParameters = (Map<String, Object>) getMetaObject(boundSql)
                .getValue(ADDITIONAL_PARAMETERS);
        for (Map.Entry<String, Object> entry : additionalParameters.entrySet()) {
            insertBoundSql.setAdditionalParameter(entry.getKey(), entry.getValue());
        }

        // 构造mybatis的参数处理器
        ParameterHandler parameterHandler = new DefaultParameterHandler(mappedStatement,
                boundSql.getParameterObject(), insertBoundSql);

        //log.info("insertSql:{}", formatSql(insertBoundSql.getSql(), mappedStatement.getConfiguration(), insertBoundSql));
        try (PreparedStatement stmt = conn.prepareStatement(insertSql)) {
            // mybatis填充查询参数
            parameterHandler.setParameters(stmt);
            stmt.executeUpdate();
        }
    }

    private List<String> getTableColumns(Connection conn, String tableName) throws SQLException {
        List<String> columns = new LinkedList<>();
        try (PreparedStatement structStmt =
                     conn.prepareStatement(String.format("SELECT * FROM %s LIMIT 1", tableName))) {
//居然可以通过ResultSet获取到表的所有列表字段名
            try (ResultSet rs = structStmt.executeQuery()) {
                ResultSetMetaData metaData = rs.getMetaData();

                for (int i = 0; i < metaData.getColumnCount(); i++) {
                    columns.add(metaData.getColumnName(i + 1)); // 从第一个取
                }
            }
        }
        return columns;
    }

/**
*1、MetaObject是mybatis的反射工具类
*2、通过该工具类可以很方便的知道某个类是否有什么方法,
*什么属性以及给属性赋值、还可以获取类属性的属性(比如:*School.student.name)等等,反正MetaObject很强大
*/
    private MetaObject getMetaObject(Object obj) {
        ObjectFactory objectFactory = OBJECT_FACTORY;
        ObjectWrapperFactory objectWrapperFactory = OBJECT_WRAPPER_FACTORY;
        MetaObject metaStatementHandler = MetaObject
                .forObject(obj, objectFactory, objectWrapperFactory, REFLECTOR_FACTORY);

//如果是object是代理对象获取目标对象
        while (metaStatementHandler.hasGetter("h")) {
            Object object = metaStatementHandler.getValue("h");
            metaStatementHandler = MetaObject
                    .forObject(object, objectFactory, objectWrapperFactory, REFLECTOR_FACTORY);
        }

        if (metaStatementHandler.hasGetter("target")) {
            Object object = metaStatementHandler.getValue("target");
            metaStatementHandler = MetaObject
                    .forObject(object, objectFactory, objectWrapperFactory, REFLECTOR_FACTORY);
        }
        return metaStatementHandler;
    }
}

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,525评论 6 507
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,203评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,862评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,728评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,743评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,590评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,330评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,244评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,693评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,885评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,001评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,723评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,343评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,919评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,042评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,191评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,955评论 2 355

推荐阅读更多精彩内容