springboot下新增日誌模組和設定日誌檔案輸出

Scotyzh發表於2023-12-12

前言

日誌的使用將透過SLF4J來使用，SLF4J（Simple Logging Facade for Java）是一個為Java應用提供簡單日誌記錄的介面。它的主要目標是在不同的日誌系統之間提供一個簡單的抽象層，使得應用能夠以一種靈活的方式切換日誌實現，而不需要修改應用本身的程式碼。SLF4J不是一個具體的日誌實現，而是一個橋接，它與其他具體的日誌系統（如Log4J、Logback、Java Util Logging等）一起使用。在Spring框架中，SLF4J常常用於處理框架本身以及應用程式的日誌記錄。

使用

在pom檔案新增以下依賴，使用logback，由於logback1.2.9以下存在漏洞，推薦使用1.2.9及以上版本

    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>1.18.30</version>
      <optional>true</optional>
    </dependency>

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

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

在需要使用的類上面標註@Slf4j，即可使用log的相關方法，比如在全域性異常類可以這樣使用：

@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {

    /********************************
     *  @function  : 自定義從捕捉
     *  @parameter : [e:CustomException | 自定義異常]
     *  @date      : 2023/12/5 11:47
     ********************************/
    @ExceptionHandler(value = CustomException.class)
    public AjaxResult customExceptionHandler(HttpServletRequest request, CustomException e) {
        log.error("業務異常，url：{}, 異常內容：{}" ,request.getRequestURI(), e);
        return new AjaxResult(e.getCode() , e.getMessage(), null);
    }

    /********************************
     *  @function  : 空指標異常捕捉
     *  @parameter : [e：Exception | 異常]
     *  @date      : 2023/12/5 11:47
     ********************************/
    @ExceptionHandler(value = Exception.class)
    public AjaxResult exceptionHandler(HttpServletRequest request, Exception e) {
        log.error("伺服器內部異常異常，url：{}, 異常內容：{}" ,request.getRequestURI(), e);
        return new AjaxResult(500 , e.getMessage(), null);
    }

}

在try,catch中的使用，catch中不要使用e.printstacktrace,使用log代替：

try {
...
} catch {
  log.error{"..傳送了異常，引數是{},異常資訊{}"，id,e};
}

阿里巴巴的日誌規範

【強制】應用中不可直接使用日誌系統（Log4j、Logback）中的API，而應依賴使用日誌框架SLF4J中的API，使用門面模式的日誌框架，有利於維護和各個類的日誌處理方式統一。
```
import org.slf4j.Logger;import org.slf4j.LoggerFactory;private static final Logger logger = LoggerFactory.getLogger(Abc.class);  
```
【強制】日誌檔案推薦至少儲存15天，因為有些異常具備以“周”為頻次發生的特點。
【強制】應用中的擴充套件日誌（如打點、臨時監控、訪問日誌等）命名方式：appName_logType_logName.log。logType:日誌型別，推薦分類有stats/monitor/visit等；logName:日誌描述。這種命名的好處：透過檔名就可知道日誌檔案屬於什麼應用，什麼型別，什麼目的，也有利於歸類查詢。
```
正例：mppserver應用中單獨監控時區轉換異常，如：
mppserver_monitor_timeZoneConvert.log
```
說明：推薦對日誌進行分類，如將錯誤日誌和業務日誌分開存放，便於開發人員檢視，也便於透過日誌對系統進行及時監控。

【強制】對trace/debug/info級別的日誌輸出，必須使用條件輸出形式或者使用佔位符的方式。

說明：logger.debug(“Processing trade with id: “ + id + “ and symbol: “ + symbol); 如果日誌級別是warn，上述日誌不會列印，但是會執行字串拼接操作，如果symbol是物件，會執行toString()方法，浪費了系統資源，執行了上述操作，最終日誌卻沒有列印。

正例：

（條件）    
    if (logger.isDebugEnabled()) {      
        logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);     
    }

正例：

（佔位符）
    logger.debug("Processing trade with id: {} and symbol : {} ", id, symbol);

【強制】避免重複列印日誌，浪費磁碟空間，務必在log4j.xml中設定additivity=false。

正例：
<logger name="com.taobao.dubbo.config" additivity="false">
【強制】異常資訊應該包括兩類資訊：案發現場資訊和異常堆疊資訊。如果不處理，那麼透過關鍵字throws往上丟擲。

正例：
```
logger.error(各類引數或者物件toString + "_" + e.getMessage(), e);
```
【推薦】謹慎地記錄日誌。生產環境禁止輸出debug日誌；有選擇地輸出info日誌；如果使用warn來記錄剛上線時的業務行為資訊，一定要注意日誌輸出量的問題，避免把伺服器磁碟撐爆，並記得及時刪除這些觀察日誌。
說明：大量地輸出無效日誌，不利於系統效能提升，也不利於快速定位錯誤點。記錄日誌時請思考：這些日誌真的有人看嗎？看到這條日誌你能做什麼？能不能給問題排查帶來好處？
【推薦】可以使用warn日誌級別來記錄使用者輸入引數錯誤的情況，避免使用者投訴時，無所適從。如非必要，請不要在此場景打出error級別，避免頻繁報警。

說明：注意日誌輸出的級別，error級別只記錄系統邏輯出錯、異常或者重要的錯誤資訊。

日誌的配置檔案

配置日誌檔案的持久化，示例如下：

<?xml version="1.0" encoding="UTF-8"?>
<!-- 日誌級別從低到高分為TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果設定為WARN，則低於WARN的資訊都不會輸出 -->
<!-- scan:當此屬性設定為true時，配置文件如果發生改變，將會被重新載入，預設值為true -->
<!-- scanPeriod:設定監測配置文件是否有修改的時間間隔，如果沒有給出時間單位，預設單位是毫秒。
                 當scan為true時，此屬性生效。預設的時間間隔為1分鐘。 -->
<!-- debug:當此屬性設定為true時，將列印出logback內部日誌資訊，實時檢視logback執行狀態。預設值為false。 -->
<configuration  scan="true" scanPeriod="10 seconds">
    <contextName>logback</contextName>

    <!-- name的值是變數的名稱，value的值時變數定義的值。透過定義的值會被插入到logger上下文中。定義後，可以使“${}”來使用變數。 -->
    <property name="log.path" value="./log" />

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

    <!--1. 輸出到控制檯-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!--此日誌appender是為開發使用，只配置最底級別，控制檯輸出的日誌級別是大於或等於此級別的日誌資訊-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>debug</level>
        </filter>
        <encoder>
            <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS}---[%thread] %-5level %logger{50} - %msg%n</Pattern>
            <!-- 設定字符集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!--2. 輸出到文件-->
    <!-- 2.1 level為 DEBUG 日誌，時間滾動輸出  -->
    <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--日誌文件輸出格式-->
        <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}/debug/web-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>10MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日誌文件保留天數-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日誌文件只記錄debug級別的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>debug</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 2.2 level為 INFO 日誌，時間滾動輸出  -->
    <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--日誌文件輸出格式-->
        <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}/info/web-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>10MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日誌文件保留天數-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日誌文件只記錄info級別的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>info</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 2.3 level為 WARN 日誌，時間滾動輸出  -->
    <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--日誌文件輸出格式-->
        <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}/warn/web-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>10MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日誌文件保留天數-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日誌文件只記錄warn級別的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>warn</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 2.4 level為 ERROR 日誌，時間滾動輸出  -->
    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--日誌文件輸出格式-->
        <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}/error/web-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>10MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日誌文件保留天數-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日誌文件只記錄ERROR級別的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>


    <!--
        <logger>用來設定某一個包或者具體的某一個類的日誌列印級別、
        以及指定<appender>。<logger>僅有一個name屬性，
        一個可選的level和一個可選的addtivity屬性。
        name:用來指定受此logger約束的某一個包或者具體的某一個類。
        level:用來設定列印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
              還有一個特俗值INHERITED或者同義詞NULL，代表強制執行上級的級別。
              如果未設定此屬性，那麼當前logger將會繼承上級的級別。
        addtivity:是否向上級logger傳遞列印資訊。預設是true。
        <logger name="org.springframework.web" level="info"/>
        <logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>
    -->

    <!--
        使用mybatis的時候，sql語句是debug下才會列印，而這裡我們只配置了info，所以想要檢視sql語句的話，有以下兩種操作：
        第一種把<root level="info">改成<root level="DEBUG">這樣就會列印sql，不過這樣日誌那邊會出現很多其他訊息
        第二種就是單獨給dao下目錄配置debug模式，程式碼如下，這樣配置sql語句會列印，其他還是正常info級別：
        【logging.level.org.mybatis=debug logging.level.dao=debug】
     -->

    <!--
        root節點是必選節點，用來指定最基礎的日誌輸出級別，只有一個level屬性
        level:用來設定列印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
        不能設定為INHERITED或者同義詞NULL。預設是DEBUG
        可以包含零個或多個元素，標識這個appender將會新增到這個logger。
    -->

    <!-- 4. 最終的策略 -->
    <!-- 4.1 開發環境:列印控制檯-->
    <!--    <springProfile name="dev">-->
    <!--        <logger name="com" level="debug"/>-->

    <!--    </springProfile>-->


    <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>

    <!-- 4.2 生產環境:輸出到文件
    <springProfile name="pro">
        <root level="info">
            <appender-ref ref="CONSOLE" />
            <appender-ref ref="DEBUG_FILE" />
            <appender-ref ref="INFO_FILE" />
            <appender-ref ref="ERROR_FILE" />
            <appender-ref ref="WARN_FILE" />
        </root>
    </springProfile> -->

</configuration>

其中，日誌檔案的大小和路徑名稱可以透過這塊進行修改：

 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/error/web-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>10MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日誌文件保留天數-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>

透過以上配置，產生的日誌檔案結構如下：

第一層是log資料夾：

第二層是各個級別資料夾：

第三層是每個日期的檔案

SpringBoot指定日誌檔案和日誌Profile功能
2018-11-10
Spring Boot
新增日誌檔案組與日誌檔案成員
2012-03-08
Log4j輸出到指定日誌檔案
2012-11-29
Laravel 指定日誌檔案記錄任意日誌
2020-03-10
Laravel
SpringBoot通過yml和xml檔案配置日誌輸出
2019-04-01
Spring BootXML
Spring按業務模組輸出日誌到不同的檔案
2022-05-06
Spring
操作日誌記錄(包括輸出至自定義日誌檔案)
2020-10-16
新增日誌組以及調整日誌的大小
2015-05-28
python怎麼將列印輸出日誌檔案
2021-09-11
Python
日誌檔案和歸檔日誌檔案的關係以及如何切換日誌
2014-08-04
MySQL資料庫中的日誌檔案---(4)配置日誌檔案輸出路徑
2011-10-10
MySql資料庫
日誌檔案和歸檔管理
2013-12-11
對日誌檔案組和日誌檔案組成員的管理
2010-01-12
C++中的檔案輸入/輸出（4）：檢測輸入/輸出的狀態標誌 (轉)
2008-01-11
C++
新硬體環境下日誌模組的設計與演進
2018-07-12
容器設定日誌驅動程式 - docker --log-driver
2024-08-23
Docker
日誌模組(一標頭檔案就實現了日誌記錄)
2013-07-16
C語言log日誌管理-支援檔案與終端輸出
2018-11-17
C語言
reportbuilder 日誌輸出
2014-04-24
UI
Python輸出日誌
2012-08-06
Python
增加日誌檔案，修改當前日誌檔案大小
2011-03-30
【Oracle日誌】- 日誌檔案重建
2011-01-24
Oracle
Oracle日誌組新增冗餘檔案和日誌組
2017-09-13
Oracle
日誌檔案
2014-10-30
排查log4j不輸出日誌到檔案的問題
2022-02-18
spark指令碼日誌輸出級別設定
2016-12-05
Spark指令碼
從Jboss預設日誌檔案中分離應用日誌
2014-01-17
應用日誌
python如何輸出日誌？
2021-09-11
Python
Java日誌輸出問題
2016-12-07
Java
awk多行日誌排序輸出
2013-11-15
排序
Oracle設定日誌引數-ALTER DATABASE ADD SUPPLEMENTAL LOG DATA;
2024-02-27
OracleDatabase
刪除日誌檔案組與日誌檔案成員
2012-03-12
SLF4J記錄日誌&&日誌檔案的滾動策略__SpringBoot
2024-03-22
Spring Boot
日誌檔案太大，壓縮後，限制檔案的大小，但出現日誌檔案已經滿的告警
2007-07-08
管理日誌檔案
2016-10-15
dump日誌檔案
2009-04-09
APACHE日誌檔案
2007-10-08
Apache
logback下日誌輸出前處理操作——以日誌脫敏為例
2024-08-04

springboot下新增日誌模組和設定日誌檔案輸出

前言

使用

阿里巴巴的日誌規範

日誌的配置檔案

相關文章