最新国产好看的视频,伊人天堂AV在线,国产Aaaaaa视频,蜜臀视频在线观看一区,人妻av色图,密臀久久久精品影片,青青视频免费观看毛片,久草在线观看视,国产三级精品色情在线

MyBatis/mybatis-plus項(xiàng)目打印SQL的方法實(shí)現(xiàn)

 更新時(shí)間:2024年07月31日 09:29:35   作者:ジ北陌え生  
SpringBoot項(xiàng)目中,經(jīng)常需要打印SQL語(yǔ)句及其參數(shù),本文就來(lái)介紹一下MyBatis/mybatis-plus項(xiàng)目打印SQL的方法實(shí)現(xiàn),具有一定的參考價(jià)值,感興趣的可以了解一下

在使用MyBatis或者M(jìn)yBatis-Plus作為ORM框架的時(shí)候,會(huì)發(fā)現(xiàn)默認(rèn)的日志輸出是下面這樣的

在這里插入圖片描述

在參數(shù)少并且SQL簡(jiǎn)單的情況下,這樣的SQL我們能通過(guò)手動(dòng)去替換占位符,來(lái)獲取到真正執(zhí)行的SQL。但是如果是比較復(fù)雜的SQL,或者查詢參數(shù)比較多的話,一個(gè)個(gè)替換就比較費(fèi)時(shí)費(fèi)力了。

MyBatis Plugin于是我們就可以使用MyBatis對(duì)外暴露出的Interceptor接口,來(lái)手動(dòng)實(shí)現(xiàn)一個(gè)能優(yōu)雅地打印日志的插件。平常像用的比較多的PageHelper,就是一個(gè)MyBatis的插件,實(shí)現(xiàn)原理和我們這次要做的功能十分相似。

MyBatis插件的原理

MyBatis插件的實(shí)現(xiàn)原理基于Java的動(dòng)態(tài)代理機(jī)制。當(dāng)MyBatis框架在初始化時(shí)檢測(cè)到有插件配置,它會(huì)為目標(biāo)對(duì)象(如Executor、StatementHandler等)創(chuàng)建一個(gè)代理對(duì)象。這個(gè)代理對(duì)象會(huì)包裝原始對(duì)象,并在方法調(diào)用時(shí)執(zhí)行自定義的攔截邏輯。
攔截過(guò)程中,如果存在攔截器,且方法的簽名與攔截器配置的方法簽名匹配,則調(diào)用攔截器的intercept方法。在intercept方法中,開(kāi)發(fā)者可以實(shí)現(xiàn)自定義的攔截邏輯,通常這里會(huì)包含對(duì)原始方法調(diào)用的修改或增強(qiáng)

MyBatis 插件的幾個(gè)重點(diǎn)模塊

  • @Intercepts 注解:這是 MyBatis 提供的一個(gè)注解,用于定義一個(gè)攔截器。一個(gè)攔截器可以攔截一個(gè)或多個(gè)方法。
  • @Signature 注解:這是 @Intercepts 注解的子注解,用于指定要攔截的目標(biāo)方法。

@Signature 注解的參數(shù)分別是:

  • type:指定要攔截的接口類型。
  • method:指定要攔截的方法名。
  • args:指定要攔截的方法的參數(shù)類型列表。

實(shí)現(xiàn)一個(gè)優(yōu)雅打日志的功能

首先編寫一個(gè)Interceptor的實(shí)現(xiàn)類,具體代碼如下,所有的注釋都放在代碼上了:

其中類上的Intercepts注解含義為:在 Executor 的 query、update 方法執(zhí)行前后進(jìn)行自定義的處理,其中Executor 是最底層的執(zhí)行器,負(fù)責(zé)與數(shù)據(jù)庫(kù)進(jìn)行通信。它的職責(zé)包括創(chuàng)建和緩存 Statement 對(duì)象、執(zhí)行 SQL 語(yǔ)句、處理結(jié)果集等。

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   實(shí)現(xiàn)一個(gè)優(yōu)雅打日志的功能
 * @Intercepts 注解:
 *
 * 這是 MyBatis 提供的一個(gè)注解,用于定義一個(gè)攔截器。一個(gè)攔截器可以攔截一個(gè)或多個(gè)方法。
 * @Signature 注解:
 *
 * 這是 @Intercepts 注解的子注解,用于指定要攔截的目標(biāo)方法。
 *
 * @Signature 注解的參數(shù)分別是:
 *
 *     type:指定要攔截的接口類型。
 *
 *     method:指定要攔截的方法名。
 *
 *     args:指定要攔截的方法的參數(shù)類型列表。
 *      todo: 這一章其他內(nèi)容之后補(bǔ)上(Intercepts注解、MyBatis插件開(kāi)發(fā)過(guò)程中的各個(gè)對(duì)象
 */
@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 {
        // 計(jì)算這一次SQL執(zhí)行錢后的時(shí)間,統(tǒng)計(jì)一下執(zhí)行耗時(shí)
        long startTime = System.currentTimeMillis();
        Object proceed = invocation.proceed();
        long endTime = System.currentTimeMillis();

        String printSql = null;
        try {
            // 通過(guò)generateSql方法拿到最終生成的SQL
            printSql = generateSql(invocation);
        }catch (Exception exception){
            log.error("獲取sql異常",exception);
        }finally {
            // 拼接日志打印過(guò)程
            long costTime = endTime - startTime;
            log.info("\n 執(zhí)行SQL耗時(shí):{}ms \n 執(zhí)行SQL:{}",costTime,printSql);
        }
        return proceed;
    }

    private static String generateSql(Invocation invocation){
        // 獲取到BoundSql以及Configuration對(duì)象
        // BoundSql 對(duì)象存儲(chǔ)了一條具體的 SQL 語(yǔ)句及其相關(guān)參數(shù)信息。
        // Configuration 對(duì)象保存了 MyBatis 框架運(yùn)行時(shí)所有的配置信息
        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);

        // 獲取參數(shù)對(duì)象
        Object parameterObject = boundSql.getParameterObject();
        // 獲取參數(shù)映射
        List<ParameterMapping> params = boundSql.getParameterMappings();
        // 獲取到執(zhí)行的SQL
        String sql = boundSql.getSql();
        // SQL中多個(gè)空格使用一個(gè)空格代替
        sql = sql.replaceAll("[\\s]+", " ");
        if (!ObjectUtils.isEmpty(params) && !ObjectUtils.isEmpty(parameterObject)){
            // TypeHandlerRegistry 是 MyBatis 用來(lái)管理 TypeHandler 的注冊(cè)器。TypeHandler 用于在 Java 類型和 JDBC 類型之間進(jìn)行轉(zhuǎn)換
            TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
            // 如果參數(shù)對(duì)象的類型有對(duì)應(yīng)的 TypeHandler,則使用 TypeHandler 進(jìn)行處理
            if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())){
                sql = sql.replaceFirst("\\?", Matcher.quoteReplacement(getParameterValue(parameterObject)));
            }else {
                // 否則,逐個(gè)處理參數(shù)映射
                for (ParameterMapping param : params) {
                    // 獲取參數(shù)的屬性名
                    String propertyName = param.getProperty();
                    MetaObject metaObject = configuration.newMetaObject(parameterObject);
                    // 檢查對(duì)象中是否存在該屬性的 getter 方法,如果存在就取出來(lái)進(jìn)行替換
                    if (metaObject.hasGetter(propertyName)){
                        Object obj = metaObject.getValue(propertyName);
                        sql = sql.replaceFirst("\\?", Matcher.quoteReplacement(getParameterValue(obj)));
                        // 檢查 BoundSql 對(duì)象中是否存在附加參數(shù)。附加參數(shù)可能是在動(dòng)態(tài) SQL 處理中生成的,有的話就進(jìn)行替換
                    }else if (boundSql.hasAdditionalParameter(propertyName)){
                        Object obj = boundSql.getAdditionalParameter(propertyName);
                        sql = sql.replaceFirst("\\?", Matcher.quoteReplacement(getParameterValue(obj)));
                    }else {
                        // 如果都沒(méi)有,說(shuō)明SQL匹配不上,帶上“缺失”方便找問(wèn)題
                        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) {
        // 可以通過(guò)properties配置插件參數(shù)
    }
}

接著編寫一個(gè)MyBatis的配置類,將這個(gè)插件注冊(cè)進(jìn)去

/**
     * @Title: mybatisConfigurationCustomizer
     * @Description: 編寫一個(gè)MyBatis的配置類,將這個(gè)插件注冊(cè)進(jìn)去
     * @CreatedDate: 2024/06/16 00:06
     * @Param
     * @Return ConfigurationCustomizer
     **/
    @Bean
    public ConfigurationCustomizer mybatisConfigurationCustomizer() {
        return configuration -> {
            configuration.addInterceptor(new SqlInterceptor());
        };
    }

實(shí)現(xiàn)功能如圖所示

在這里插入圖片描述

到此這篇關(guān)于MyBatis/mybatis_plus項(xiàng)目打印SQL的方法實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)mybatis_plus打印SQL內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!

相關(guān)文章

  • 基于Spring Cloud實(shí)現(xiàn)文件服務(wù)預(yù)覽與靜態(tài)資源映射

    基于Spring Cloud實(shí)現(xiàn)文件服務(wù)預(yù)覽與靜態(tài)資源映射

    本文檔針對(duì) Spring Cloud 微服務(wù)架構(gòu)中文件上傳服務(wù)的預(yù)覽需求,系統(tǒng)分析多種技術(shù)方案的適用場(chǎng)景、性能特征及安全模型,并提供可落地的配置示例與最佳實(shí)踐,需要的朋友可以參考下
    2026-06-06
  • Java中的NoSuchMethodException異常原因以及解決方案詳解

    Java中的NoSuchMethodException異常原因以及解決方案詳解

    這篇文章主要介紹了Java中的NoSuchMethodException異常原因以及解決方案詳解,NoSuchMethodException是Java反射機(jī)制中的異常,在嘗試通過(guò)反射獲取方法時(shí),找不到指定的方法,通常發(fā)生在調(diào)用?Class?對(duì)象的方法時(shí),當(dāng)方法名或方法參數(shù)不匹配時(shí)拋出該異常,需要的朋友可以參考下
    2024-02-02
  • 詳解springboot中redis的使用和分布式session共享問(wèn)題

    詳解springboot中redis的使用和分布式session共享問(wèn)題

    這篇文章主要介紹了詳解springboot中redis的使用和分布式session共享問(wèn)題,詳細(xì)的介紹了解決分布式系統(tǒng)的session如何共享問(wèn)題,有興趣的可以了解一下
    2017-11-11
  • 關(guān)于mybatis調(diào)用存儲(chǔ)過(guò)程獲取返回值問(wèn)題

    關(guān)于mybatis調(diào)用存儲(chǔ)過(guò)程獲取返回值問(wèn)題

    這篇文章主要介紹了mybatis調(diào)用存儲(chǔ)過(guò)程獲取返回值問(wèn)題,本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下
    2022-01-01
  • java使用@Transactional時(shí)常犯的N種錯(cuò)誤

    java使用@Transactional時(shí)常犯的N種錯(cuò)誤

    @Transactional是我們?cè)谟肧pring時(shí)候幾乎逃不掉的一個(gè)注解,本文主要介紹了使用?@Transactional?時(shí)常犯的N種錯(cuò)誤,文中通過(guò)示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下
    2022-01-01
  • 通過(guò)實(shí)例了解Java Integer類和int的區(qū)別

    通過(guò)實(shí)例了解Java Integer類和int的區(qū)別

    這篇文章主要介紹了通過(guò)實(shí)例了解Java Integer類和int的區(qū)別,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下
    2020-03-03
  • SpringBoot 整合 JWT + Redis 實(shí)現(xiàn)登錄鑒權(quán)

    SpringBoot 整合 JWT + Redis 實(shí)現(xiàn)登錄鑒權(quán)

    本文主要介紹了SpringBoot 整合 JWT + Redis 實(shí)現(xiàn)登錄鑒權(quán),文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧
    2026-02-02
  • Java?list如何實(shí)現(xiàn)將指定元素排在第一位

    Java?list如何實(shí)現(xiàn)將指定元素排在第一位

    這篇文章主要為大家詳細(xì)介紹了Java?list中如何實(shí)現(xiàn)將指定元素排在第一位,文中的示例代碼講解詳細(xì),感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下
    2025-02-02
  • Java并發(fā)編程中高頻異常的原因,場(chǎng)景與解決方案全解析

    Java并發(fā)編程中高頻異常的原因,場(chǎng)景與解決方案全解析

    在Java并發(fā)編程中,異常處理是保障程序穩(wěn)定性的核心環(huán)節(jié),本文將深度解析4類高頻并發(fā)異常的產(chǎn)生原因、典型場(chǎng)景,并給出可落地的解決方案,幫你徹底避開(kāi)這些坑
    2026-03-03
  • Spring之ORM模塊代碼詳解

    Spring之ORM模塊代碼詳解

    這篇文章主要介紹了Spring之ORM模塊代碼詳解,具有一定參考價(jià)值,需要的朋友可以了解下。
    2017-12-12

最新評(píng)論

东辽县| 威宁| 元阳县| 三门县| 东城区| 宁陵县| 华安县| 汤原县| 连州市| 武清区| 调兵山市| 瑞安市| 日土县| 丹阳市| 纳雍县| 轮台县| 吴江市| 郴州市| 洪湖市| 九龙坡区| 平昌县| 黄梅县| 宁乡县| 芜湖县| 合水县| 永德县| 祁阳县| 阳春市| 黔江区| 永定县| 宝兴县| 罗山县| 三原县| 双城市| 百色市| 突泉县| 萨嘎县| 万宁市| 扎兰屯市| 会东县| 新疆|