Springboot+MyBatis進(jìn)行日志輸出參考示例
更新時(shí)間：2023年08月08日 09:02:50 作者：生而為活
這篇文章主要給大家介紹了關(guān)于Springboot+MyBatis進(jìn)行日志輸出的相關(guān)資料,在項(xiàng)目開(kāi)發(fā)過(guò)程中,日志是必不可少的,文中通過(guò)實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下
問(wèn)題
書(shū)接上回，咱們處理完成druid數(shù)據(jù)源連接池日志后，所有執(zhí)行sql的日志都可以打印出來(lái)了，但是問(wèn)題也是接踵而來(lái)，日志文件中密密麻麻都是日志，而當(dāng)我想要查看某個(gè)dao的sql或者想要通過(guò)sql找到其所在dao是非常困難的，通過(guò)考慮決定，將druid日志輸出到一個(gè)單獨(dú)的日志文件中，方便后續(xù)在排查某個(gè)時(shí)間段某個(gè)線程中執(zhí)行的所有的生氣了，將持久層日志打印到控制臺(tái)和主日志文件中，以便通過(guò)持久層的sql日志協(xié)助我們進(jìn)行問(wèn)題排查！
mybatis日志如何配置？按照我們的慣例依然是查看mybatis官網(wǎng) | mybatis官網(wǎng)中文，在官網(wǎng)Logging章節(jié)我們找打答案。雖然官網(wǎng)說(shuō)的很清楚，但是我在具體實(shí)踐過(guò)程中我遇到了各種問(wèn)題（ps.問(wèn)題前任留下的坑，跟自己半毛錢關(guān)系可能有一點(diǎn)…咳咳咳…）其中遇到的主要問(wèn)題就是系統(tǒng)中存在使用sqlSession寫(xiě)sql進(jìn)行數(shù)據(jù)操作的情況。導(dǎo)致loggerName與日志配置文件中配置的loggerName不同導(dǎo)致。根據(jù)sqlSession調(diào)用過(guò)程中的statement,在日志文件中增加loggerName配置即可。如示例中調(diào)用我們只需配置 logger name = Select即可。sqlSession調(diào)用示例：
this.sqlSession.selectList("Select.w7HNMGotGtKCgNQzphL09ne1/XNVzam6ZrhqBWMR05k=", param);在實(shí)際開(kāi)發(fā)中還遇到的一個(gè)問(wèn)題是，系統(tǒng)使用多模塊開(kāi)發(fā)，導(dǎo)致系統(tǒng)中的dao分布在各個(gè)模塊中，出現(xiàn)一下情況：
com.example.demo.a.dao com.example.demo.b.dao com.example.demo.b.dao
此時(shí)我們?nèi)绻谂渲胠ogger時(shí)使用如下配置是不生效的，主要是日志配置文件中l(wèi)ogger name 不支持通配符。
<logger name="com.example.demo.*.dao" level="debug" additivity="false"> <appender-ref ref="console"/> <appender-ref ref="demo_log"/> </logger>
故我們可以這么配置，弊端項(xiàng)目下所有日志打印都會(huì)使用debug級(jí)別進(jìn)行輸出。
<logger name="com.example.demo" level="debug" additivity="false"> <appender-ref ref="console"/> <appender-ref ref="demo_log"/> </logger>
也可以這么配置
<logger name="com.example.demo.a.dao" level="debug" additivity="false"> <appender-ref ref="console"/> <appender-ref ref="demo_log"/> </logger> <logger name="com.example.demo.b.dao" level="debug" additivity="false"> <appender-ref ref="console"/> <appender-ref ref="demo_log"/> </logger> <logger name="com.example.demo.c.dao" level="debug" additivity="false"> <appender-ref ref="console"/> <appender-ref ref="demo_log"/> </logger>
總結(jié)
本次主要遇到兩個(gè)問(wèn)題：
- 日志配置文件中配置logger name 時(shí)不支持通配符，自己想當(dāng)然的任務(wù)其支持，沒(méi)有做到小心假設(shè)大膽求證。
- 系統(tǒng)中特殊調(diào)用的情況需要特殊處理
經(jīng)驗(yàn)做法
當(dāng)遇到自己想打印的sql沒(méi)有輸出時(shí)，我們可以在sql調(diào)用前打斷點(diǎn)，然后再去你使用的mybatis具體日志實(shí)現(xiàn)類中打斷點(diǎn)，得到自己想要的logger 。位置示例：
不收費(fèi)的參考示例
application配置
server:
port: 4000
spring:
datasource:
druid:
driver-class-name: org.postgresql.Driver
url: jdbc:postgresql://000.000.000.000:5432/demo
username: postgres
password: postgres
filters: slf4j
filter:
slf4j:
enabled: true
statement-create-after-log-enabled: false
statement-close-after-log-enabled: false
result-set-open-after-log-enabled: false
result-set-close-after-log-enabled: false
mybatis:
mapper-locations: classpath:mapper/*.xml
type-aliases-package: com.example.demo.entities
configuration:
map-underscore-to-camel-case: true
log-impl: org.apache.ibatis.logging.slf4j.Slf4jImpllogback.xml配置
<?xml version="1.0" encoding="UTF-8"?>
<!-- 日志級(jí)別從低到高分為TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果設(shè)置為WARN，則低于WARN的信息都不會(huì)輸出 -->
<!-- scan:當(dāng)此屬性設(shè)置為true時(shí)，配置文檔如果發(fā)生改變，將會(huì)被重新加載，默認(rèn)值為true -->
<!-- scanPeriod:設(shè)置監(jiān)測(cè)配置文檔是否有修改的時(shí)間間隔，如果沒(méi)有給出時(shí)間單位，默認(rèn)單位是毫秒。當(dāng)scan為true時(shí)，此屬性生效。默認(rèn)的時(shí)間間隔為1分鐘。 -->
<!-- debug:當(dāng)此屬性設(shè)置為true時(shí)，將打印出logback內(nèi)部日志信息，實(shí)時(shí)查看logback運(yùn)行狀態(tài)。默認(rèn)值為false。 -->
<configuration scan="true" scanPeriod="10 seconds">
<contextName>demo</contextName>
<!-- name的值是變量的名稱，value的值時(shí)變量定義的值。通過(guò)定義的值會(huì)被插入到logger上下文中。定義后，可以使“${}”來(lái)使用變量。 -->
<property name="log.path" value="${log.home:-.}"/>
<!--0. 日志格式和顏色渲染 -->
<!-- 彩色日志依賴的渲染類 -->
<conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
<conversionRule conversionWord="wex"
converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter"/>
<!-- 彩色日志格式 -->
<property name="CONSOLE_LOG_PATTERN"
value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%thread]){faint} %clr(%-40.40logger{39}){cyan} %L %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wex}}"/>
<!--1. 輸出到控制臺(tái)-->
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<!--此日志appender是為開(kāi)發(fā)使用，只配置最底級(jí)別，控制臺(tái)輸出的日志級(jí)別是大于或等于此級(jí)別的日志信息-->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>debug</level>
</filter>
<encoder>
<Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
<!-- 設(shè)置字符集 -->
<charset>UTF-8</charset>
</encoder>
</appender>
<!--2. 輸出到文檔-->
<!-- 2.1 全部日志，時(shí)間滾動(dòng)輸出 -->
<appender name="demo_log" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在記錄的日志文檔的路徑及文檔名 -->
<file>${log.path}/demo.log</file>
<!--日志文檔輸出格式-->
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<charset>UTF-8</charset> <!-- 設(shè)置字符集 -->
</encoder>
<!-- 日志記錄器的滾動(dòng)策略，按日期，按大小記錄 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 日志歸檔 -->
<fileNamePattern>${log.path}/demo-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文檔保留天數(shù)-->
<maxHistory>30</maxHistory>
</rollingPolicy>
</appender>
<!-- 2.2 druid sql 日志文件，時(shí)間滾動(dòng)輸出 -->
<appender name="druid_log" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在記錄的日志文檔的路徑及文檔名 -->
<file>${log.path}/druid.log</file>
<!--日志文檔輸出格式-->
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<charset>UTF-8</charset> <!-- 設(shè)置字符集 -->
</encoder>
<!-- 日志記錄器的滾動(dòng)策略，按日期，按大小記錄 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 日志歸檔 -->
<fileNamePattern>${log.path}/druid-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文檔保留天數(shù)-->
<maxHistory>30</maxHistory>
</rollingPolicy>
</appender>
<!--
<logger> 用來(lái)設(shè)置某一個(gè)包或者具體的某一個(gè)類的日志打印級(jí)別、以及指定<appender>。
<logger> 僅有一個(gè)name屬性，一個(gè)可選的level和一個(gè)可選的addtivity屬性。
name:用來(lái)指定受此logger約束的某一個(gè)包或者具體的某一個(gè)類。
level:用來(lái)設(shè)置打印級(jí)別，大小寫(xiě)無(wú)關(guān)：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，還有一個(gè)特俗值INHERITED或者同義詞NULL，代表強(qiáng)制執(zhí)行上級(jí)的級(jí)別。如果未設(shè)置此屬性，那么當(dāng)前l(fā)ogger將會(huì)繼承上級(jí)的級(jí)別。
addtivity:是否向上級(jí)logger傳遞打印信息。默認(rèn)是true。
<logger name="org.springframework.web" level="info"/>
<logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>
-->
<logger name="org.springframework.scheduling.quartz" level="error" additivity="false"/>
<!-- mybatis 日志輸出 -->
<logger name="com.example.demo.dao" level="debug" additivity="false">
<appender-ref ref="console"/>
<appender-ref ref="demo_log"/>
</logger>
<!-- druid 日志輸出-->
<logger name="druid.sql.Statement" level="debug" additivity="false">
<appender-ref ref="druid_log"/>
</logger>
<!--
root節(jié)點(diǎn)是必選節(jié)點(diǎn)，用來(lái)指定最基礎(chǔ)的日志輸出級(jí)別，只有一個(gè)level屬性
level:用來(lái)設(shè)置打印級(jí)別，大小寫(xiě)無(wú)關(guān)：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能設(shè)置為INHERITED或者同義詞NULL。默認(rèn)是DEBUG
可以包含零個(gè)或多個(gè)元素，標(biāo)識(shí)這個(gè)appender將會(huì)添加到這個(gè)logger。
-->
<root level="info">
<appender-ref ref="console"/>
<appender-ref ref="demo_log"/>
</root>
</configuration>日志示例
2023-06-14 10:23:25.682 DEBUG 17680 --- [main] com.example.demo.dao.UserDao.selectById 135 : ==> Preparing: SELECT * FROM sys_user WHERE id = ? 2023-06-14 10:23:25.695 DEBUG 17680 --- [main] com.example.demo.dao.UserDao.selectById 135 : ==> Parameters: 1(Long) 2023-06-14 10:23:25.792 DEBUG 17680 --- [main] com.example.demo.dao.UserDao.selectById 135 : <== Total: 1
說(shuō)明
本次調(diào)試使用的日志框架為 slf4j + logback 。
到此這篇關(guān)于Springboot+MyBatis進(jìn)行日志輸出的文章就介紹到這了,更多相關(guān)Springboot+MyBatis日志輸出內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
基于Java和GeoTools的Shapefile矢量數(shù)據(jù)縮略圖生成實(shí)踐
這篇文章主要介紹了基于Java和GeoTools的Shapefile矢量數(shù)據(jù)縮略圖生成實(shí)踐,需要的朋友可以參考下2024-08-08
JMagick實(shí)現(xiàn)基本圖像處理的類實(shí)例
這篇文章主要介紹了JMagick實(shí)現(xiàn)基本圖像處理的類,實(shí)例分析了java圖像處理的相關(guān)技巧,需要的朋友可以參考下2015-06-06
IDEA maven項(xiàng)目中刷新依賴的兩種方法小結(jié)
這篇文章主要介紹了IDEA maven項(xiàng)目中刷新依賴的兩種方法小結(jié)，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2023-03-03
本篇文章主要介紹了Spring的RestTemplata使用的具體方法，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2018-01-01
GraalVM和Spring Native嘗鮮一步步讓Springboot啟動(dòng)飛起來(lái)66ms完成啟動(dòng)
GraalVM是高性能的JDK，支持Java/Python/JavaScript等語(yǔ)言，它可以讓Java變成二進(jìn)制文件來(lái)執(zhí)行，讓程序在任何地方運(yùn)行更快，這篇文章主要介紹了GraalVM和Spring Native嘗鮮一步步讓Springboot啟動(dòng)飛起來(lái)66ms完成啟動(dòng),需要的朋友可以參考下2023-02-02
關(guān)于Java中BeanMap進(jìn)行對(duì)象與Map的相互轉(zhuǎn)換問(wèn)題
這篇文章主要介紹了利用BeanMap進(jìn)行對(duì)象與Map的相互轉(zhuǎn)換,通過(guò)net.sf.cglib.beans.BeanMap類中的方法來(lái)轉(zhuǎn)換，效率極高，本文給大家分享實(shí)現(xiàn)代碼，感興趣的朋友一起看看吧2022-03-03
Java實(shí)現(xiàn)迅雷地址轉(zhuǎn)成普通地址實(shí)例代碼
本篇文章主要介紹了Java實(shí)現(xiàn)迅雷地址轉(zhuǎn)成普通地址實(shí)例代碼，非常具有實(shí)用價(jià)值，有興趣的可以了解一下。2017-03-03
Mybatis?Plus?QueryWrapper復(fù)合用法詳解
這篇文章主要介紹了Mybatis?Plus?QueryWrapper復(fù)合用法詳解，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教。2022-01-01
InterProcessMutex實(shí)現(xiàn)zookeeper分布式鎖原理
本文主要介紹了InterProcessMutex實(shí)現(xiàn)zookeeper分布式鎖原理，文中根據(jù)實(shí)例編碼詳細(xì)介紹的十分詳盡，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2022-03-03
這篇文章主要介紹了Java面向?qū)ο蠡A(chǔ)，類，變量，方法,需要的朋友可以參考下2020-10-10