SpringBoot整合日志log4j2

SpringBoot整合日志log4j2

一個項目框架中日志都是必不可少的，隨着技術的更新迭代，SpringBoot被越來越多的企業所采用。這里簡單說說SpringBoot整合log2j2日志。

一、說明：

1. Log4J（Apache的一個開源項目，可以控制日志信息輸送的目的地是控制台、文件、GUI組件等，可以控制每一條日志的輸出格式，這些可以通過一個配置文件來靈活地進行配置，而不需要修改應用的代碼，雖然已經停止維護了，但目前絕大部分企業都是用的log4j）/LogBack（是Log4j的一個改良版本）/Log4J2（Log4j2已經不僅僅是Log4j的一個升級版本了，它從頭到尾都被重寫了）

2. 日志門面slf4j：SLF4J，即簡單日志門面（Simple Logging Facade for Java），它不是一個真正的日志實現，而是一個抽象層（ abstraction layer），它允許你在后台使用任意一個日志實現。

3. Log4j2：相比與其他的日志系統，log4j2丟數據這種情況少；disruptor技術，在多線程環境下，性能高於logback等10倍以上；利用jdk1.5並發的特性，減少了死鎖的發生；log4j2優越的性能其原因在於log4j2使用了LMAX,一個無鎖的線程間通信庫代替了,logback和log4j之前的隊列. 並發性能大大提升。

二、整合步驟

1. 導入依賴包

SpringBoot默認使用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>
<dependency> <!-- 引入log4j2依賴 -->
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

2. 指定配置文件

默認名log4j2-spring.xml，就可以不用指定

logging:
  config: classpath:log/log4j2-file-dev.xml

3. 詳細配置說明

<?xml version="1.0" encoding="UTF-8"?>
<!--Configuration后面的status，這個用於設置log4j2自身內部的信息輸出，可以不設置，當設置成trace時，你會看到log4j2內部各種詳細輸出-->
<!--monitorInterval：Log4j能夠自動檢測修改配置 文件和重新配置本身，設置間隔秒數-->
<configuration status="WARN" 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="更換為你的日志路徑"/>
        <property name="FILE_NAME" value="更換為你的項目名"/>

        <Property name="PID">????</Property>
        <Property name="LOG_EXCEPTION_CONVERSION_WORD">%xwEx</Property>
        <Property name="LOG_LEVEL_PATTERN">%5p</Property>
        <Property name="LOG_DATEFORMAT_PATTERN">yyyy-MM-dd HH:mm:ss.SSS</Property>
        <Property name="CONSOLE_LOG_PATTERN">%clr{%d{${LOG_DATEFORMAT_PATTERN}}}{faint} %clr{${LOG_LEVEL_PATTERN}} %clr{${sys:PID}}{magenta} %clr{---}{faint} %clr{[%15.15t]}{faint} %clr{%-40.40c{1.}}{cyan} %clr{:}{faint} %m%n${sys:LOG_EXCEPTION_CONVERSION_WORD}
        </Property>
        <Property name="FILE_LOG_PATTERN">%d{${LOG_DATEFORMAT_PATTERN}} ${LOG_LEVEL_PATTERN} ${sys:PID} --- [%t]
            %-40.40c{1.} : %m%n${sys:LOG_EXCEPTION_CONVERSION_WORD}
        </Property>
    </Properties>

    <appenders>

        <console name="Console" target="SYSTEM_OUT">
            <!--輸出日志的格式-->
            <PatternLayout pattern="${sys:CONSOLE_LOG_PATTERN}"/>
            <!--控制台只輸出level及其以上級別的信息（onMatch），其他的直接拒絕（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
        </console>

        <!--文件會打印出所有信息，這個log每次運行程序會自動清空，由append屬性決定，適合臨時測試用-->
        <File name="Filelog" fileName="${FILE_PATH}/test.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="${sys:FILE_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>

<!--        <RabbitMQ name="rabbitmq" addresses="ip:port"-->
<!--                  user="username" password="password" applicationId="applicationName" charset="UTF-8"-->
<!--                  routingKeyPattern="applicationName"-->
<!--                  exchange="Application.Log" deliveryMode="NON_PERSISTENT">-->
<!--            <JsonLayout>-->
<!--                <KeyValuePair key="appName" value="applicationName"/>-->
<!--                <KeyValuePair key="sysName" value="applicationName"/>-->
<!--                <KeyValuePair key="machine" value="$${ctx:machine}"/>-->
<!--                <KeyValuePair key="clientIp" value="$${ctx:clientIp}"/>-->
<!--                <KeyValuePair key="city" value="$${ctx:city}"/>-->
<!--            </JsonLayout>-->
<!--        </RabbitMQ>-->

    </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>

配置簡介：

• 日志級別

  • trace：追蹤，就是程序推進一下，可以寫個trace輸出
  • debug：調試，一般作為最低級別，trace基本不用
  • info：輸出重要的信息，使用較多
  • warn：警告，有些信息不是錯誤信息，但也要給程序員一些提示
  • error：錯誤信息。用的也很多
  • fatal：致命錯誤

• 輸出源

  • CONSOLE（輸出到控制台）
  • FILE（輸出到文件）
  • RabbitMQ/Kafka/ES/MongoDB等等

• 格式

  • SimpleLayout：以簡單的形式顯示

  • HTMLLayout：以HTML表格顯示

  • PatternLayout：自定義形式顯示

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

• 使用

  • private static final Logger log = LoggerFactory.getLogger(LogExampleOther.class);
  • lombok得注解 @Slf4j

三、參考這個博客 https://www.cnblogs.com/keeya/p/10101547.html