Springboot+MyBatis進行日志輸出參考示例
問題
書接上回,咱們處理完成druid
數據源連接池日志后,所有執(zhí)行sql的日志都可以打印出來了,但是問題也是接踵而來,日志文件中密密麻麻都是日志,而當我想要查看某個dao的sql或者想要通過sql找到其所在dao是非常困難的,通過考慮決定,將druid日志輸出到一個單獨的日志文件中,方便后續(xù)在排查某個時間段某個線程中執(zhí)行的所有的生氣了,將持久層日志打印到控制臺和主日志文件中,以便通過持久層的sql日志協(xié)助我們進行問題排查!
mybatis日志如何配置?按照我們的慣例依然是查看mybatis官網 | mybatis官網中文,在官網Logging
章節(jié)我們找打答案。雖然官網說的很清楚,但是我在具體實踐過程中我遇到了各種問題(ps.問題前任留下的坑,跟自己半毛錢關系可能有一點…咳咳咳…)其中遇到的主要問題就是系統(tǒng)中存在使用sqlSession
寫sql進行數據操作的情況。導致loggerName與日志配置文件中配置的loggerName不同導致。根據sqlSession調用過程中的statement
,在日志文件中增加loggerName配置即可。如示例中調用我們只需配置 logger name = Select
即可。sqlSession調用示例:
this.sqlSession.selectList("Select.w7HNMGotGtKCgNQzphL09ne1/XNVzam6ZrhqBWMR05k=", param);
在實際開發(fā)中還遇到的一個問題是,系統(tǒng)使用多模塊開發(fā),導致系統(tǒng)中的dao分布在各個模塊中,出現一下情況:
com.example.demo.a.dao com.example.demo.b.dao com.example.demo.b.dao
此時我們如果在配置logger時使用如下配置是不生效的,主要是日志配置文件中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>
故我們可以這么配置,弊端項目下所有日志打印都會使用debug級別進行輸出。
<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>
總結
本次主要遇到兩個問題:
- 日志配置文件中配置logger name 時不支持通配符,自己想當然的任務其支持,沒有做到小心假設大膽求證。
- 系統(tǒng)中特殊調用的情況需要特殊處理
經驗做法
當遇到自己想打印的sql沒有輸出時,我們可以在sql調用前打斷點,然后再去你使用的mybatis具體日志實現類中打斷點,得到自己想要的logger 。位置示例:
不收費的參考示例
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.Slf4jImpl
logback.xml配置
<?xml version="1.0" encoding="UTF-8"?> <!-- 日志級別從低到高分為TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果設置為WARN,則低于WARN的信息都不會輸出 --> <!-- scan:當此屬性設置為true時,配置文檔如果發(fā)生改變,將會被重新加載,默認值為true --> <!-- scanPeriod:設置監(jiān)測配置文檔是否有修改的時間間隔,如果沒有給出時間單位,默認單位是毫秒。當scan為true時,此屬性生效。默認的時間間隔為1分鐘。 --> <!-- debug:當此屬性設置為true時,將打印出logback內部日志信息,實時查看logback運行狀態(tài)。默認值為false。 --> <configuration scan="true" scanPeriod="10 seconds"> <contextName>demo</contextName> <!-- name的值是變量的名稱,value的值時變量定義的值。通過定義的值會被插入到logger上下文中。定義后,可以使“${}”來使用變量。 --> <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. 輸出到控制臺--> <appender name="console" class="ch.qos.logback.core.ConsoleAppender"> <!--此日志appender是為開發(fā)使用,只配置最底級別,控制臺輸出的日志級別是大于或等于此級別的日志信息--> <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> <level>debug</level> </filter> <encoder> <Pattern>${CONSOLE_LOG_PATTERN}</Pattern> <!-- 設置字符集 --> <charset>UTF-8</charset> </encoder> </appender> <!--2. 輸出到文檔--> <!-- 2.1 全部日志,時間滾動輸出 --> <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> <!-- 設置字符集 --> </encoder> <!-- 日志記錄器的滾動策略,按日期,按大小記錄 --> <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> <!--日志文檔保留天數--> <maxHistory>30</maxHistory> </rollingPolicy> </appender> <!-- 2.2 druid sql 日志文件,時間滾動輸出 --> <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> <!-- 設置字符集 --> </encoder> <!-- 日志記錄器的滾動策略,按日期,按大小記錄 --> <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> <!--日志文檔保留天數--> <maxHistory>30</maxHistory> </rollingPolicy> </appender> <!-- <logger> 用來設置某一個包或者具體的某一個類的日志打印級別、以及指定<appender>。 <logger> 僅有一個name屬性,一個可選的level和一個可選的addtivity屬性。 name:用來指定受此logger約束的某一個包或者具體的某一個類。 level:用來設置打印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,還有一個特俗值INHERITED或者同義詞NULL,代表強制執(zhí)行上級的級別。如果未設置此屬性,那么當前l(fā)ogger將會繼承上級的級別。 addtivity:是否向上級logger傳遞打印信息。默認是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é)點是必選節(jié)點,用來指定最基礎的日志輸出級別,只有一個level屬性 level:用來設置打印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能設置為INHERITED或者同義詞NULL。默認是DEBUG 可以包含零個或多個元素,標識這個appender將會添加到這個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
說明
本次調試使用的日志框架為 slf4j + logback 。
到此這篇關于Springboot+MyBatis進行日志輸出的文章就介紹到這了,更多相關Springboot+MyBatis日志輸出內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
基于Java和GeoTools的Shapefile矢量數據縮略圖生成實踐
這篇文章主要介紹了基于Java和GeoTools的Shapefile矢量數據縮略圖生成實踐,需要的朋友可以參考下2024-08-08GraalVM和Spring Native嘗鮮一步步讓Springboot啟動飛起來66ms完成啟動
GraalVM是高性能的JDK,支持Java/Python/JavaScript等語言,它可以讓Java變成二進制文件來執(zhí)行,讓程序在任何地方運行更快,這篇文章主要介紹了GraalVM和Spring Native嘗鮮一步步讓Springboot啟動飛起來66ms完成啟動,需要的朋友可以參考下2023-02-02Mybatis?Plus?QueryWrapper復合用法詳解
這篇文章主要介紹了Mybatis?Plus?QueryWrapper復合用法詳解,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教。2022-01-01InterProcessMutex實現zookeeper分布式鎖原理
本文主要介紹了InterProcessMutex實現zookeeper分布式鎖原理,文中根據實例編碼詳細介紹的十分詳盡,具有一定的參考價值,感興趣的小伙伴們可以參考一下2022-03-03