快捷導(dǎo)航

SpringBoot集成P6spy實(shí)現(xiàn)自定義SQL日志打印

更新時(shí)間：2023年07月24日 10:27:05 作者：保加利亞的風(fēng)

本文主要介紹了SpringBoot集成P6spy實(shí)現(xiàn)自定義SQL日志打印，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

前言

在項(xiàng)目中對(duì)數(shù)據(jù)庫中進(jìn)行操作調(diào)試的時(shí)候，最重要的一個(gè)功能就是SQL打印。

如果使用Mybatis-plus的話，他會(huì)自帶一個(gè)SQL打印的功能。雖然它可以打印，但我覺得還不夠優(yōu)雅，因?yàn)榘芏辔覀儾恍枰男畔?，所以這篇文章實(shí)現(xiàn)一下在代碼中優(yōu)雅的打印SQL。

介紹

P6spy是什么？

P6Spy 是針對(duì)數(shù)據(jù)庫訪問操作的動(dòng)態(tài)監(jiān)測(cè)框架（為開源項(xiàng)目，項(xiàng)目首頁：www.p6spy.com）它使得數(shù)據(jù)庫數(shù)據(jù)可無縫截取和操縱，而不必對(duì)現(xiàn)有應(yīng)用程序的代碼作任何修改。P6Spy 分發(fā)包包括P6Log，它是一個(gè)可記錄任何 Java 應(yīng)用程序的所有JDBC事務(wù)的應(yīng)用程序。其配置完成使用時(shí)，可以進(jìn)行數(shù)據(jù)訪問性能的監(jiān)測(cè)。

我們最需要的功能，查看sql語句，不是預(yù)編譯的帶問號(hào)的哦，而是真正的數(shù)據(jù)庫執(zhí)行的sql，更直觀，更簡(jiǎn)單。

使用

1 導(dǎo)入相關(guān)依賴

        <dependency>
            <groupId>p6spy</groupId>
            <artifactId>p6spy</artifactId>
            <version>${version:}</version>//目前最新版3.9.1
        </dependency>

2 修改application.yml配置文件，只需要將連接和驅(qū)動(dòng)進(jìn)行修改

url: jdbc:p6spy:mysql://localhost:3306/db1_datasource
driver-class-name: com.p6spy.engine.spy.P6SpyDriver

3 新增spy.properties文件

module.log=com.p6spy.engine.logging.P6LogFactory,com.p6spy.engine.outage.P6OutageFactory
appender=com.p6spy.engine.spy.appender.StdoutLogger
excludecategories=info,debug,result,batc,resultset
deregisterdrivers=true
dateformat=yyyy-MM-dd HH:mm:ss
driverlist=com.mysql.cj.jdbc.Driver
outagedetection=true
outagedetectioninterval=2
#自定義SQL打印處理類
logMessageFormat=com.xxx.xxx.P6SpyLogger

4 新增P6SpyLogger，處理打印的SQL語句

import com.p6spy.engine.spy.appender.MessageFormattingStrategy;
import java.text.SimpleDateFormat;
import java.util.Date;
public class P6SpyLogger implements MessageFormattingStrategy {
? ? private SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss:SSS");
? ? /**
? ? ?* 自定義sql日志打印
? ? ?*
? ? ?* @param connectionId 連接標(biāo)識(shí)
? ? ?* @param now ? ? ? ? ?執(zhí)行時(shí)間
? ? ?* @param elapsed ? ? ?執(zhí)行秒數(shù)ms
? ? ?* @param category ? ? statement
? ? ?* @param prepared ? ? 準(zhǔn)備sql語句
? ? ?* @param sql ? ? ? ? ?sql語句
? ? ?* @param s4 ? ? ? ? ? 數(shù)據(jù)庫url連接
? ? ?* @return {@link String}
? ? ?*/
? ? @Override
? ? public String formatMessage(int connectionId, String now, long elapsed, String category, String prepared, String sql, String s4) {
? ? ? ? System.out.println();
? ? ? ? if (!"".equals(sql.trim())) {
? ? ? ? ? ? String sqlBegin = "============== SQL LOGGER BEGIN ==============";
? ? ? ? ? ? String sqlExecuteTime = "SQL 執(zhí)行時(shí)間 ? ? ? :" + this.format.format(new Date()) + "\n";
? ? ? ? ? ? String elapsedStr = "SQL 執(zhí)行毫秒 ? ? ? :" + elapsed + "ms" + "\n";
? ? ? ? ? ? String sqlPrint = "SQL 執(zhí)行語句 ? ? ? :" + sql;
? ? ? ? ? ? //String sqlPrint = !"".equals(sql.trim()) ? this.format.format(new Date()) + " | took " + elapsed + "ms | " + category + " | connection " + connectionId + "\n " + sql + ";" : "";
? ? ? ? ? ? String sqlEnd = "============== ?SQL LOGGER END ?==============";
? ? ? ? ? ? return sqlBegin + "\r\n" + sqlExecuteTime + elapsedStr + sqlPrint + "\r\n" + sqlEnd;
? ? ? ? }
? ? ? ? return "";
? ? }
}

5 查看SQL打印效果

============== SQL LOGGER BEGIN ==============
SQL 執(zhí)行時(shí)間 :2023-07-12 11:37:43:296
SQL 執(zhí)行毫秒 :5ms
SQL 執(zhí)行語句 :select * from db2_user
============== SQL LOGGER END ==============

============== SQL LOGGER BEGIN ==============
SQL 執(zhí)行時(shí)間 :2023-07-12 11:37:47:707
SQL 執(zhí)行毫秒 :1ms
SQL 執(zhí)行語句 :select * from db1_user where age = 18 order by create_time desc
============== SQL LOGGER END ==============

總結(jié)

可以根據(jù)方法的參數(shù)進(jìn)行不同的搭配來實(shí)現(xiàn)優(yōu)雅的SQL打印

到此這篇關(guān)于SpringBoot集成P6spy實(shí)現(xiàn)自定義SQL日志打印的文章就介紹到這了,更多相關(guān)SpringBoot P6spy自定義SQL打印內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: