如何在Springboot中l(wèi)og4j2日志

這期內(nèi)容當(dāng)中小編將會(huì)給大家?guī)?lái)有關(guān)如何在Springboot中l(wèi)og4j2日志，文章內(nèi)容豐富且以專業(yè)的角度為大家分析和敘述，閱讀完這篇文章希望大家可以有所收獲。

常用日志框架

• java.util.logging：是JDK在1.4版本中引入的Java原生日志框架

• Log4j：Apache的一個(gè)開(kāi)源項(xiàng)目，可以控制日志信息輸送的目的地是控制臺(tái)、文件、GUI組件等，可以控制每一條日志的輸出格式，這些可以通過(guò)一個(gè)配置文件來(lái)靈活地進(jìn)行配置，而不需要修改應(yīng)用的代碼。雖然已經(jīng)停止維護(hù)了，但目前絕大部分企業(yè)都是用的log4j。

• LogBack：是Log4j的一個(gè)改良版本

• Log4j2：Log4j2已經(jīng)不僅僅是Log4j的一個(gè)升級(jí)版本了，它從頭到尾都被重寫了
  

日志門面slf4j

上述介紹的是一些日志框架的實(shí)現(xiàn)，這里我們需要用日志門面來(lái)解決系統(tǒng)與日志實(shí)現(xiàn)框架的耦合性。SLF4J，即簡(jiǎn)單日志門面（Simple Logging Facade for Java），它不是一個(gè)真正的日志實(shí)現(xiàn)，而是一個(gè)抽象層（ abstraction layer），它允許你在后臺(tái)使用任意一個(gè)日志實(shí)現(xiàn)。

前面介紹的幾種日志框架一樣，每一種日志框架都有自己?jiǎn)为?dú)的API，要使用對(duì)應(yīng)的框架就要使用其對(duì)應(yīng)的API，這就大大的增加應(yīng)用程序代碼對(duì)于日志框架的耦合性。

使用了slf4j后，對(duì)于應(yīng)用程序來(lái)說(shuō)，無(wú)論底層的日志框架如何變，應(yīng)用程序不需要修改任意一行代碼，就可以直接上線了。

為什么選用log4j2

相比與其他的日志系統(tǒng)，log4j2丟數(shù)據(jù)這種情況少；disruptor技術(shù)，在多線程環(huán)境下，性能高于logback等10倍以上；利用jdk1.5并發(fā)的特性，減少了死鎖的發(fā)生；

在這列舉一下一些網(wǎng)上其他博文中對(duì)它們的性能評(píng)測(cè)：

可以看到在同步日志模式下, Logback的性能是最糟糕的. log4j2的性能無(wú)論在同步日志模式還是異步日志模式下都是最佳的.

log4j2優(yōu)越的性能其原因在于log4j2使用了LMAX,一個(gè)無(wú)鎖的線程間通信庫(kù)代替了,logback和log4j之前的隊(duì)列. 并發(fā)性能大大提升。

整合步驟

引入Jar包

springboot默認(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> 

<dependency> <!-- 引入log4j2依賴 --> 
 <groupId>org.springframework.boot</groupId> 
 <artifactId>spring-boot-starter-log4j2</artifactId> 
</dependency>

配置文件

如果自定義了文件名，需要在application.yml中配置

logging:
 config: xxxx.xml
 level:
 cn.jay.repository: trace

默認(rèn)名log4j2-spring.xml，就省下了在application.yml中配置

配置文件模版

log4j是通過(guò)一個(gè).properties的文件作為主配置文件的，而現(xiàn)在的log4j2則已經(jīng)棄用了這種方式，采用的是.xml，.json或者.jsn這種方式來(lái)做，可能這也是技術(shù)發(fā)展的一個(gè)必然性，因?yàn)閜roperties文件的可閱讀性真的是有點(diǎn)差。

<?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="更換為你的日志路徑" />
 <property name="FILE_NAME" value="更換為你的項(xiàng)目名" />
 </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}/test.log" append="false">
  <PatternLayout pattern="${LOG_PATTERN}"/>
 </File>

 <!-- 這個(gè)會(huì)打印出所有的info及以下級(jí)別的信息，每次大小超過(guò)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屬性用來(lái)指定多久滾動(dòng)一次，默認(rèn)是1 hour-->
  <TimeBasedTriggeringPolicy interval="1"/>
  <SizeBasedTriggeringPolicy size="10MB"/>
  </Policies>
  <!-- DefaultRolloverStrategy屬性如不設(shè)置，則默認(rèn)為最多同一文件夾下7個(gè)文件開(kāi)始覆蓋-->
  <DefaultRolloverStrategy max="15"/>
 </RollingFile>

 <!-- 這個(gè)會(huì)打印出所有的warn及以下級(jí)別的信息，每次大小超過(guò)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屬性用來(lái)指定多久滾動(dòng)一次，默認(rèn)是1 hour-->
  <TimeBasedTriggeringPolicy interval="1"/>
  <SizeBasedTriggeringPolicy size="10MB"/>
  </Policies>
  <!-- DefaultRolloverStrategy屬性如不設(shè)置，則默認(rèn)為最多同一文件夾下7個(gè)文件開(kāi)始覆蓋-->
  <DefaultRolloverStrategy max="15"/>
 </RollingFile>

 <!-- 這個(gè)會(huì)打印出所有的error及以下級(jí)別的信息，每次大小超過(guò)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屬性用來(lái)指定多久滾動(dòng)一次，默認(rèn)是1 hour-->
  <TimeBasedTriggeringPolicy interval="1"/>
  <SizeBasedTriggeringPolicy size="10MB"/>
  </Policies>
  <!-- DefaultRolloverStrategy屬性如不設(shè)置，則默認(rèn)為最多同一文件夾下7個(gè)文件開(kāi)始覆蓋-->
  <DefaultRolloverStrategy max="15"/>
 </RollingFile>

 </appenders>

 <!--Logger節(jié)點(diǎn)用來(lái)單獨(dú)指定日志的形式，比如要為指定包下的class指定不同的日志級(jí)別等。-->
 <!--然后定義loggers，只有定義了logger并引入的appender，appender才會(huì)生效-->
 <loggers>

 <!--過(guò)濾掉spring和mybatis的一些無(wú)用的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>

配置參數(shù)簡(jiǎn)介

在這里簡(jiǎn)單介紹下常用的配置參數(shù)

日志級(jí)別

• 機(jī)制：如果一條日志信息的級(jí)別大于等于配置文件的級(jí)別，就記錄。

• trace：追蹤，就是程序推進(jìn)一下，可以寫個(gè)trace輸出

• debug：調(diào)試，一般作為最低級(jí)別，trace基本不用。

•  info：輸出重要的信息，使用較多

• warn：警告，有些信息不是錯(cuò)誤信息，但也要給程序員一些提示。

• error：錯(cuò)誤信息。用的也很多。

• fatal：致命錯(cuò)誤。

輸出源

•  CONSOLE（輸出到控制臺(tái)）

• FILE（輸出到文件）

格式

• SimpleLayout：以簡(jiǎn)單的形式顯示

• HTMLLayout：以HTML表格顯示

• PatternLayout：自定義形式顯示

PatternLayout自定義日志布局：

%d{yyyy-MM-dd HH:mm:ss, SSS} : 日志生產(chǎn)時(shí)間,輸出到毫秒的時(shí)間
%-5level : 輸出日志級(jí)別，-5表示左對(duì)齊并且固定輸出5個(gè)字符，如果不足在右邊補(bǔ)0
%c : logger的名稱(%logger)
%t : 輸出當(dāng)前線程名稱
%p : 日志輸出格式
%m : 日志內(nèi)容，即 logger.info("message")
%n : 換行符
%C : Java類名(%F)
%L : 行號(hào)
%M : 方法名
%l : 輸出語(yǔ)句所在的行數(shù), 包括類名、方法名、文件名、行數(shù)
hostName : 本地機(jī)器名
hostAddress : 本地ip地址

Log4j2配置詳解

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

有兩個(gè)屬性:

• status

• monitorinterval

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

• Appenders

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

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

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

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

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

Console節(jié)點(diǎn)用來(lái)定義輸出到控制臺(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)用來(lái)定義輸出到指定位置的文件的Appender.

•  name:指定Appender的名字.

• fileName:指定輸出日志的目的文件帶全路徑的文件名.

• PatternLayout:輸出格式，不設(shè)置默認(rèn)為:%m%n.

 RollingFile節(jié)點(diǎn)用來(lái)定義超過(guò)指定條件自動(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屬性用來(lái)指定多久滾動(dòng)一次，默認(rèn)是1 hour。modulate=true用來(lái)調(diào)整時(shí)間：比如現(xiàn)在是早上3am，interval是4，那么第一次滾動(dòng)是在4am，接著是8am，12am...而不是7am.

• SizeBasedTriggeringPolicy:Policies子節(jié)點(diǎn)，基于指定文件大小的滾動(dòng)策略，size屬性用來(lái)定義每個(gè)日志文件的大小.

• DefaultRolloverStrategy:用來(lái)指定同一個(gè)文件夾下最多有幾個(gè)日志文件時(shí)開(kāi)始刪除最舊的，創(chuàng)建新的(通過(guò)max屬性)。

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

• Root節(jié)點(diǎn)用來(lái)指定項(xiàng)目的根日志，如果沒(méi)有單獨(dú)指定Logger，那么就會(huì)默認(rèn)使用該Root日志輸出

• level:日志輸出級(jí)別，共有8個(gè)級(jí)別，按照從低到高為：All < Trace < Debug < Info < Warn < Error < AppenderRef：Root的子節(jié)點(diǎn)，用來(lái)指定該日志輸出到哪個(gè)Appender.

• Logger節(jié)點(diǎn)用來(lái)單獨(dú)指定日志的形式，比如要為指定包下的class指定不同的日志級(jí)別等。

• level:日志輸出級(jí)別，共有8個(gè)級(jí)別，按照從低到高為：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.

• name:用來(lái)指定該Logger所適用的類或者類所在的包全路徑,繼承自Root節(jié)點(diǎn).

• AppenderRef：Logger的子節(jié)點(diǎn)，用來(lái)指定該日志輸出到哪個(gè)Appender,如果沒(méi)有指定，就會(huì)默認(rèn)繼承自Root.如果指定了，那么會(huì)在指定的這個(gè)Appender和Root的Appender中都會(huì)輸出，此時(shí)我們可以設(shè)置Logger的additivity="false"只在自定義的Appender中進(jìn)行輸出。

簡(jiǎn)單使用

public class LogExampleOther {
 private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExampleOther.class);
 
 public static void main(String... args) {
 log.error("Something else is wrong here");
 }
}

使用lombok工具簡(jiǎn)化創(chuàng)建Logger類

lombok就是一個(gè)注解工具jar包，能幫助我們省略一繁雜的代碼。具體介紹可以看我的這篇教程。

使用lombok后下面的代碼等效于上述的代碼，這樣會(huì)更方便的使用日志。

@Slf4j
public class LogExampleOther {
 
 public static void main(String... args) {
 log.error("Something else is wrong here");
 }
}

上述就是小編為大家分享的如何在Springboot中l(wèi)og4j2日志了，如果剛好有類似的疑惑，不妨參照上述分析進(jìn)行理解。如果想知道更多相關(guān)知識(shí)，歡迎關(guān)注億速云行業(yè)資訊頻道。