MyBatis/mybatis-plus项目打印SQL的方法实现

package com.xa.demo1.config;

import lombok.extern.slf4j.slf4j;
import org.apache.ibatis.cache.cachekey;
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.interceptor;
import org.apache.ibatis.plugin.intercepts;
import org.apache.ibatis.plugin.invocation;
import org.apache.ibatis.plugin.plugin;
import org.apache.ibatis.plugin.signature;
import org.apache.ibatis.reflection.metaobject;
import org.apache.ibatis.session.configuration;
import org.apache.ibatis.session.resulthandler;
import org.apache.ibatis.session.rowbounds;
import org.apache.ibatis.type.typehandlerregistry;
import org.springframework.util.objectutils;

import java.text.dateformat;
import java.util.date;
import java.util.list;
import java.util.locale;
import java.util.properties;
import java.util.regex.matcher;

/**
 * @author akazaakari   实现一个优雅打日志的功能
 * @intercepts 注解：
 *
 * 这是 mybatis 提供的一个注解，用于定义一个拦截器。一个拦截器可以拦截一个或多个方法。
 * @signature 注解：
 *
 * 这是 @intercepts 注解的子注解，用于指定要拦截的目标方法。
 *
 * @signature 注解的参数分别是：
 *
 *     type：指定要拦截的接口类型。
 *
 *     method：指定要拦截的方法名。
 *
 *     args：指定要拦截的方法的参数类型列表。
 *      todo： 这一章其他内容之后补上（intercepts注解、mybatis插件开发过程中的各个对象
 */
@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}),
        @signature(type = executor.class, method = "update", args = {mappedstatement.class, object.class})
})
@slf4j
public class sqlinterceptor implements interceptor {

    @override
    public object intercept(invocation invocation) throws throwable {
        // 计算这一次sql执行钱后的时间，统计一下执行耗时
        long starttime = system.currenttimemillis();
        object proceed = invocation.proceed();
        long endtime = system.currenttimemillis();

        string printsql = null;
        try {
            // 通过generatesql方法拿到最终生成的sql
            printsql = generatesql(invocation);
        }catch (exception exception){
            log.error("获取sql异常",exception);
        }finally {
            // 拼接日志打印过程
            long costtime = endtime - starttime;
            log.info("\n 执行sql耗时：{}ms \n 执行sql：{}",costtime,printsql);
        }
        return proceed;
    }

    private static string generatesql(invocation invocation){
        // 获取到boundsql以及configuration对象
        // boundsql 对象存储了一条具体的 sql 语句及其相关参数信息。
        // configuration 对象保存了 mybatis 框架运行时所有的配置信息
        mappedstatement statement = (mappedstatement) invocation.getargs()[0];
        object parameter = null;
        if (invocation.getargs().length>1){
            parameter = invocation.getargs()[1];
        }
        configuration configuration = statement.getconfiguration();
        boundsql boundsql = statement.getboundsql(parameter);

        // 获取参数对象
        object parameterobject = boundsql.getparameterobject();
        // 获取参数映射
        list<parametermapping> params = boundsql.getparametermappings();
        // 获取到执行的sql
        string sql = boundsql.getsql();
        // sql中多个空格使用一个空格代替
        sql = sql.replaceall("[\\s]+", " ");
        if (!objectutils.isempty(params) && !objectutils.isempty(parameterobject)){
            // typehandlerregistry 是 mybatis 用来管理 typehandler 的注册器。typehandler 用于在 java 类型和 jdbc 类型之间进行转换
            typehandlerregistry typehandlerregistry = configuration.gettypehandlerregistry();
            // 如果参数对象的类型有对应的 typehandler，则使用 typehandler 进行处理
            if (typehandlerregistry.hastypehandler(parameterobject.getclass())){
                sql = sql.replacefirst("\\?", matcher.quotereplacement(getparametervalue(parameterobject)));
            }else {
                // 否则，逐个处理参数映射
                for (parametermapping param : params) {
                    // 获取参数的属性名
                    string propertyname = param.getproperty();
                    metaobject metaobject = configuration.newmetaobject(parameterobject);
                    // 检查对象中是否存在该属性的 getter 方法，如果存在就取出来进行替换
                    if (metaobject.hasgetter(propertyname)){
                        object obj = metaobject.getvalue(propertyname);
                        sql = sql.replacefirst("\\?", matcher.quotereplacement(getparametervalue(obj)));
                        // 检查 boundsql 对象中是否存在附加参数。附加参数可能是在动态 sql 处理中生成的，有的话就进行替换
                    }else if (boundsql.hasadditionalparameter(propertyname)){
                        object obj = boundsql.getadditionalparameter(propertyname);
                        sql = sql.replacefirst("\\?", matcher.quotereplacement(getparametervalue(obj)));
                    }else {
                        // 如果都没有，说明sql匹配不上，带上“缺失”方便找问题
                        sql = sql.replacefirst("\\?", "缺失");
                    }
                }
            }
        }
        return sql;
    }

    private static string getparametervalue(object object) {
        string value = "";
        if (object instanceof string){
            value = "'" + object.tostring() + "'";
        }else if (object instanceof date){
            dateformat format = dateformat.getdatetimeinstance(dateformat.default, dateformat.default, locale.china);
            value = "'" + format.format((date) object) + "'";
        } else if (!objectutils.isempty(object)) {
            value = object.tostring();
        }
        return value;
    }

    @override
    public object plugin(object target) {
        return plugin.wrap(target, this);
    }

    @override
    public void setproperties(properties properties) {
        // 可以通过properties配置插件参数
    }
}

/**
     * @title: mybatisconfigurationcustomizer
     * @description: 编写一个mybatis的配置类，将这个插件注册进去
     * @createddate: 2024/06/16 00:06
     * @param
     * @return configurationcustomizer
     **/
    @bean
    public configurationcustomizer mybatisconfigurationcustomizer() {
        return configuration -> {
            configuration.addinterceptor(new sqlinterceptor());
        };
    }