SpringBoot之配置logging日志及在控制臺(tái)中輸出過程
SpringBoot配置logging日志及在控制臺(tái)中輸出
這里以執(zhí)行的SQL語句在控制臺(tái)中輸出為例,在Spring Boot項(xiàng)目中配置logging日志并輸出SQL語句。
個(gè)人在最近的項(xiàng)目中出錯(cuò)頻頻,其中大部分后臺(tái)報(bào)錯(cuò)都與SQLException有關(guān),SQL異常一般又很難查到錯(cuò)誤地方,尤其是在映射文件Mapper.xml中,找到你對(duì)應(yīng)的出錯(cuò)的位置,如果的你的sql很簡(jiǎn)單,那還好,但是那是不可能,一般項(xiàng)目中涉及到的SQL語句也沒有就是簡(jiǎn)單的增刪改查。
所以在你的項(xiàng)目中配置logging日志很有必要,這樣就很好定位是哪條SQL語句出了問題。
在Spring Boot中,默認(rèn)使用的是SLF4J+LogBack實(shí)現(xiàn)日志框架,這點(diǎn)我們從
spring-boot-starter-logging-1.5.7.RELEASE.jar里面的pom.xml文件也看得出來
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starters</artifactId> <version>1.5.7.RELEASE</version> </parent> <artifactId>spring-boot-starter-logging</artifactId> <name>Spring Boot Logging Starter</name> <description>Starter for logging using Logback. Default logging starter</description> <url>http://projects.spring.io/spring-boot/</url> <organization> <name>Pivotal Software, Inc.</name> <url>http://www.spring.io</url> </organization> <properties> <main.basedir>${basedir}/../..</main.basedir> </properties> <dependencies> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>jcl-over-slf4j</artifactId> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>jul-to-slf4j</artifactId> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>log4j-over-slf4j</artifactId> </dependency> </dependencies> </project>
既然SpringBoot已經(jīng)默認(rèn)幫我們配置了依賴包,我們只需要在項(xiàng)目的resources文件夾中間一個(gè)config文件,放入logback-spring.xml文件,這里面配置了一些日志的輸出格式等等內(nèi)容,我們可以根據(jù)需要進(jìn)行配置。
下面貼出我的logback-spring.xml
<?xml version="1.0" encoding="UTF-8"?> <configuration scan="true" scanPeriod="10 seconds"> <!--繼承spring boot提供的logback配置--> <!--<include resource="org/springframework/boot/logging/logback/base.xml" />--> <!--設(shè)置系統(tǒng)日志目錄--> <property name="APP_DIR" value="spring-boot-log"/> <!-- 彩色日志 --> <!-- 彩色日志依賴的渲染類,控制臺(tái)上的日志彩色顯示 --> <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/> <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/> <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([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/> <!-- 控制臺(tái)輸出 --> <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <Pattern>${CONSOLE_LOG_PATTERN}</Pattern> <charset>UTF-8</charset> <!-- 此處設(shè)置字符集 --> </encoder> <!--此日志appender是為開發(fā)使用,只配置最低級(jí)別,控制臺(tái)輸出的日志級(jí)別是大于或等于此級(jí)別的日志信息--> <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> <level>debug</level> </filter> </appender> <!-- 時(shí)間滾動(dòng)輸出 level為 DEBUG 日志 --> <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!-- 正在記錄的日志文件的路徑及文件名 --> <file>${LOG_PATH}/sys/sys_log_debug.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"> <!-- 歸檔的日志文件的路徑,例如今天是2018-10-26日志,當(dāng)前寫的日志文件路徑為file節(jié)點(diǎn)指定,可以將此文件與file指定文件路徑設(shè)置為不同路徑,從而將當(dāng)前日志文件或歸檔日志文件置不同的目錄。 而2018-10-26的日志文件在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式,%i指定索引 --> <fileNamePattern>${LOG_PATH}/sys/debug/sys_log-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern> <!-- 除按日志記錄之外,還配置了日志文件不能超過50M,若超過50M,日志文件會(huì)以索引0開始, 命名日志文件,例如log-error-2018-10-26.0.log --> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>20MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> <!--日志文件保留天數(shù)--> <maxHistory>30</maxHistory> </rollingPolicy> <!-- 此日志文件只記錄debug級(jí)別的 --> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>debug</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <!-- 時(shí)間滾動(dòng)輸出 level為 INFO 日志 --> <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!-- 正在記錄的日志文件的路徑及文件名 --> <file>${LOG_PATH}/sys/sys_log_info.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"> <!-- 歸檔的日志文件的路徑,例如今天是2018-10-26日志,當(dāng)前寫的日志文件路徑為file節(jié)點(diǎn)指定,可以將此文件與file指定文件路徑設(shè)置為不同路徑,從而將當(dāng)前日志文件或歸檔日志文件置不同的目錄。 而2018-10-26的日志文件在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式,%i指定索引 --> <fileNamePattern>${LOG_PATH}/sys/info/sys_log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern> <!-- 除按日志記錄之外,還配置了日志文件不能超過50M,若超過50M,日志文件會(huì)以索引0開始, 命名日志文件,例如log-error-2018-10-26.0.log --> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>20MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> <!--日志文件保留天數(shù)--> <maxHistory>30</maxHistory> </rollingPolicy> <!-- 此日志文件只記錄info級(jí)別的 --> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>info</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <!-- 時(shí)間滾動(dòng)輸出 level為 WARN 日志 --> <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!-- 正在記錄的日志文件的路徑及文件名 --> <file>${LOG_PATH}/sys/sys_log_warn.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"> <!-- 歸檔的日志文件的路徑,例如今天是2018-10-26日志,當(dāng)前寫的日志文件路徑為file節(jié)點(diǎn)指定,可以將此文件與file指定文件路徑設(shè)置為不同路徑,從而將當(dāng)前日志文件或歸檔日志文件置不同的目錄。 而2018-10-26的日志文件在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式,%i指定索引 --> <fileNamePattern>${LOG_PATH}/sys/warn/sys_log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern> <!-- 除按日志記錄之外,還配置了日志文件不能超過50M,若超過50M,日志文件會(huì)以索引0開始, 命名日志文件,例如log-error-2018-10-26.0.log --> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>20MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> <!--日志文件保留天數(shù)--> <maxHistory>30</maxHistory> </rollingPolicy> <!-- 此日志文件只記錄warn級(jí)別的 --> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>warn</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <!-- 時(shí)間滾動(dòng)輸出 level為 ERROR 日志 --> <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!-- 正在記錄的日志文件的路徑及文件名 --> <file>${LOG_PATH}/sys/sys_log_error.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"> <!-- 歸檔的日志文件的路徑,例如今天是2018-10-26日志,當(dāng)前寫的日志文件路徑為file節(jié)點(diǎn)指定,可以將此文件與file指定文件路徑設(shè)置為不同路徑,從而將當(dāng)前日志文件或歸檔日志文件置不同的目錄。 而2018-10-26的日志文件在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式,%i指定索引 --> <fileNamePattern>${LOG_PATH}/sys/error/sys_log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern> <!-- 除按日志記錄之外,還配置了日志文件不能超過50M,若超過50M,日志文件會(huì)以索引0開始, 命名日志文件,例如log-error-2018-10-26.0.log --> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>20MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> <!--日志文件保留天數(shù)--> <maxHistory>30</maxHistory> </rollingPolicy> <!-- 此日志文件只記錄ERROR級(jí)別的 --> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>error</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <logger name="org.springframework.web" level="info"/> <logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/> <logger name="com.aisino" level="debug"/> <!--開發(fā)環(huán)境:打印控制臺(tái)--> <root level="info"> <appender-ref ref="CONSOLE"/> <appender-ref ref="DEBUG_FILE"/> <appender-ref ref="INFO_FILE"/> <appender-ref ref="WARN_FILE"/> <appender-ref ref="ERROR_FILE"/> </root> </configuration>
下一步,
我們需要在application.yml或者是application.properties中配置
#配置日志 logging: #此處存放日志的路徑 path: config: classpath:config/logback-spring.xml #指定不同目錄下的日志的級(jí)別 level: com.shimain.springboot.mapper: DEBUG
這樣我們就可以看到效果了
最后推薦一個(gè)插件喔,挺好用的,用IDEA的同學(xué),可以在IDEA中安裝一個(gè)Mybatis Log Plugin即可:
安裝完成之后,我們可以在控制臺(tái)中全選或選中日志打印的SQL:
右鍵restore sql from selection:
這樣我的執(zhí)行的SQL就會(huì)看的更加清楚明了。
總結(jié)
以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
- 重學(xué)SpringBoot3之日志Logging使用方式
- springboot的logging.group日志分組方法源碼流程解析
- springboot的LogbackLoggingSystem配置加載流程解析
- SpringBoot中的Logging詳解
- 解決springboot yml配置 logging.level 報(bào)錯(cuò)問題
- SpringBoot集成slf4j日志配置的方法
- SpringBoot項(xiàng)目的logback日志配置(包括打印mybatis的sql語句)
- 基于logback 實(shí)現(xiàn)springboot超級(jí)詳細(xì)的日志配置
- SpringBoot 下在 yml 中的 logging 日志配置方法
相關(guān)文章
Spring Boot基于Active MQ實(shí)現(xiàn)整合JMS
這篇文章主要介紹了Spring Boot基于Active MQ實(shí)現(xiàn)整合JMS,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-07-07Java HashMap在遍歷時(shí)刪除元素的實(shí)現(xiàn)
本文主要介紹了Java HashMap在遍歷時(shí)刪除元素的實(shí)現(xiàn),文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-12-12為什么Java中都不用a.equals(b)判斷對(duì)象相等
在面試中經(jīng)常會(huì)被問,a.equals(b)和“==”的區(qū)別,那么a.equals(b)能不能判斷對(duì)象相等,本文就來詳細(xì)的介紹一下2021-06-06Java中@JSONField注解用法、場(chǎng)景與實(shí)踐詳解
這篇文章主要給大家介紹了關(guān)于Java中@JSONField注解用法、場(chǎng)景與實(shí)踐的相關(guān)資料,并結(jié)合實(shí)際應(yīng)用場(chǎng)景,幫助開發(fā)者在項(xiàng)目中更高效地處理JSON數(shù)據(jù),文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下2024-12-12詳談Enumeration接口和Iterator接口的區(qū)別
下面小編就為大家?guī)硪黄斦凟numeration接口和Iterator接口的區(qū)別。小編覺得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2017-08-08SpringBoot中@ConditionalOnProperty注解的使用方法詳解
這篇文章主要介紹了SpringBoot中@ConditionalOnProperty注解的使用方法詳解,在開發(fā)基于SpringBoot框架的項(xiàng)目時(shí),會(huì)用到下面的條件注解,有時(shí)會(huì)有需要控制配置類是否生效或注入到Spring上下文中的場(chǎng)景,可以使用@ConditionalOnProperty注解來控制,需要的朋友可以參考下2024-01-01springboot post接口接受json時(shí),轉(zhuǎn)換為對(duì)象時(shí),屬性都為null的解決
這篇文章主要介紹了springboot post接口接受json時(shí),轉(zhuǎn)換為對(duì)象時(shí),屬性都為null的解決,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-10-10