快捷導(dǎo)航

SpringBoot之配置logging日志及在控制臺中輸出過程

更新時間：2023年06月19日 10:28:20 作者：shimain

這篇文章主要介紹了SpringBoot之配置logging日志及在控制臺中輸出過程，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

SpringBoot配置logging日志及在控制臺中輸出

這里以執(zhí)行的SQL語句在控制臺中輸出為例，在Spring Boot項目中配置logging日志并輸出SQL語句。

個人在最近的項目中出錯頻頻，其中大部分后臺報錯都與SQLException有關(guān)，SQL異常一般又很難查到錯誤地方，尤其是在映射文件Mapper.xml中，找到你對應(yīng)的出錯的位置，如果的你的sql很簡單，那還好，但是那是不可能，一般項目中涉及到的SQL語句也沒有就是簡單的增刪改查。

所以在你的項目中配置logging日志很有必要，這樣就很好定位是哪條SQL語句出了問題。

在Spring Boot中，默認(rèn)使用的是SLF4J+LogBack實現(xià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)幫我們配置了依賴包，我們只需要在項目的resources文件夾中間一個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"/>
    <!-- 彩色日志 --> <!-- 彩色日志依賴的渲染類,控制臺上的日志彩色顯示 -->
    <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}}"/>
    <!-- 控制臺輸出 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
            <charset>UTF-8</charset> <!-- 此處設(shè)置字符集 -->
        </encoder> 
        <!--此日志appender是為開發(fā)使用，只配置最低級別，控制臺輸出的日志級別是大于或等于此級別的日志信息-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>debug</level>
        </filter>
    </appender> 
    <!-- 時間滾動輸出 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> 
        <!-- 日志記錄器的滾動策略，按日期，按大小記錄 -->
        <rollingPolicy
                class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 歸檔的日志文件的路徑，例如今天是2018-10-26日志，當(dāng)前寫的日志文件路徑為file節(jié)點指定，可以將此文件與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，日志文件會以索引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級別的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>debug</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
    <!-- 時間滾動輸出 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>
        <!-- 日志記錄器的滾動策略，按日期，按大小記錄 -->
        <rollingPolicy
                class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!-- 歸檔的日志文件的路徑，例如今天是2018-10-26日志，當(dāng)前寫的日志文件路徑為file節(jié)點指定，可以將此文件與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，日志文件會以索引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級別的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>info</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
    <!-- 時間滾動輸出 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>
        <!-- 日志記錄器的滾動策略，按日期，按大小記錄 -->
        <rollingPolicy
                class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!-- 歸檔的日志文件的路徑，例如今天是2018-10-26日志，當(dāng)前寫的日志文件路徑為file節(jié)點指定，可以將此文件與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，日志文件會以索引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級別的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>warn</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
    <!-- 時間滾動輸出 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>
        <!-- 日志記錄器的滾動策略，按日期，按大小記錄 -->
        <rollingPolicy
                class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!-- 歸檔的日志文件的路徑，例如今天是2018-10-26日志，當(dāng)前寫的日志文件路徑為file節(jié)點指定，可以將此文件與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，日志文件會以索引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級別的 -->
        <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)境:打印控制臺-->
    <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
#指定不同目錄下的日志的級別
level:
com.shimain.springboot.mapper: DEBUG

這樣我們就可以看到效果了

運(yùn)行結(jié)果

最后推薦一個插件喔，挺好用的，用IDEA的同學(xué)，可以在IDEA中安裝一個Mybatis Log Plugin即可：

安裝完成之后，我們可以在控制臺中全選或選中日志打印的SQL：

右鍵restore sql from selection：

這樣我的執(zhí)行的SQL就會看的更加清楚明了。

總結(jié)

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

您可能感興趣的文章:

欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

SpringBoot之配置logging日志及在控制臺中輸出過程

目錄

SpringBoot配置logging日志及在控制臺中輸出

spring-boot-starter-logging-1.5.7.RELEASE.jar里面的pom.xml文件也看得出來

下面貼出我的logback-spring.xml

我們需要在application.yml或者是application.properties中配置

這樣我們就可以看到效果了

總結(jié)

相關(guān)文章

最新評論

大家感興趣的內(nèi)容

最近更新的內(nèi)容

常用在線小工具