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

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

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

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

在這里插入圖片描述

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

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

MyBatis插件的原理

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

MyBatis 插件的幾個重點模塊

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

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

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

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

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

其中類上的Intercepts注解含義為:在 Executor 的 query、update 方法執(zhí)行前后進行自定義的處理,其中Executor 是最底層的執(zhí)行器,負責(zé)與數(shù)據(jù)庫進行通信。它的職責(zé)包括創(chuàng)建和緩存 Statement 對象、執(zhí)行 SQL 語句、處理結(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   實現(xiàn)一個優(yōu)雅打日志的功能
 * @Intercepts 注解:
 *
 * 這是 MyBatis 提供的一個注解,用于定義一個攔截器。一個攔截器可以攔截一個或多個方法。
 * @Signature 注解:
 *
 * 這是 @Intercepts 注解的子注解,用于指定要攔截的目標(biāo)方法。
 *
 * @Signature 注解的參數(shù)分別是:
 *
 *     type:指定要攔截的接口類型。
 *
 *     method:指定要攔截的方法名。
 *
 *     args:指定要攔截的方法的參數(shù)類型列表。
 *      todo: 這一章其他內(nèi)容之后補上(Intercepts注解、MyBatis插件開發(fā)過程中的各個對象
 */
@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執(zhí)行錢后的時間,統(tǒng)計一下執(zhí)行耗時
        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 執(zhí)行SQL耗時:{}ms \n 執(zhí)行SQL:{}",costTime,printSql);
        }
        return proceed;
    }

    private static String generateSql(Invocation invocation){
        // 獲取到BoundSql以及Configuration對象
        // BoundSql 對象存儲了一條具體的 SQL 語句及其相關(guān)參數(shù)信息。
        // 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);

        // 獲取參數(shù)對象
        Object parameterObject = boundSql.getParameterObject();
        // 獲取參數(shù)映射
        List<ParameterMapping> params = boundSql.getParameterMappings();
        // 獲取到執(zhí)行的SQL
        String sql = boundSql.getSql();
        // SQL中多個空格使用一個空格代替
        sql = sql.replaceAll("[\\s]+", " ");
        if (!ObjectUtils.isEmpty(params) && !ObjectUtils.isEmpty(parameterObject)){
            // TypeHandlerRegistry 是 MyBatis 用來管理 TypeHandler 的注冊器。TypeHandler 用于在 Java 類型和 JDBC 類型之間進行轉(zhuǎn)換
            TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
            // 如果參數(shù)對象的類型有對應(yīng)的 TypeHandler,則使用 TypeHandler 進行處理
            if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())){
                sql = sql.replaceFirst("\\?", Matcher.quoteReplacement(getParameterValue(parameterObject)));
            }else {
                // 否則,逐個處理參數(shù)映射
                for (ParameterMapping param : params) {
                    // 獲取參數(shù)的屬性名
                    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 對象中是否存在附加參數(shù)。附加參數(shù)可能是在動態(tài) 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配置插件參數(shù)
    }
}

接著編寫一個MyBatis的配置類,將這個插件注冊進去

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

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

在這里插入圖片描述

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

相關(guān)文章

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

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

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

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

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

    詳解springboot中redis的使用和分布式session共享問題

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

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

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

    java使用@Transactional時常犯的N種錯誤

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

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

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

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

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

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

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

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

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

    Spring之ORM模塊代碼詳解

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

最新評論

木兰县| 安龙县| 泰和县| 绍兴县| 平舆县| 新野县| 丹东市| 开远市| 米脂县| 绥阳县| 西华县| 馆陶县| 剑阁县| 洞口县| 安平县| 安仁县| 台东市| 方城县| 南涧| 渑池县| 衡山县| 南澳县| 黄浦区| 桃源县| 水富县| 乌什县| 锡林郭勒盟| 富源县| 扎鲁特旗| 阳山县| 雷波县| 登封市| 贵阳市| 柞水县| 贞丰县| 克东县| 大方县| 宁河县| 吉木萨尔县| 忻州市| 普兰县|