Springboot 2.x 使用 Log4j2 異步打印日志

介紹

目前常用的 Java 日志框架有 Log4j舰蟆、Logback纱注、Log4j2 ,性能方面推薦使用異步的 Log4j2税稼,具體對(duì)比不多做分析烦秩,前人早已完成耕荒,我們就站在巨人的肩膀上來(lái)看看如何實(shí)操郎仆。

SLF4J只祠,簡(jiǎn)單日志門面(Simple Logging Facade for Java),是一個(gè)用于日志系統(tǒng)的簡(jiǎn)單 Facade丸升,不是具體的日志解決方案铆农,而是通過Facade Pattern提供一些Java logging API,我的理解是它和 Log4j狡耻、Logback、Log4j2 的關(guān)系類似于 Java 接口與實(shí)現(xiàn)類的關(guān)系猴凹。

1夷狰、pom 準(zhǔn)備

1.1、war 包 web 工程

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <!--排除 springboot 默認(rèn)的 logback 依賴 -->
        <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>
    <version>2.2.6.RELEASE</version>
</dependency>
<!--異步,使用 log4j2 的 AsyncLogger 時(shí)需要包含 disruptor-->
<dependency>
    <groupId>com.lmax</groupId>
    <artifactId>disruptor</artifactId>
    <version>3.4.2</version>
</dependency>

1.2郊霎、jar 包自啟動(dòng)工程

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <exclusions>
        <!--排除 springboot 默認(rèn)的 logback 依賴 -->
        <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>
    <version>2.2.6.RELEASE</version>
</dependency>
<!--異步,使用 log4j2 的 AsyncLogger 時(shí)需要包含 disruptor-->
<dependency>
    <groupId>com.lmax</groupId>
    <artifactId>disruptor</artifactId>
    <version>3.4.2</version>
</dependency>

2、application.yml 配置

# 引入日志配置文件
logging:
  config: classpath:log4j2.xml

3、log4j2.xml 配置

classpath:log4j2.xml 的話孝治,log4j2.xml 放在目錄 resources 下即可

<?xml version="1.0" encoding="UTF-8"?>
<!--Configuration 后面的 status葡盗,這個(gè)用于設(shè)置 log4j2 自身內(nèi)部的信息輸出級(jí)別,可以不設(shè)置购对,當(dāng)設(shè)置成 trace 時(shí)猾昆,你會(huì)看到 log4j2 內(nèi)部各種詳細(xì)輸出-->
<!--monitorInterval:Log4j2 能夠自動(dòng)檢測(cè)修改配置 文件和重新配置本身,設(shè)置間隔秒數(shù)-->
<configuration status="error"  monitorInterval="30">
    <!--日志級(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="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level [%logger{50}:%L] - %msg%n" />
        <!-- 定義日志存儲(chǔ)的路徑 -->
        <property name="FILE_PATH" value="/var/log/songo" />
        <property name="FILE_NAME" value="songo" />
    </Properties>

    <appenders>

        <console name="Console" target="SYSTEM_OUT">
            <!--輸出日志的格式-->
            <PatternLayout pattern="${LOG_PATTERN}" charset="UTF-8"/>
        </console>

        <!-- 這個(gè)會(huì)打印出所有的info及以上級(jí)別的信息解幽,每次大小超過size贴见,則這size大小的日志會(huì)自動(dòng)存入按年份-月份建立的文件夾下面并進(jìn)行壓縮,作為存檔-->
        <RollingFile name="RollingFileInfo" fileName="${FILE_PATH}/${FILE_NAME}/${FILE_NAME}.log" filePattern="${FILE_PATH}/${FILE_NAME}/${FILE_NAME}-INFO-%d{yyyy-MM-dd}_%i.log.gz" append="true">
            <PatternLayout pattern="${LOG_PATTERN}" charset="UTF-8"/>
            <Policies>
                <!-- 基于時(shí)間的觸發(fā)策略躲株。該策略主要是完成周期性的log文件封存工作片部。有兩個(gè)參數(shù):
               interval,integer型霜定,指定兩次封存動(dòng)作之間的時(shí)間間隔档悠。單位:以日志的命名精度來(lái)確定單位廊鸥,
                   比如yyyy-MM-dd-HH 單位為小時(shí),yyyy-MM-dd-HH-mm 單位為分鐘
               modulate站粟,boolean型黍图,說明是否對(duì)封存時(shí)間進(jìn)行調(diào)制。若modulate=true奴烙,
                   則封存時(shí)間將以0點(diǎn)為邊界進(jìn)行偏移計(jì)算助被。比如,modulate=true切诀,interval=4hours揩环,
                   那么假設(shè)上次封存日志的時(shí)間為00:00,則下次封存日志的時(shí)間為04:00幅虑,
                   之后的封存時(shí)間依次為08:00丰滑,12:00,16:00-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy 屬性如不設(shè)置倒庵,則默認(rèn)為最多同一文件夾下當(dāng)天 7 個(gè)文件后開始覆蓋-->
            <DefaultRolloverStrategy max="30">
                <!-- 刪除處理策略褒墨,在配置的路徑中搜索,maxDepth 表示往下搜索的最大深度 -->
                <Delete basePath="${FILE_PATH}/${FILE_NAME}/" maxDepth="2">
                    <!-- 文件名搜索匹配擎宝,支持正則 -->
                    <IfFileName glob="*.log.gz" />
                    <!--!Note: 這里的 age 必須和 filePattern 協(xié)調(diào), 后者是精確到 dd, 這里就要寫成 xd, xD 就不起作用
                    另外, 數(shù)字最好 >2, 否則可能造成刪除的時(shí)候, 最近的文件還處于被占用狀態(tài),導(dǎo)致刪除不成功!-->
                    <!--7天-->
                    <IfLastModified age="7d" />
                </Delete>
            </DefaultRolloverStrategy>
        </RollingFile>
    </appenders>

    <!--Logger 節(jié)點(diǎn)用來(lái)單獨(dú)指定日志的形式郁妈,比如要為指定包下的 class 指定不同的日志級(jí)別等。-->
    <!--然后定義 loggers绍申,只有定義了 logger 并引入的 appender噩咪,appender 才會(huì)生效-->
    <loggers>
        <!--若是 additivity 設(shè)為 false,則子 Logger 只會(huì)在自己的 appender 里輸出极阅,而不會(huì)在父 Logger 的 appender 里輸出胃碾。-->
        <!--Console、RollingFileInfo 沒有配置 ThresholdFilter筋搏,默認(rèn)走的是 AsyncRoot 的 level 級(jí)別仆百,
            com.songo.mapper 為我項(xiàng)目 mapper 的包路徑,級(jí)別設(shè)為 debug拆又,可以打印 sql 語(yǔ)句-->
        <AsyncLogger name="com.songo.mapper" level="debug" additivity="false">
            <appender-ref ref="Console"/>
            <appender-ref ref="RollingFileInfo"/>
        </AsyncLogger>
        <AsyncLogger name="org.springframework" level="warn" additivity="false">
            <appender-ref ref="Console"/>
            <appender-ref ref="RollingFileInfo"/>
        </AsyncLogger>
        <AsyncRoot level="info" includeLocation="true">
            <AppenderRef ref="Console"/>
            <AppenderRef ref="RollingFileInfo" />
        </AsyncRoot>
    </loggers>
</configuration>

4儒旬、使用

4.1、聲明 logger 變量

package com.songo.service;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class TestService {
    private static final Logger logger = LoggerFactory.getLogger(TestService.class);
    
    public void Test() {
        logger.info("test...");
    }
}

4.2帖族、簡(jiǎn)單點(diǎn) lombok

引入 pom

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <scope>provided</scope>
</dependency>
package com.songo.service;

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class TestService {

    public void Test() {
        log.info("test...");
    }
}

5栈源、驗(yàn)證

服務(wù)啟動(dòng)時(shí),找到 log4j2 的線程竖般,是如下內(nèi)容說明 log4j2 異步日志打印配置成功


記錄如有不對(duì)煩請(qǐng)指出甚垦,先行感謝

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子艰亮,更是在濱河造成了極大的恐慌闭翩,老刑警劉巖,帶你破解...
    沈念sama閱讀 212,454評(píng)論 6 493
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件迄埃,死亡現(xiàn)場(chǎng)離奇詭異疗韵,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)侄非,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,553評(píng)論 3 385
  • 文/潘曉璐 我一進(jìn)店門蕉汪,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人逞怨,你說我怎么就攤上這事者疤。” “怎么了叠赦?”我有些...
    開封第一講書人閱讀 157,921評(píng)論 0 348
  • 文/不壞的土叔 我叫張陵驹马,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我除秀,道長(zhǎng)糯累,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,648評(píng)論 1 284
  • 正文 為了忘掉前任册踩,我火速辦了婚禮寇蚊,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘棍好。我一直安慰自己,他們只是感情好允耿,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,770評(píng)論 6 386
  • 文/花漫 我一把揭開白布借笙。 她就那樣靜靜地躺著,像睡著了一般较锡。 火紅的嫁衣襯著肌膚如雪业稼。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,950評(píng)論 1 291
  • 那天蚂蕴,我揣著相機(jī)與錄音低散,去河邊找鬼。 笑死骡楼,一個(gè)胖子當(dāng)著我的面吹牛熔号,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播鸟整,決...
    沈念sama閱讀 39,090評(píng)論 3 410
  • 文/蒼蘭香墨 我猛地睜開眼引镊,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起弟头,我...
    開封第一講書人閱讀 37,817評(píng)論 0 268
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤吩抓,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后赴恨,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體疹娶,經(jīng)...
    沈念sama閱讀 44,275評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,592評(píng)論 2 327
  • 正文 我和宋清朗相戀三年伦连,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了雨饺。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,724評(píng)論 1 341
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡除师,死狀恐怖沛膳,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情汛聚,我是刑警寧澤锹安,帶...
    沈念sama閱讀 34,409評(píng)論 4 333
  • 正文 年R本政府宣布,位于F島的核電站倚舀,受9級(jí)特大地震影響叹哭,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜痕貌,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 40,052評(píng)論 3 316
  • 文/蒙蒙 一风罩、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧舵稠,春花似錦超升、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,815評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至落追,卻和暖如春盈滴,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背轿钠。 一陣腳步聲響...
    開封第一講書人閱讀 32,043評(píng)論 1 266
  • 我被黑心中介騙來(lái)泰國(guó)打工巢钓, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人疗垛。 一個(gè)月前我還...
    沈念sama閱讀 46,503評(píng)論 2 361
  • 正文 我出身青樓症汹,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親继谚。 傳聞我的和親對(duì)象是個(gè)殘疾皇子烈菌,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,627評(píng)論 2 350

推薦閱讀更多精彩內(nèi)容