springboot下新增紀錄檔模組和設定紀錄檔檔案輸出
2023-12-12 12:01:22
前言
紀錄檔的使用將通過SLF4J來使用，SLF4J（Simple Logging Facade for Java）是一個為Java應用提供簡單紀錄檔記錄的介面。它的主要目標是在不同的紀錄檔系統之間提供一個簡單的抽象層，使得應用能夠以一種靈活的方式切換紀錄檔實現，而不需要修改應用本身的程式碼。SLF4J不是一個具體的紀錄檔實現，而是一個橋接，它與其他具體的紀錄檔系統（如Log4J、Logback、Java Util Logging等）一起使用。在Spring框架中，SLF4J常常用於處理框架本身以及應用程式的紀錄檔記錄。
使用
在pom檔案新增以下依賴，使用logback，由於logback1.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.4.14</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-core</artifactId>
<version>1.4.14</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資料夾：
第二層是各個級別資料夾：
第三層是每個日期的檔案
