mybatis 记录sql执行前后的数据变化

mybatis 记录sql执行前后的数据变化

此方法并不完善，只是简单记录。

以update语句为例。通过mybatis的拦截器拦截sql，然后提取出表名和条件，查询出来原始数据，然后保存数据和update语句。这样就可以对比原始数据，和执行sql的改变的数据。

delete和insert 只记录sql，直接插入记录中。

注意：如果记录要插入数据库，那么记录表要记的忽略。不然会一直调用

import cn.hutool.core.collection.CollUtil;
import com.alibaba.fastjson.JSON;
import com.fastrun.common.core.domain.model.LoginUser;
import com.fastrun.common.utils.NumberUtils;
import com.fastrun.common.utils.SecurityUtils;
import com.fastrun.common.utils.spring.SpringUtils;
import com.fastrun.common.utils.sql.SqlUtil;
import com.fastrun.system.domain.SysOprLog;
import com.fastrun.system.mapper.PlugMapper;
import com.fastrun.system.service.impl.SysOprLogServiceImpl;
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.ParameterMapping;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.reflection.metaObject;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.type.TypeHandlerRegistry;
import org.springframework.security.core.Authentication;
import org.springframework.stereotype.Component;

import java.text.DateFormat;
import java.util.*;
import java.util.regex.Matcher;

@Component
@Intercepts({
        @Signature(type = Executor.class, method = "update", args = {MappedStatement.class, Object.class})})
@SuppressWarnings({"unchecked", "rawtypes"})
public class MybatisInterceptor implements Interceptor {

    @Override
    public Object intercept(Invocation invocation) throws Throwable {

        try {
            // 获取xml中的一个select/update/insert/delete节点，是一条SQL语句
            MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];
            Object parameter = null;
            if (invocation.getArgs().length > 1) {
                parameter = invocation.getArgs()[1];
            }

            // BoundSql就是封装myBatis最终产生的sql类
            BoundSql boundSql = mappedStatement.getBoundSql(parameter);

            // 获取节点的配置
            Configuration configuration = mappedStatement.getConfiguration();
            // 获取到最终的sql语句
            String sql = showSql(configuration, boundSql);
            String tableName = SqlUtil.getTableNames(boundSql.getSql()).get(0);
            String[] sqlArr = sql.split("where");

            String where = "";
            if (sqlArr.length == 2) {
                where = sqlArr[1];
            }

            if (!isIgnoreTable(tableName)) {
                Long userId = null;
                try {
                    Authentication authentication = SecurityUtils.getAuthentication();
                    if (null != authentication) {
                        Object loginUser = authentication.getPrincipal();
                        if (loginUser instanceof LoginUser) {
                            userId = ((LoginUser) loginUser).getUserId();
                        }
                    }
                } catch (Exception e) {
                    e.printStackTrace();
                }

                if (NumberUtils.isPositive(userId)) {
                    String cmdType = mappedStatement.getSqlCommandType().name();
                    SysOprLog oprLog = new SysOprLog();
                    if ("update".equalsIgnoreCase(cmdType)) {
                        List> obj = SpringUtils.getBean(PlugMapper.class).selectObject(tableName, where);
                        oprLog.setOldData(JSON.toJSonString(obj));
                    }
                    oprLog.setSqlTxt(sql);
                    oprLog.setOptType(mappedStatement.getSqlCommandType().name());
                    oprLog.setTableName(tableName);
                    oprLog.setUserId(SecurityUtils.getUserId());
                    SpringUtils.getBean(SysOprLogServiceImpl.class).save(oprLog);
                }
            }

        } catch (Exception e) {
            e.printStackTrace();
        }
        // 执行完上面的任务后，不改变原有的sql执行过程
        return invocation.proceed();
    }

    private boolean isIgnoreTable(String tableName) {
        List ignoreTableList = new ArrayList<>();
        ignoreTableList.add("sys_oper_log");

        if (ignoreTableList.contains(tableName)) {
            return true;
        }
        return false;
    }

    // 封装了一下sql语句，使得结果返回完整xml路径下的sql语句节点id + sql语句
    public static String getSql(Configuration configuration, BoundSql boundSql, String sqlId) {
        String sql = showSql(configuration, boundSql);
        StringBuilder str = new StringBuilder(100);
        str.append(sqlId);
        str.append(":");
        str.append(sql);
        return str.toString();
    }

    // 如果参数是String，则添加单引号， 如果是日期，则转换为时间格式器并加单引号； 对参数是null和不是null的情况作了处理
    private static String getParameterValue(Object obj) {
        String value = null;
        if (obj instanceof String) {
            value = "'" + obj.toString() + "'";
        } else if (obj instanceof Date) {
            DateFormat formatter = DateFormat.getDateTimeInstance(DateFormat.DEFAULT,
                    DateFormat.DEFAULT, Locale.CHINA);
            value = "'" + formatter.format(new Date()) + "'";
        } else {
            if (obj != null) {
                value = obj.toString();
            } else {
                value = "";
            }
        }
        return value;
    }

    // 进行？的替换
    public static String showSql(Configuration configuration, BoundSql boundSql) {
        // 获取参数
        Object parameterObject = boundSql.getParameterObject();
        List parameterMappings = boundSql.getParameterMappings();
        // sql语句中多个空格都用一个空格代替
        String sql = boundSql.getSql().replaceAll("[\s]+", " ");
        if (CollUtil.isNotEmpty(parameterMappings) && parameterObject != null) {
            // 获取类型处理器注册器，类型处理器的功能是进行java类型和数据库类型的转换
            TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
            // 如果根据parameterObject.getClass(）可以找到对应的类型，则替换
            if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
                sql = sql.replaceFirst("\?",
                        Matcher.quoteReplacement(getParameterValue(parameterObject)));
            } else {
                // metaObject主要是封装了originalObject对象，提供了get和set的方法用于获取和设置originalObject的属性值,主要支持对JavaBean、Collection、Map三种类型对象的 *** 作
                metaObject metaObject = configuration.newmetaObject(parameterObject);
                for (ParameterMapping parameterMapping : parameterMappings) {
                    String propertyName = parameterMapping.getProperty();
                    if (metaObject.hasGetter(propertyName)) {
                        Object obj = metaObject.getValue(propertyName);
                        sql = sql.replaceFirst("\?",
                                Matcher.quoteReplacement(getParameterValue(obj)));
                    } else if (boundSql.hasAdditionalParameter(propertyName)) {
                        // 该分支是动态sql
                        Object obj = boundSql.getAdditionalParameter(propertyName);
                        sql = sql.replaceFirst("\?",
                                Matcher.quoteReplacement(getParameterValue(obj)));
                    } else {
                        // 打印出缺失，提醒该参数缺失并防止错位
                        sql = sql.replaceFirst("\?", "缺失");
                    }
                }
            }
        }
        return sql;
    }

    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }

    @Override
    public void setProperties(Properties properties) {

    }
}