日志框架概述

在一個(gè) web 項(xiàng)目建設(shè)中，如果說第一件事是 Spring 框架的搭建，那么第二件事就是日志框架的搭建，線上 web 項(xiàng)目的日志可能是我們了解項(xiàng)目運(yùn)行的唯一方式。

常用日志框架

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

為什么使用 log4j2

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

整合步驟

pom.xml 引入 jar 包

Spring Boot 默認(rèn)是用 logback 的日志框架的，所以需要排除 logback，不然會(huì)出現(xiàn) jar 依賴沖突的報(bào)錯(cuò)。

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId><exclusions><!-- 去掉springboot默認(rèn)配置 --><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 默認(rèn)日志文件名稱為 log4j2-spring.xml，可以省略在 application.yml 中的配置，如果需要指定配置文件需要在 Spring boot 配置文件 application.yml 中指定 logging.config 屬性.

logging:path: classpath:log4j2-prod.xml

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

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

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

簡(jiǎn)單使用

@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!";} }

---

擴(kuò)展

Log4j2配置詳解

根節(jié)點(diǎn) Configuration

有兩個(gè)屬性:

• status
• monitorinterval

有兩個(gè)子節(jié)點(diǎn):

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

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

monitorinterval用于指定log4j自動(dòng)重新配置的監(jiān)測(cè)間隔時(shí)間，單位是s,最小是5s.

Appenders節(jié)點(diǎn)

常見的有三種子節(jié)點(diǎn):Console、RollingFile、File

Console節(jié)點(diǎn)用來定義輸出到控制臺(tái)的Appender.

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

File節(jié)點(diǎn)用來定義輸出到指定位置的文件的Appender.

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

RollingFile節(jié)點(diǎn)用來定義超過指定條件自動(dòng)刪除舊的創(chuàng)建新的Appender.

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

Loggers節(jié)點(diǎn)，常見的有兩種:Root和Logger.

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

總結(jié)

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

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。