SpringBoot 使用 slf4j+logback 進行日志管理

一、基礎知識：

1.日志系統

　　系統日志是記錄系統中硬件、軟件和系統問題的信息，同時還可以監視系統中發生的事件。用戶可以通過它來檢查錯誤發生的原因，或者尋找受到攻擊時攻擊者留下的痕跡。系統日志包括系統日志、應用程序日志和安全日志。-- 百度百科

　　日志的管理是系統很重要的一部分，千萬不可忽略其重要性。完整的日志將會在系統維護中起着異常重要的作用，就好像磨刀不誤砍柴工一樣，日志就像對系統進行分析的工具，工具便捷了，對系統分析起來就能達到事半功倍的效果。

　　現代的應用程序已經離不開日志系統，所以學會正確高效地配置一套日志系統是一位后端開發工程師必備的技能。本篇文章我將逐步講解使用 slf4j+logback 來對 SpringBoot 項目進行日志管理，僅作為參考，歡迎大家提出意見。

2.主流框架

　　當今Java程序中常見的日志框架有：Log4j、J.U.L(jdk-logging)、J.C.L(commons-logging)、Slf4j、Logback、Log4j2。一共是2個日志接口標准和4個具體的實現。具體內容可參見大佬文章 -- Java日志框架演化歷史

　　之前最流行的搭配是使用 J.C.L+Log4j 的形式，從目前趨勢來看，越來越多的開源項目逐步轉向了 slf4j+logback，所以本篇文章主要講解 slf4j+logback 的實現方式，其它實現形式大家感興趣可以自行百度。

3.logback

　　logback 是一個開源的日志組件，同樣是由log4j的作者設計完成的，擁有更好的特性，是用來取代log4j的一個日志框架。它擁有更快的實現、更充分的測試、更充分的文檔、更細粒度的日志管理，所以讓它現在變得越來越受歡迎。

二、在 SpringBoot 項目中使用 logback ：

1.添加依賴

　　logback 有三個主要模塊：　　　

　　　　logback-core：是logback-access，logback-classic兩個模塊的基礎。

　　　　logback-classic：它是log4j的一個改良版本，同時它完整實現了slf4j API，使我們可以在其他日志系統，如log4j和JDK14 Logging中進行轉換。

　　　　logback-access：訪問模塊和Servlet容器集成，為tomcat等提供通過Http來訪問日志的功能。

　　如果項目使用了 spring-boot-starter，那么依賴已經添加不必再手動引入，否則需要自己手動添加依賴：

　　

 　　否則要手動添加maven依賴：

<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-api</artifactId>
  <version>1.7.21</version>
</dependency>

<dependency>
  <groupId>ch.qos.logback</groupId>
  <artifactId>logback-core</artifactId>
  <version>1.1.7</version>
</dependency>
<dependency>
  <groupId>ch.qos.logback</groupId>
  <artifactId>logback-classic</artifactId>
  <version>1.1.7</version>
</dependency>

 

2.添加配置文件

　　在 resources 文件夾下新建 logback-spring.xml 文件：

<?xml version="1.0" encoding="UTF-8"?>
<!--
    scan: 當此屬性設置為true時，配置文件如果發生改變，將會被重新加載，默認值為true。
    scanPeriod: 設置監測配置文件是否有修改的時間間隔，如果沒有給出時間單位，默認單位是毫秒。當scan為true時，此屬性生效。默認的時間間隔為1分鍾。
    debug: 當此屬性設置為true時，將打印出logback內部日志信息，實時查看logback運行狀態。默認值為false。
    configuration 子節點為 appender、logger、root
-->
<configuration scan="true" scanPeriod="60 seconds" debug="true">

    <!--用於區分不同應用程序的記錄-->
    <contextName>test-logback</contextName>

    <!--日志文件所在目錄，如果是tomcat，如下寫法日志文件會在則為${TOMCAT_HOME}/bin/logs/目錄下-->
    <property name="LOG_HOME_WINDOWS" value="F:/logs"/>
    <property name="LOG_HOME_LINUX" value="./logs"/>

    <!-- 彩色日志 -->
    <!-- 彩色日志依賴的渲染類 -->
    <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" />
    <!-- 彩色日志格式   [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n  -->
    <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="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度，%logger：輸出日志的logger名，%msg：日志消息，%n是換行符 -->
            <pattern>${CONSOLE_LOG_PATTERN}</pattern><!--彩打日志-->
            <!--解決亂碼問題-->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!--滾動文件，即隨指定策略記錄日志到指定文件-->
    <appender name="infoFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- ThresholdFilter:臨界值過濾器，過濾掉 TRACE 和 DEBUG 級別的日志 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level><!--等級從低到高分別是ALL < TRACE < DEBUG < INFO < WARN < ERROR < OFF-->
        </filter>
        <!--滾動策略-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_HOME_WINDOWS}/info/info.%d{yyyy-MM-dd}.log</fileNamePattern><!--文件名-->
            <maxHistory>30</maxHistory><!--保存最近30天的日志-->
            <totalSizeCap>20GB</totalSizeCap><!--所有的日志文件最大20G，超過就會刪除舊的日志-->
            <cleanHistoryOnStart>true</cleanHistoryOnStart><!--appender 啟動的時候，是否刪除歸檔文件-->
        </rollingPolicy>
        <!--日志格式化策略-->
        <encoder>
            <charset>UTF-8</charset>
            <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] %-5level %logger{36} : %msg%n</pattern>
        </encoder>
    </appender>

    <!--另一個滾動文件寫法-->
    <appender name="errorFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>test.log</file>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <fileNamePattern>test.%i.log.zip</fileNamePattern>
            <minIndex>1</minIndex>
            <maxIndex>3</maxIndex>
        </rollingPolicy>
        <!--當文件大小超過5MB時，通知RollingPolicy輪轉-->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <maxFileSize>5MB</maxFileSize>
        </triggeringPolicy>
        <encoder>
            <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] %-5level %logger{36} : %msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!--配置多環境日志輸出  可以在application.properties中配置選擇哪個profiles-->
    <!--開發環境:打印控制台-->
    <springProfile name="dev">
        <root level="debug">
            <appender-ref ref="stdout" />
            <appender-ref ref="infoFile" />
            <appender-ref ref="errorFile" />
        </root>
    </springProfile>
    <!--生產環境:只輸出到文件-->
    <springProfile name="pro">
        <root level="info">
            <appender-ref ref="infoFile" />
            <appender-ref ref="errorFile" />
        </root>
    </springProfile>

</configuration>

　　配合多環境配置文件：application.yml、application-dev.yml、application-pro.yml

　　在主配置文件中具體選擇使用不同的環境，application.yml：

spring:
  profiles:
    active: dev

三、配置文件 logback-spring.xml 詳解：

　　基本結構如下：

<?xml version="1.0" encoding="UTF-8"?>
<!-- 根節點 -->
<configuration scan="true" scanPeriod="60 seconds" debug="true">
    <!-- 用於區分不同應用程序的記錄 -->
    <contextName>xxx</contextName>
    <!-- 定義參數常量 -->
    <property name="xxx" value="yyy"/>
    <!-- 用於說明輸出介質，此處說明控制台輸出 -->
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>xxx</pattern><!-- 打印格式 -->
            <charset>UTF-8</charset><!-- 解決亂碼問題 -->
        </encoder>
    </appender>
    <!-- 用於說明輸出介質，此處說明文件輸出 -->
    <appender name="fileout" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 過濾器，用於篩選不同級別的日志 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level><!-- 等級從低到高分別是ALL < TRACE < DEBUG < INFO < WARN < ERROR < OFF -->
        </filter>
        <!--滾動策略-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>xxx</fileNamePattern><!-- 日志文件名 -->
            <maxHistory>xxx</maxHistory><!-- 最大保存周期，超過刪除舊的日志 -->
            <totalSizeCap>xxx</totalSizeCap><!-- 總日志大小，超過刪除舊的日志 -->
            <cleanHistoryOnStart>false</cleanHistoryOnStart><!-- appender 啟動的時候，是否刪除歸檔文件，默認false -->
        </rollingPolicy>
        <encoder>
            <charset>xxx</charset>
            <pattern>xxx</pattern>
        </encoder>
    </appender>
    <!-- 用於存放日志對象，同時指定關聯的package位置 -->
    <logger name="xxx" level="xxx" additivity="true">
        <appender-ref ref="stdout" />
        <appender-ref ref="fileout" />
    </logger>
    <!-- 特殊的logger，根logger -->
    <root lever="info">
        <appender-ref ref="stdout" /><!-- 指定默認的日志輸出 -->
    </root>
</configuration>

 

這里推薦一個學習地址 -- Javaschool

關於 logback.xml 和 logback-spring.xml 的區別，參見大佬文章 -- logback.xml 和 logback-spring.xml 的區別

四、效果演示

在項目中使用log有兩種方法：1.添加Lombok依賴，通過注解引入；2.通過工廠方式使用。

簡單效果如下：

 輸出日志：

到這里本文章基本就結束了，最后再給大家推薦一個B站up視頻 -- 使用 logback 輸出日志

參考文章：https://www.cnblogs.com/ergwang/p/14600913.html