日志框架概述

在一個 web 項目建設中，如果說第一件事是 Spring 框架的搭建，那么第二件事就是日志框架的搭建，線上 web 項目的日志可能是我們了解項目運行的唯一方式。

常用日志框架

• java.util.logging：是 JDK 在1.4版本中引入的Java原生日志框架
• Log4j：Apache 的開源項目，可以控制日志信息輸送的目的地是控制臺、文件、GUI組件等，可以控制每一條日志的輸出格式，這些可以通過一個配置文件來靈活地進行配置，而不需要修改應用的代碼。雖然已經停止維護了，但目前絕大部分企業都是用的log4j。
• LogBack：是Log4j的一個改良版本
• Log4j2：Log4j2已經不僅僅是Log4j的一個升級版本了，它從頭到尾都被重寫了

為什么使用 log4j2

Spring Boot 默認使用的是 logback 的日志框架，不過在性能評測中，在同步日志模式下, Logback 的性能是最糟糕的，log4j2 的性能無論在同步日志模式還是異步日志模式下都是最佳的。

整合步驟

pom.xml 引入 jar 包

Spring Boot 默認是用 logback 的日志框架的，所以需要排除 logback，不然會出現 jar 依賴沖突的報錯。

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId><exclusions><!-- 去掉springboot默認配置 --><exclusion><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-logging</artifactId></exclusion></exclusions> </dependency> <!-- 引入log4j2依賴 --> <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-log4j2</artifactId> </dependency>

配置文件

Spring boot 默認日志文件名稱為 log4j2-spring.xml，可以省略在 application.yml 中的配置，如果需要指定配置文件需要在 Spring boot 配置文件 application.yml 中指定 logging.config 屬性.

logging:path: classpath:log4j2-prod.xml

如果日志的打印不需要區分環境，建議使用 log4j2-spring.xml 來命名配置文件。

下面是一份比較詳細的 log4j2 配置文件示例 ：

<?xml version="1.0" encoding="UTF-8"?> <!--Configuration后面的status，這個用于設置log4j2自身內部的信息輸出，可以不設置，當設置成trace時，你會看到log4j2內部各種詳細輸出--> <!--monitorInterval：Log4j能夠自動檢測修改配置 文件和重新配置本身，設置間隔秒數--> <configuration monitorInterval="5"><!--日志級別以及優先級排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL --><!--變量配置--><Properties><!-- 格式化輸出：%date表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度 %msg：日志消息，%n是換行符--><!-- %logger{36} 表示 Logger 名字最長36個字符 --><property name="LOG_PATTERN" value="%date{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n" /><!-- 定義日志存儲的路徑，不要配置相對路徑 --><property name="FILE_PATH" value="D:alog" /><property name="FILE_NAME" value="example" /></Properties><appenders><console name="Console" target="SYSTEM_OUT"><!--輸出日志的格式--><PatternLayout pattern="${LOG_PATTERN}"/><!--控制臺只輸出level及其以上級別的信息（onMatch），其他的直接拒絕（onMismatch）--><ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/></console><!--文件會打印出所有信息，這個log每次運行程序會自動清空，由append屬性決定，適合臨時測試用--><File name="Filelog" fileName="${FILE_PATH}/debug.log" append="false"><PatternLayout pattern="${LOG_PATTERN}"/></File><!-- 這個會打印出所有的info及以下級別的信息，每次大小超過size，則這size大小的日志會自動存入按年份-月份建立的文件夾下面并進行壓縮，作為存檔--><RollingFile name="RollingFileInfo" fileName="${FILE_PATH}/info.log" filePattern="${FILE_PATH}/${FILE_NAME}-INFO-%d{yyyy-MM-dd}_%i.log.gz"><!--控制臺只輸出level及以上級別的信息（onMatch），其他的直接拒絕（onMismatch）--><ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/><PatternLayout pattern="${LOG_PATTERN}"/><Policies><!--interval屬性用來指定多久滾動一次，默認是1 hour--><TimeBasedTriggeringPolicy interval="1"/><SizeBasedTriggeringPolicy size="10MB"/></Policies><!-- DefaultRolloverStrategy屬性如不設置，則默認為最多同一文件夾下7個文件開始覆蓋--><DefaultRolloverStrategy max="15"/></RollingFile><!-- 這個會打印出所有的warn及以下級別的信息，每次大小超過size，則這size大小的日志會自動存入按年份-月份建立的文件夾下面并進行壓縮，作為存檔--><RollingFile name="RollingFileWarn" fileName="${FILE_PATH}/warn.log" filePattern="${FILE_PATH}/${FILE_NAME}-WARN-%d{yyyy-MM-dd}_%i.log.gz"><!--控制臺只輸出level及以上級別的信息（onMatch），其他的直接拒絕（onMismatch）--><ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/><PatternLayout pattern="${LOG_PATTERN}"/><Policies><!--interval屬性用來指定多久滾動一次，默認是1 hour--><TimeBasedTriggeringPolicy interval="1"/><SizeBasedTriggeringPolicy size="10MB"/></Policies><!-- DefaultRolloverStrategy屬性如不設置，則默認為最多同一文件夾下7個文件開始覆蓋--><DefaultRolloverStrategy max="15"/></RollingFile><!-- 這個會打印出所有的error及以下級別的信息，每次大小超過size，則這size大小的日志會自動存入按年份-月份建立的文件夾下面并進行壓縮，作為存檔--><RollingFile name="RollingFileError" fileName="${FILE_PATH}/error.log" filePattern="${FILE_PATH}/${FILE_NAME}-ERROR-%d{yyyy-MM-dd}_%i.log.gz"><!--控制臺只輸出level及以上級別的信息（onMatch），其他的直接拒絕（onMismatch）--><ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/><PatternLayout pattern="${LOG_PATTERN}"/><Policies><!--interval屬性用來指定多久滾動一次，默認是1 hour--><TimeBasedTriggeringPolicy interval="1"/><SizeBasedTriggeringPolicy size="10MB"/></Policies><!-- DefaultRolloverStrategy屬性如不設置，則默認為最多同一文件夾下7個文件開始覆蓋--><DefaultRolloverStrategy max="15"/></RollingFile></appenders><!--Logger節點用來單獨指定日志的形式，比如要為指定包下的class指定不同的日志級別等。--><!--然后定義loggers，只有定義了logger并引入的appender，appender才會生效--><loggers><!--過濾掉spring和mybatis的一些無用的DEBUG信息--><logger name="org.mybatis" level="info" additivity="false"><AppenderRef ref="Console"/></logger><!--監控系統信息--><!--若是additivity設為false，則 子Logger 只會在自己的appender里輸出，而不會在 父Logger 的appender里輸出。--><Logger name="org.springframework" level="info" additivity="false"><AppenderRef ref="Console"/></Logger><root level="info"><appender-ref ref="Console"/><appender-ref ref="Filelog"/><appender-ref ref="RollingFileInfo"/><appender-ref ref="RollingFileWarn"/><appender-ref ref="RollingFileError"/></root></loggers> </configuration>

簡單使用

@RestController public class HelloController {private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(HelloController.class);@GetMapping("/hello")public String index(){log.debug("This is a [{}].","debug log");log.info("This is a [{}].","info log");log.warn("This is a [{}].","warn log");log.error("This is a [{}].","error log");return "hello index!";} }

---

擴展

Log4j2配置詳解

根節點 Configuration

有兩個屬性:

• status
• monitorinterval

有兩個子節點:

• Appenders
• Loggers(表明可以定義多個Appender和Logger).

status用來指定log4j本身的打印日志的級別.

monitorinterval用于指定log4j自動重新配置的監測間隔時間，單位是s,最小是5s.

Appenders節點

常見的有三種子節點:Console、RollingFile、File

Console節點用來定義輸出到控制臺的Appender.

• name:指定Appender的名字.
• target:SYSTEM_OUT 或 SYSTEM_ERR,一般只設置默認:SYSTEM_OUT.
• PatternLayout:輸出格式，不設置默認為:%m%n.

File節點用來定義輸出到指定位置的文件的Appender.

• name:指定Appender的名字.
• fileName:指定輸出日志的目的文件帶全路徑的文件名.
• PatternLayout:輸出格式，不設置默認為:%m%n.

RollingFile節點用來定義超過指定條件自動刪除舊的創建新的Appender.

• name:指定Appender的名字.
• fileName:指定輸出日志的目的文件帶全路徑的文件名.
• PatternLayout:輸出格式，不設置默認為:%m%n.
• filePattern : 指定當發生Rolling時，文件的轉移和重命名規則.
• Policies:指定滾動日志的策略，就是什么時候進行新建日志文件輸出日志.
• TimeBasedTriggeringPolicy:Policies子節點，基于時間的滾動策略，interval屬性用來指定多久滾動一次，默認是1 hour。modulate=true用來調整時間：比如現在是早上3am，interval是4，那么第一次滾動是在4am，接著是8am，12am...而不是7am.
• SizeBasedTriggeringPolicy:Policies子節點，基于指定文件大小的滾動策略，size屬性用來定義每個日志文件的大小.
• DefaultRolloverStrategy:用來指定同一個文件夾下最多有幾個日志文件時開始刪除最舊的，創建新的(通過max屬性)。

Loggers節點，常見的有兩種:Root和Logger.

• Root節點用來指定項目的根日志，如果沒有單獨指定Logger，那么就會默認使用該Root日志輸出
• level:日志輸出級別，共有8個級別，按照從低到高為：All < Trace < Debug < Info < Warn < Error < AppenderRef：Root的子節點，用來指定該日志輸出到哪個Appender.
• Logger節點用來單獨指定日志的形式，比如要為指定包下的class指定不同的日志級別等。
• level:日志輸出級別，共有8個級別，按照從低到高為：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
• name:用來指定該Logger所適用的類或者類所在的包全路徑,繼承自Root節點.
• AppenderRef：Logger的子節點，用來指定該日志輸出到哪個Appender,如果沒有指定，就會默認繼承自Root.如果指定了，那么會在指定的這個Appender和Root的Appender中都會輸出，此時我們可以設置Logger的additivity="false"只在自定義的Appender中進行輸出。

總結

以上是生活随笔為你收集整理的spring日志报错提醒_Spring Boot 2.x : 整合日志框架 Log4j2的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。