SpringBoot進階教程 | 第二篇：日誌元件logback實現日

abcjob發表於2021-09-09
Spring Boot元件

你是否因為專案出現問題，查詢日誌檔案定位錯誤花費N多時間，是否為此苦不堪言，沒關係！現在透過這篇文章，將徹底解決你的煩惱，這篇文篇介紹，如何透過logback配置檔案將日誌進行分級列印，一個配置檔案徹底搞定日誌查詢得煩惱。

準備工作

環境：

windows
jdk 8
maven 3.0
IDEA

構建工程


project xmlns="" xmlns:xsi=""
         xsi:schemaLocation=" ">
    modelVersion>4.0.0modelVersion>

    parent>
        groupId>cn.zhangboxgroupId>
        artifactId>spring-boot-studyartifactId>
        version>1.0-SNAPSHOTversion>
    parent>

    groupId>cn.zhangboxgroupId>
    artifactId>spring-boot-logartifactId>
    version>0.0.1-SNAPSHOTversion>
    packaging>jarpackaging>

    name>spring-boot-loggingname>
    description>Demo project for Spring Bootdescription>

    properties>
        project.build.sourceEncoding>UTF-8project.build.sourceEncoding>
        project.reporting.outputEncoding>UTF-8project.reporting.outputEncoding>
        java.version>1.8java.version>
    properties>

    dependencies>
        dependency>
            groupId>org.springframework.bootgroupId>
            artifactId>spring-boot-starter-webartifactId>
        dependency>

        dependency>
            groupId>org.springframework.bootgroupId>
            artifactId>spring-boot-starter-testartifactId>
            scope>testscope>
        dependency>
    dependencies>

    build>
        plugins>
            plugin>
                groupId>org.springframework.bootgroupId>
                artifactId>spring-boot-maven-pluginartifactId>
            plugin>
        plugins>
    build>

project>

修改YML配置

#選擇哪一個環境的配置
#這裡可以在每個環境配置redis，資料庫（mysql），訊息（kafka）等相關的元件的配置
spring:
  profiles:
    active: dev

#文件塊區分為三個---
---
server:
  port: 8081
spring:
  profiles: dev
#日誌
logging:
#日誌配置檔案位置
  config: classpath:log/logback.xml
#日誌列印位置，這裡是預設在專案根路徑下
  path: log/spring-boot-log

#文件塊區分為三個---
---
server:
  port: 8082
spring:
  profiles: test
#日誌
logging:
#日誌配置檔案位置
  config: classpath:log/logback.xml
#日誌列印位置，這裡是預設在專案根路徑下
  path: usr/spring-boot/log/spring-boot-log

#文件塊區分為三個---
---
server:
  port: 8083
spring:
  profiles: prod
#日誌
logging:
#日誌配置檔案位置
  config: classpath:log/logback.xml
#日誌列印位置，這裡是預設在專案根路徑下
  path: usr/spring-boot/log/spring-boot-log

建立日誌配置檔案

在工程resources資料夾下新建資料夾log，並在該資料夾下建立logback.xml檔案,加入以下配置：

<!-- Logback configuration. See  --&gt
configuration scan="true" scanPeriod="10 seconds">
    <!--繼承spring boot提供的logback配置--&gt
    <!----&gt

    <!--設定系統日誌目錄--&gt
    property name="APP_DIR" value="spring-boot-log"/>

    <!-- 彩色日誌 --&gt
    <!-- 彩色日誌依賴的渲染類 --&gt
    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"/>
    <!-- 彩色日誌格式 --&gt
    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}}"/>

    <!-- 控制檯輸出 --&gt
    appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        encoder>
            Pattern>${CONSOLE_LOG_PATTERN}Pattern>
            charset>UTF-8charset> <!-- 此處設定字符集 --&gt
        encoder>
        <!--此日誌appender是為開發使用，只配置最底級別，控制檯輸出的日誌級別是大於或等於此級別的日誌資訊--&gt
        filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            level>debuglevel>
        filter>
    appender>

    <!-- 時間滾動輸出 level為 DEBUG 日誌 --&gt
    appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日誌檔案的路徑及檔名 --&gt
        file>${LOG_PATH}/log_debug.logfile>
        <!--日誌檔案輸出格式--&gt
        encoder>
            pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%npattern>
            charset>UTF-8charset> <!-- 此處設定字符集 --&gt
        encoder>
        <!-- 日誌記錄器的滾動策略，按日期，按大小記錄 --&gt
        rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--
                歸檔的日誌檔案的路徑，例如今天是2017-04-26日誌，當前寫的日誌檔案路徑為file節點指定，可以將此檔案與file指定檔案路徑設定為不同路徑，從而將當前日誌檔案或歸檔日誌檔案置不同的目錄。
                而2017-04-26的日誌檔案在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式，%i指定索引
            --&gt
            fileNamePattern>${LOG_PATH}/debug/log-debug-%d{yyyy-MM-dd}.%i.logfileNamePattern>
            <!--
                除按日誌記錄之外，還配置了日誌檔案不能超過500M，若超過500M，日誌檔案會以索引0開始，
                命名日誌檔案，例如log-error-2017-04-26.0.log
            --&gt
            timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                maxFileSize>500MBmaxFileSize>
            timeBasedFileNamingAndTriggeringPolicy>
            <!--日誌檔案保留天數--&gt
            maxHistory>30maxHistory>
        rollingPolicy>
        <!-- 此日誌檔案只記錄debug級別的 --&gt
        filter class="ch.qos.logback.classic.filter.LevelFilter">
            level>debuglevel>
            onMatch>ACCEPTonMatch>
            onMismatch>DENYonMismatch>
        filter>
    appender>

    <!-- 時間滾動輸出 level為 INFO 日誌 --&gt
    appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日誌檔案的路徑及檔名 --&gt
        file>${LOG_PATH}/log_info.logfile>
        <!--日誌檔案輸出格式--&gt
        encoder>
            pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%npattern>
            charset>UTF-8charset> <!-- 此處設定字符集 --&gt
        encoder>
        <!-- 日誌記錄器的滾動策略，按日期，按大小記錄 --&gt
        rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--
                歸檔的日誌檔案的路徑，例如今天是2017-04-26日誌，當前寫的日誌檔案路徑為file節點指定，可以將此檔案與file指定檔案路徑設定為不同路徑，從而將當前日誌檔案或歸檔日誌檔案置不同的目錄。
                而2017-04-26的日誌檔案在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式，%i指定索引
            --&gt
            fileNamePattern>${LOG_PATH}/info/log-info-%d{yyyy-MM-dd}.%i.logfileNamePattern>
            <!--
                除按日誌記錄之外，還配置了日誌檔案不能超過500M，若超過500M，日誌檔案會以索引0開始，
                命名日誌檔案，例如log-error-2017-04-26.0.log
            --&gt
            timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                maxFileSize>500MBmaxFileSize>
            timeBasedFileNamingAndTriggeringPolicy>
            <!--日誌檔案保留天數--&gt
            maxHistory>30maxHistory>
        rollingPolicy>
        <!-- 此日誌檔案只記錄info級別的 --&gt
        filter class="ch.qos.logback.classic.filter.LevelFilter">
            level>infolevel>
            onMatch>ACCEPTonMatch>
            onMismatch>DENYonMismatch>
        filter>
    appender>

    <!-- 時間滾動輸出 level為 WARN 日誌 --&gt
    appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日誌檔案的路徑及檔名 --&gt
        file>${LOG_PATH}/log_warn.logfile>
        <!--日誌檔案輸出格式--&gt
        encoder>
            pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%npattern>
            charset>UTF-8charset> <!-- 此處設定字符集 --&gt
        encoder>
        <!-- 日誌記錄器的滾動策略，按日期，按大小記錄 --&gt
        rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--
                歸檔的日誌檔案的路徑，例如今天是2017-04-26日誌，當前寫的日誌檔案路徑為file節點指定，可以將此檔案與file指定檔案路徑設定為不同路徑，從而將當前日誌檔案或歸檔日誌檔案置不同的目錄。
                而2017-04-26的日誌檔案在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式，%i指定索引
            --&gt
            fileNamePattern>${LOG_PATH}/warn/log-warn-%d{yyyy-MM-dd}.%i.logfileNamePattern>
            <!--
                除按日誌記錄之外，還配置了日誌檔案不能超過500M，若超過500M，日誌檔案會以索引0開始，
                命名日誌檔案，例如log-error-2017-04-26.0.log
            --&gt
            timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                maxFileSize>500MBmaxFileSize>
            timeBasedFileNamingAndTriggeringPolicy>
            <!--日誌檔案保留天數--&gt
            maxHistory>30maxHistory>
        rollingPolicy>
        <!-- 此日誌檔案只記錄warn級別的 --&gt
        filter class="ch.qos.logback.classic.filter.LevelFilter">
            level>warnlevel>
            onMatch>ACCEPTonMatch>
            onMismatch>DENYonMismatch>
        filter>
    appender>

    <!-- 時間滾動輸出 level為 ERROR 日誌 --&gt
    appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日誌檔案的路徑及檔名 --&gt
        file>${LOG_PATH}/log_error.logfile>
        <!--日誌檔案輸出格式--&gt
        encoder>
            pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%npattern>
            charset>UTF-8charset> <!-- 此處設定字符集 --&gt
        encoder>
        <!-- 日誌記錄器的滾動策略，按日期，按大小記錄 --&gt
        rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--
                歸檔的日誌檔案的路徑，例如今天是2017-04-26日誌，當前寫的日誌檔案路徑為file節點指定，可以將此檔案與file指定檔案路徑設定為不同路徑，從而將當前日誌檔案或歸檔日誌檔案置不同的目錄。
                而2017-04-26的日誌檔案在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式，%i指定索引
            --&gt
            fileNamePattern>${LOG_PATH}/error/log-error-%d{yyyy-MM-dd}.%i.logfileNamePattern>
            <!--
                除按日誌記錄之外，還配置了日誌檔案不能超過500M，若超過500M，日誌檔案會以索引0開始，
                命名日誌檔案，例如log-error-2017-04-26.0.log
            --&gt
            timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                maxFileSize>500MBmaxFileSize>
            timeBasedFileNamingAndTriggeringPolicy>
            <!--日誌檔案保留天數--&gt
            maxHistory>30maxHistory>
        rollingPolicy>
        <!-- 此日誌檔案只記錄ERROR級別的 --&gt
        filter class="ch.qos.logback.classic.filter.LevelFilter">
            level>errorlevel>
            onMatch>ACCEPTonMatch>
            onMismatch>DENYonMismatch>
        filter>
    appender>

    logger name="org.springframework.web" level="info"/>
    logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>
    logger name="cn.zhangbox.springboot" level="debug"/>

    <!--開發環境:列印控制檯--&gt
    springProfile name="dev">
        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>
    springProfile>

    <!--測試環境:列印控制檯和輸出到檔案--&gt
    springProfile name="test">
        root level="info">
            appender-ref ref="CONSOLE"/>
            appender-ref ref="INFO_FILE"/>
            appender-ref ref="WARN_FILE"/>
            appender-ref ref="ERROR_FILE"/>
        root>
    springProfile>

    <!--生產環境:輸出到檔案--&gt
    springProfile name="prod">
        root level="error">
            appender-ref ref="CONSOLE"/>
            appender-ref ref="DEBUG_FILE"/>
            appender-ref ref="INFO_FILE"/>
            appender-ref ref="ERROR_FILE"/>
        root>
    springProfile>

configuration>

注意：loback配置檔案中

logger name="cn.zhangbox.springboot" level="debug"/>

name的屬性值一定要是當前工程的java程式碼的完整目錄,因為mybatis列印的日誌級別是debug級別的，因此需要配置debug級別日誌掃描的目錄。

建立啟動類

@SpringBootApplication
public class SpringBootConfigApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringBootConfigApplication.class, args);
    }
}

控制檯列印

  .   ____          _            __ _ _
 /\ / ___'_ __ _ _(_)_ __  __ _    
( ( )___ | '_ | '_| | '_ / _` |    
 \/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |___, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::        (v1.5.3.RELEASE)

2018-07-05 15:05:13.680  INFO 15060 --- [           main] c.z.s.SpringBootLoggingApplication       : Starting SpringBootLoggingApplication on MS-20180428GSYE with PID 15060 (started by Administrator in D:開源專案spring-boot-study)
2018-07-05 15:05:13.685 DEBUG 15060 --- [           main] c.z.s.SpringBootLoggingApplication       : Running with Spring Boot v1.5.3.RELEASE, Spring v4.3.8.RELEASE
2018-07-05 15:05:13.686  INFO 15060 --- [           main] c.z.s.SpringBootLoggingApplication       : The following profiles are active: dev
2018-07-05 15:05:13.766  INFO 15060 --- [           main] ationConfigEmbeddedWebApplicationContext : Refreshing org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext@79d94571: startup date [Thu Jul 05 15:05:13 GMT+08:00 2018]; root of context hierarchy
2018-07-05 15:05:14.223  INFO 15060 --- [kground-preinit] o.h.validator.internal.util.Version      : HV000001: Hibernate Validator 5.3.5.Final
2018-07-05 15:05:15.550  INFO 15060 --- [           main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat initialized with port(s): 8081 (http)
2018-07-05 15:05:15.563  INFO 15060 --- [           main] o.apache.catalina.core.StandardService   : Starting service Tomcat
2018-07-05 15:05:15.565  INFO 15060 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet Engine: Apache Tomcat/8.5.14
2018-07-05 15:05:15.703  INFO 15060 --- [ost-startStop-1] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2018-07-05 15:05:15.704  INFO 15060 --- [ost-startStop-1] o.s.web.context.ContextLoader            : Root WebApplicationContext: initialization completed in 1938 ms
2018-07-05 15:05:15.869  INFO 15060 --- [ost-startStop-1] o.s.b.w.servlet.ServletRegistrationBean  : Mapping servlet: 'dispatcherServlet' to [/]
2018-07-05 15:05:15.876  INFO 15060 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'characterEncodingFilter' to: [/*]
2018-07-05 15:05:15.877  INFO 15060 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'hiddenHttpMethodFilter' to: [/*]
2018-07-05 15:05:15.877  INFO 15060 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'httpPutFormContentFilter' to: [/*]
2018-07-05 15:05:15.877  INFO 15060 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'requestContextFilter' to: [/*]
2018-07-05 15:05:16.219  INFO 15060 --- [           main] s.w.s.m.m.a.RequestMappingHandlerAdapter : Looking for @ControllerAdvice: org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext@79d94571: startup date [Thu Jul 05 15:05:13 GMT+08:00 2018]; root of context hierarchy
2018-07-05 15:05:16.298  INFO 15060 --- [           main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/error]}" onto public org.springframework.http.ResponseEntity> org.springframework.boot.autoconfigure.web.BasicErrorController.error(javax.servlet.http.HttpServletRequest)
2018-07-05 15:05:16.299  INFO 15060 --- [           main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/error],produces=[text/html]}" onto public org.springframework.web.servlet.ModelAndView org.springframework.boot.autoconfigure.web.BasicErrorController.errorHtml(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)
2018-07-05 15:05:16.328  INFO 15060 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/webjars/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2018-07-05 15:05:16.328  INFO 15060 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2018-07-05 15:05:16.369  INFO 15060 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/**/favicon.ico] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2018-07-05 15:05:16.616  INFO 15060 --- [           main] o.s.j.e.a.AnnotationMBeanExporter        : Registering beans for JMX exposure on startup
2018-07-05 15:05:16.636  INFO 15060 --- [           main] o.a.coyote.http11.Http11NioProtocol      : Initializing ProtocolHandler ["http-nio-8081"]
2018-07-05 15:05:16.645  INFO 15060 --- [           main] o.a.coyote.http11.Http11NioProtocol      : Starting ProtocolHandler ["http-nio-8081"]
2018-07-05 15:05:16.659  INFO 15060 --- [           main] o.a.tomcat.util.net.NioSelectorPool      : Using a shared selector for servlet write/read
2018-07-05 15:05:16.679  INFO 15060 --- [           main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 8081 (http)
2018-07-05 15:05:16.685  INFO 15060 --- [           main] c.z.s.SpringBootLoggingApplication       : Started SpringBootLoggingApplication in 4.291 seconds (JVM running for 5.767)

本地日誌列印效果

圖片描述

這裡因為logback配置中將不同級別的日誌設定了在不同檔案中列印，這樣很大程度上方便專案出問題查詢問題。

原始碼地址

來自 “ ITPUB部落格 ” ，連結：http://blog.itpub.net/4798/viewspace-2804686/，如需轉載，請註明出處，否則將追究法律責任。

相關文章