0、springboot整合log4j2日志全解
1、常用框架
java.util.logging：是JDK在1.4版本中引入的Java原生日志框架
Log4j：Apache的一個(gè)開源項(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í)版本了，它從頭到尾都被重寫了
2、日志slf4j
上述介紹的是一些日志框架的實(shí)現(xiàn)，這里我們需要用日志門面來解決系統(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)用程序來說，無論底層的日志框架如何變，應(yīng)用程序不需要修改任意一行代碼，就可以直接上線了。
3、整合步驟
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>
4、配置文件
logging:
config: xxxx.xml
level:
cn.jay.repository: trace
默認(rèn)名log4j2-spring.xml，就省下了在application.yml中配置
5、配置文件模板
log4j是通過一個(gè).properties的文件作為主配置文件的，而現(xiàn)在的log4j2則已經(jīng)棄用了這種方式，采用的是.xml，.json或者.jsn這種方式來做，可能這也是技術(shù)發(fā)展的一個(gè)必然性，因?yàn)閜roperties文件的可閱讀性真的是有點(diǎn)差
<?xml version="1.0" encoding="UTF-8"?>
<!--日志級(jí)別以及優(yōu)先級(jí)排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--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 status="WARN" monitorInterval="1800">
<Properties>
<!-- ==============================================公共配置============================================== -->
<!-- 設(shè)置日志文件的目錄名稱 -->
<property name="logFileName">service</property>
<!-- 日志默認(rèn)存放的位置,可以設(shè)置為項(xiàng)目根路徑下,也可指定絕對(duì)路徑 -->
<!-- 存放路徑一:通用路徑,window平臺(tái) -->
<property name="basePath">c:/logs/${logFileName}</property>
<!-- 存放路徑二:web工程專用,java項(xiàng)目沒有這個(gè)變量,需要?jiǎng)h掉,否則會(huì)報(bào)異常,這里把日志放在web項(xiàng)目的根目錄下 -->
<!-- <property name="basePath">${web:rootDir}/${logFileName}</property> -->
<!-- 存放路徑三:web工程專用,java項(xiàng)目沒有這個(gè)變量,需要?jiǎng)h掉,否則會(huì)報(bào)異常,這里把日志放在tocmat的logs目錄下 -->
<!--<property name="basePath">${env:LOGDIR}/${logFileName}/${env:HOSTNAME}</property>-->
<!-- 日志文件默認(rèn)輸出格式,不帶行號(hào)輸出(行號(hào)顯示會(huì)影響日志輸出性能);%C:大寫,類名;%M:方法名;%m:錯(cuò)誤信息;%n:換行 -->
<!-- <property name="log_pattern">%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] %C.%M - %m%n</property> -->
<!-- 日志文件默認(rèn)輸出格式,另類帶行號(hào)輸出(對(duì)日志輸出性能未知);%C:大寫,類名;%M:方法名;%L:行號(hào);%m:錯(cuò)誤信息;%n:換行 -->
<!--<property name="log_pattern">%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] %C.%M[%L line] - %m%n</property>-->
<property name="log_pattern">%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} -[%traceId]- %m%n</property>
<!-- 日志默認(rèn)切割的最小單位 -->
<property name="every_file_size">50MB</property>
<!-- 日志默認(rèn)輸出級(jí)別 -->
<property name="output_log_level">DEBUG</property>
<!-- ===========================================所有級(jí)別日志配置=========================================== -->
<!-- 日志默認(rèn)存放路徑(所有級(jí)別日志) -->
<property name="rolling_fileName">${basePath}/all.log</property>
<!-- 日志默認(rèn)壓縮路徑,將超過指定文件大小的日志,自動(dòng)存入按"年月"建立的文件夾下面并進(jìn)行壓縮,作為存檔 -->
<property name="rolling_filePattern">${basePath}/%d{yyyy-MM}/all-%d{yyyy-MM-dd-HH}-%i.log.gz</property>
<!-- 日志默認(rèn)同類型日志,同一文件夾下可以存放的數(shù)量,不設(shè)置此屬性則默認(rèn)為7個(gè),filePattern最后要帶%i才會(huì)生效 -->
<property name="rolling_max">50</property>
<!-- 日志默認(rèn)同類型日志,多久生成一個(gè)新的日志文件,這個(gè)配置需要和filePattern結(jié)合使用;
如果設(shè)置為1,filePattern是%d{yyyy-MM-dd}到天的格式,則間隔一天生成一個(gè)文件
如果設(shè)置為12,filePattern是%d{yyyy-MM-dd-HH}到小時(shí)的格式,則間隔12小時(shí)生成一個(gè)文件 -->
<property name="rolling_timeInterval">12</property>
<!-- 日志默認(rèn)同類型日志,是否對(duì)封存時(shí)間進(jìn)行調(diào)制,若為true,則封存時(shí)間將以0點(diǎn)為邊界進(jìn)行調(diào)整,
如:現(xiàn)在是早上3am,interval是4,那么第一次滾動(dòng)是在4am,接著是8am,12am...而不是7am -->
<property name="rolling_timeModulate">true</property>
<!-- ============================================Info級(jí)別日志============================================ -->
<!-- Info日志默認(rèn)存放路徑(Info級(jí)別日志) -->
<property name="info_fileName">${basePath}/info.log</property>
<!-- Info日志默認(rèn)壓縮路徑,將超過指定文件大小的日志,自動(dòng)存入按"年月"建立的文件夾下面并進(jìn)行壓縮,作為存檔 -->
<property name="info_filePattern">${basePath}/%d{yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log.gz</property>
<!-- Info日志默認(rèn)同一文件夾下可以存放的數(shù)量,不設(shè)置此屬性則默認(rèn)為7個(gè) -->
<property name="info_max">50</property>
<!-- 日志默認(rèn)同類型日志,多久生成一個(gè)新的日志文件,這個(gè)配置需要和filePattern結(jié)合使用;
如果設(shè)置為1,filePattern是%d{yyyy-MM-dd}到天的格式,則間隔一天生成一個(gè)文件
如果設(shè)置為12,filePattern是%d{yyyy-MM-dd-HH}到小時(shí)的格式,則間隔12小時(shí)生成一個(gè)文件 -->
<property name="info_timeInterval">1</property>
<!-- 日志默認(rèn)同類型日志,是否對(duì)封存時(shí)間進(jìn)行調(diào)制,若為true,則封存時(shí)間將以0點(diǎn)為邊界進(jìn)行調(diào)整,
如:現(xiàn)在是早上3am,interval是4,那么第一次滾動(dòng)是在4am,接著是8am,12am...而不是7am -->
<property name="info_timeModulate">true</property>
<!-- ============================================Warn級(jí)別日志============================================ -->
<!-- Warn日志默認(rèn)存放路徑(Warn級(jí)別日志) -->
<property name="warn_fileName">${basePath}/warn.log</property>
<!-- Warn日志默認(rèn)壓縮路徑,將超過指定文件大小的日志,自動(dòng)存入按"年月"建立的文件夾下面并進(jìn)行壓縮,作為存檔 -->
<property name="warn_filePattern">${basePath}/%d{yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log.gz</property>
<!-- Warn日志默認(rèn)同一文件夾下可以存放的數(shù)量,不設(shè)置此屬性則默認(rèn)為7個(gè) -->
<property name="warn_max">50</property>
<!-- 日志默認(rèn)同類型日志,多久生成一個(gè)新的日志文件,這個(gè)配置需要和filePattern結(jié)合使用;
如果設(shè)置為1,filePattern是%d{yyyy-MM-dd}到天的格式,則間隔一天生成一個(gè)文件
如果設(shè)置為12,filePattern是%d{yyyy-MM-dd-HH}到小時(shí)的格式,則間隔12小時(shí)生成一個(gè)文件 -->
<property name="warn_timeInterval">1</property>
<!-- 日志默認(rèn)同類型日志,是否對(duì)封存時(shí)間進(jìn)行調(diào)制,若為true,則封存時(shí)間將以0點(diǎn)為邊界進(jìn)行調(diào)整,
如:現(xiàn)在是早上3am,interval是4,那么第一次滾動(dòng)是在4am,接著是8am,12am...而不是7am -->
<property name="warn_timeModulate">true</property>
<!-- ============================================Error級(jí)別日志============================================ -->
<!-- Error日志默認(rèn)存放路徑(Error級(jí)別日志) -->
<property name="error_fileName">${basePath}/error.log</property>
<!-- Error日志默認(rèn)壓縮路徑,將超過指定文件大小的日志,自動(dòng)存入按"年月"建立的文件夾下面并進(jìn)行壓縮,作為存檔 -->
<property name="error_filePattern">${basePath}/%d{yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log.gz</property>
<!-- Error日志默認(rèn)同一文件夾下可以存放的數(shù)量,不設(shè)置此屬性則默認(rèn)為7個(gè) -->
<property name="error_max">50</property>
<!-- 日志默認(rèn)同類型日志,多久生成一個(gè)新的日志文件,這個(gè)配置需要和filePattern結(jié)合使用;
如果設(shè)置為1,filePattern是%d{yyyy-MM-dd}到天的格式,則間隔一天生成一個(gè)文件
如果設(shè)置為12,filePattern是%d{yyyy-MM-dd-HH}到小時(shí)的格式,則間隔12小時(shí)生成一個(gè)文件 -->
<property name="error_timeInterval">1</property>
<!-- 日志默認(rèn)同類型日志,是否對(duì)封存時(shí)間進(jìn)行調(diào)制,若為true,則封存時(shí)間將以0點(diǎn)為邊界進(jìn)行調(diào)整,
如:現(xiàn)在是早上3am,interval是4,那么第一次滾動(dòng)是在4am,接著是8am,12am...而不是7am -->
<property name="error_timeModulate">true</property>
<!-- ============================================控制臺(tái)顯示控制============================================ -->
<!-- 控制臺(tái)顯示的日志最低級(jí)別 -->
<property name="console_print_level">DEBUG</property>
</Properties>
<!--定義appender -->
<appenders>
<!-- =======================================用來定義輸出到控制臺(tái)的配置======================================= -->
<Console name="Console" target="SYSTEM_OUT">
<!-- 設(shè)置控制臺(tái)只輸出level及以上級(jí)別的信息(onMatch),其他的直接拒絕(onMismatch)-->
<ThresholdFilter level="${console_print_level}" onMatch="ACCEPT" onMismatch="DENY"/>
<!-- 設(shè)置輸出格式,不設(shè)置默認(rèn)為:%m%n -->
<PatternLayout pattern="${log_pattern}"/>
</Console>
<!-- ================================打印root中指定的level級(jí)別以上的日志到文件================================ -->
<RollingFile name="RollingFile" fileName="${rolling_fileName}" filePattern="${rolling_filePattern}">
<PatternLayout pattern="${log_pattern}"/>
<Policies>
<TimeBasedTriggeringPolicy interval="${rolling_timeInterval}" modulate="${warn_timeModulate}"/>
<SizeBasedTriggeringPolicy size="${every_file_size}"/>
</Policies>
<!-- 設(shè)置同類型日志,同一文件夾下可以存放的數(shù)量,如果不設(shè)置此屬性則默認(rèn)存放7個(gè)文件 -->
<DefaultRolloverStrategy max="${rolling_max}" />
</RollingFile>
<!-- =======================================打印INFO級(jí)別的日志到文件======================================= -->
<RollingFile name="InfoFile" fileName="${info_fileName}" filePattern="${info_filePattern}">
<PatternLayout pattern="${log_pattern}"/>
<Policies>
<TimeBasedTriggeringPolicy interval="${info_timeInterval}" modulate="${info_timeModulate}"/>
<SizeBasedTriggeringPolicy size="${every_file_size}"/>
</Policies>
<DefaultRolloverStrategy max="${info_max}" />
<Filters>
<ThresholdFilter level="WARN" onMatch="DENY" onMismatch="NEUTRAL"/>
<ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
</Filters>
</RollingFile>
<!-- =======================================打印WARN級(jí)別的日志到文件======================================= -->
<RollingFile name="WarnFile" fileName="${warn_fileName}" filePattern="${warn_filePattern}">
<PatternLayout pattern="${log_pattern}"/>
<Policies>
<TimeBasedTriggeringPolicy interval="${warn_timeInterval}" modulate="${warn_timeModulate}"/>
<SizeBasedTriggeringPolicy size="${every_file_size}"/>
</Policies>
<DefaultRolloverStrategy max="${warn_max}" />
<Filters>
<ThresholdFilter level="ERROR" onMatch="DENY" onMismatch="NEUTRAL"/>
<ThresholdFilter level="WARN" onMatch="ACCEPT" onMismatch="DENY"/>
</Filters>
</RollingFile>
<!-- =======================================打印ERROR級(jí)別的日志到文件======================================= -->
<RollingFile name="ErrorFile" fileName="${error_fileName}" filePattern="${error_filePattern}">
<PatternLayout pattern="${log_pattern}"/>
<Policies>
<TimeBasedTriggeringPolicy interval="${error_timeInterval}" modulate="${error_timeModulate}"/>
<SizeBasedTriggeringPolicy size="${every_file_size}"/>
</Policies>
<DefaultRolloverStrategy max="${error_max}" />
<Filters>
<ThresholdFilter level="FATAL" onMatch="DENY" onMismatch="NEUTRAL"/>
<ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY"/>
</Filters>
</RollingFile>
</appenders>
<!--定義logger,只有定義了logger并引入的appender,appender才會(huì)生效-->
<loggers>
<!-- 設(shè)置打印sql語句配置開始,以下兩者配合使用,可以優(yōu)化日志的輸出信息,減少一些不必要信息的輸出 -->
<!-- 設(shè)置java.sql包下的日志只打印DEBUG及以上級(jí)別的日志,此設(shè)置可以支持sql語句的日志打印 -->
<logger name="java.sql" level="DEBUG" additivity="false">
<appender-ref ref="InfoFile"/>
</logger>
<!-- 設(shè)置org.mybatis.spring包下的日志只打印WARN及以上級(jí)別的日志 -->
<logger name="org.mybatis.spring" level="ERROR" additivity="false">
<appender-ref ref="ErrorFile"/>
</logger>
<!-- 設(shè)置org.mybatis.spring包下的日志只打印WARN及以上級(jí)別的日志 -->
<logger name="org.springframework" level="ERROR" additivity="false">
<appender-ref ref="ErrorFile"/>
</logger>
<logger name="com.alibaba.cloud.dubbo.metadata" level="ERROR" additivity="false">
<appender-ref ref="ErrorFile"/>
</logger>
<logger name="com.alibaba.nacos.client" level="WARN" additivity="false"></logger>
<logger name="com.netflix" level="ERROR" additivity="false"><appender-ref ref="ErrorFile"/></logger>
<!-- 設(shè)置打印sql語句配置結(jié)束 -->
<!--建立一個(gè)默認(rèn)的root的logger-->
<root level="${output_log_level}">
<appender-ref ref="RollingFile"/>
<appender-ref ref="Console"/>
<appender-ref ref="InfoFile"/>
<appender-ref ref="WarnFile"/>
<appender-ref ref="ErrorFile"/>
</root>
</loggers>
</configuration>
6、配置參數(shù)簡(jiǎn)介
1、日志級(jí)別
- trace：追蹤，就是程序推進(jìn)一下，可以寫個(gè)trace輸出
- debug：調(diào)試，一般作為最低級(jí)別，trace基本不用。
- info：輸出重要的信息，使用較多
- warn：警告，有些信息不是錯(cuò)誤信息，但也要給程序員一些提示。
- error：錯(cuò)誤信息。用的也很多。
- fatal：致命錯(cuò)誤。
2、輸出源
- CONSOLE（輸出到控制臺(tái)）
- FILE（輸出到文件）
3、格式
- 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 : 輸出語句所在的行數(shù), 包括類名、方法名、文件名、行數(shù)
hostName : 本地機(jī)器名
hostAddress : 本地ip地址
7、配置參數(shù)簡(jiǎn)介
1.根節(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.
2.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)行輸出。
