Spring Boot(十)Logback和Log4j2集成與日志發(fā)展史

一赵讯、簡介

Java知名的日志有很多盈咳,比如:JUL、Log4j边翼、JCL鱼响、SLF4J、Logback组底、Log4j2热押,那么這些日志框架之間有著怎樣的關(guān)系?誕生的原因又是解決什么問題斤寇?下面一起來看桶癣。

1.1 JUL

Java有自己的日志框架JUL(Java Util Logging)在java.util.logging下,因為對開發(fā)者不友好娘锁,使用成本太高和日志級別分類不清晰的問題牙寞,所有很少有開發(fā)者用。

1.2 Log4j

因為JUL的缺陷問題莫秆,這就給了Log4j機會间雀,所有Log4j一經(jīng)推出就迅速風(fēng)靡全球。

1.3 JCL

JCL是Jakarta Commons-Logging的縮寫镊屎,Jakarta在這里指的是一個組織惹挟,而不是印度的首都雅加達,Jakarta缝驳,一個早期的Apache開源項目连锯,用于管理各個Java子項目,諸如Tomcat, Ant, Maven, Struts, JMeter, Velocity, JMeter, Commons等用狱。2011年12月运怖,在所有子項目都被遷移為獨立項目后,Jakarta名稱就不再使用了夏伊。

JCL誕生的初衷是因為Java自身的一些包用了JUL摇展,而Log4j用戶使用的有很多,那么JCL就是提供一套API來實現(xiàn)不同Logger之間的切換溺忧。

1.4 SLF4J

SLF4J(Simple Logging Facade For Java)簡單日志門面咏连,和JCL功能類似盯孙,但JCL有一個致命的缺點就是算法復(fù)雜,出現(xiàn)問題難以排除祟滴,而SLF4J的誕生就是為了解決JCL的缺點镀梭。

值得一提的是SLF4J的作者就是Log4j的作者。

1.5 Logback

Logback是Log4j的作者的另一個開源日志組件踱启,與Log4j相比报账,Logback重新了內(nèi)核,使它的性能提升了很多埠偿,大約是Log4j的10倍透罢,同時占用更小的內(nèi)存,并且完整的實現(xiàn)了SLF4J API是你可以很方便的切換日志框架冠蒋。

1.6 Log4j2

Log4j2有著和Logback相同的功能羽圃,但又有自己單用的功能,比如:插件式結(jié)構(gòu)抖剿、配置文件優(yōu)化朽寞、異步日志等。

Log4j2是Log4j的升級斩郎,它比其前身Log4j 1.x提供了重大改進脑融,并提供了Logback中可用的許多改進,同時修復(fù)了Logback架構(gòu)中的一些固有問題缩宜。

從GitHub的更新日志來看肘迎,Logback已經(jīng)有半年沒有更新了,而作為知名組織的Apache下的Log4j2的更新卻是非扯突停活躍的妓布,Log4j 1.x 于2015年8月停止維護更新了。

GitHub地址

Logback:https://github.com/qos-ch/logback

log4j2:https://github.com/apache/logging-log4j2

本文分別來看Logback和Log4j2在Spring Boot中的實現(xiàn)宋梧。

二匣沼、Logback使用

開發(fā)環(huán)境

  • JDK 8
  • Spring Boot 2.0.4 RELEASE
  • Maven
  • Windows 10
  • IDEA 2018.2

2.1 Logback的使用

Spring Boot默認集成了Logback,可以開箱即用捂龄,非常方便释涛。因為spring-boot-starter-logging是Logback的日志實現(xiàn),而Spring Boot啟動項spring-boot-starter又依賴了spring-boot-starter-logging跺讯,所以Spring Boot就默認集成了Logback枢贿,包依賴如下圖:

日志是默認控制臺輸出的殉农,我們程序啟動的時候就使用Logback刀脏,如下圖所示:

日志組成解讀:

  • 日期和時間:毫秒精度,易于排序

  • 日志級別:trace超凳、debug愈污、info耀态、warn、error(日志級別依次從低到高)

  • 進程ID

  • ---分隔符

  • 線程名稱:括在方括號中(可以截斷控制臺輸出)

  • 記錄器名稱:這通常是源類名(通吃荼ⅲ縮寫)

  • 日志具體信息

2.2 輸入文件

如果需要輸出日志到文件首装,只需要在application.properties配置文件設(shè)置:logging.file或logging.path,示例如下:

logging.level.root=info
logging.file=D:\\log\\my.log

可以通過設(shè)置日志的級別杭跪,忽略更低級別的日志輸出仙逻。

注意: logging.file和logging.path設(shè)置一個屬性即可,如果兩個都設(shè)置涧尿,則以logging.file為主系奉,logging.path無效。

日志文件容量設(shè)置:使用“l(fā)ogging.file.max-history”屬性為日志最大容量設(shè)置姑廉,默認10M超過則分割為多個文件缺亮。

2.3 自定義日志配置

日志服務(wù)在ApplicationContext創(chuàng)建前就初始化了,所以通過設(shè)置屬性和傳統(tǒng)的配置XML文件桥言,可以對日志進行管理和控制萌踱。

只需要在src/main/resources下,創(chuàng)建好約定名稱的XML文件号阿,即可完成對日志系統(tǒng)的設(shè)置并鸵,不同的日志系統(tǒng)有不同的約定名稱,如下列表:

日志 名稱
logback logback-spring.xml, logback-spring.groovy, logback.xml, 或者 logback.groovy
log4j2 log4j2-spring.xml 或者 log4j2.xml

Spring Boot官方建議使用“-spring”的命名規(guī)則扔涧,進行日志配置能真,如:logback-spring.xml而不是logback.xml。

當然你也可以自定義日志名稱扰柠,只需要在application.properties配置即可粉铐,代碼如下:

logging.config=classpath:logging-config.xml

來看一個logback-spring.xml示例文件:

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <!-- 日志根目錄-->
    <springProperty scope="context" name="LOG_HOME" source="logging.path" defaultValue="/data/logs/spring-boot-logback"/>

    <!-- 日志級別 -->
    <springProperty scope="context" name="LOG_ROOT_LEVEL" source="logging.level.root" defaultValue="DEBUG"/>

    <!--  標識這個"STDOUT" 將會添加到這個logger -->
    <springProperty scope="context" name="STDOUT" source="log.stdout" defaultValue="STDOUT"/>

    <!-- 日志文件名稱-->
    <property name="LOG_PREFIX" value="spring-boot-logback" />

    <!-- 日志文件編碼-->
    <property name="LOG_CHARSET" value="UTF-8" />

    <!-- 日志文件路徑+日期-->
    <property name="LOG_DIR" value="${LOG_HOME}/%d{yyyyMMdd}" />

    <!--對日志進行格式化-->
    <property name="LOG_MSG" value="- | [%X{requestUUID}] | [%d{yyyyMMdd HH:mm:ss.SSS}] | [%level] | [${HOSTNAME}] | [%thread] | [%logger{36}] | --> %msg|%n "/>

    <!--文件大小,默認10MB-->
    <property name="MAX_FILE_SIZE" value="50MB" />

    <!-- 配置日志的滾動時間 卤档,表示只保留最近 10 天的日志-->
    <property name="MAX_HISTORY" value="10"/>

    <!--輸出到控制臺-->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!-- 輸出的日志內(nèi)容格式化-->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>${LOG_MSG}</pattern>
        </layout>
    </appender>

    <!--輸出到文件-->
    <appender name="0" class="ch.qos.logback.core.rolling.RollingFileAppender">
    </appender>

    <!-- 定義 ALL 日志的輸出方式:-->
    <appender name="FILE_ALL" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--日志文件路徑蝙泼,日志文件名稱-->
        <File>${LOG_HOME}/all_${LOG_PREFIX}.log</File>

        <!-- 設(shè)置滾動策略,當天的日志大小超過 ${MAX_FILE_SIZE} 文件大小時候劝枣,新的內(nèi)容寫入新的文件汤踏, 默認10MB -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

            <!--日志文件路徑,新的 ALL 日志文件名稱舔腾,“ i ” 是個變量 -->
            <FileNamePattern>${LOG_DIR}/all_${LOG_PREFIX}%i.log</FileNamePattern>

            <!-- 配置日志的滾動時間 溪胶,表示只保留最近 10 天的日志-->
            <MaxHistory>${MAX_HISTORY}</MaxHistory>

            <!--當天的日志大小超過 ${MAX_FILE_SIZE} 文件大小時候,新的內(nèi)容寫入新的文件稳诚, 默認10MB-->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>${MAX_FILE_SIZE}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>

        </rollingPolicy>

        <!-- 輸出的日志內(nèi)容格式化-->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>${LOG_MSG}</pattern>
        </layout>
    </appender>

    <!-- 定義 ERROR 日志的輸出方式:-->
    <appender name="FILE_ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 下面為配置只輸出error級別的日志 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <OnMismatch>DENY</OnMismatch>
            <OnMatch>ACCEPT</OnMatch>
        </filter>
        <!--日志文件路徑哗脖,日志文件名稱-->
        <File>${LOG_HOME}/err_${LOG_PREFIX}.log</File>

        <!-- 設(shè)置滾動策略,當天的日志大小超過 ${MAX_FILE_SIZE} 文件大小時候,新的內(nèi)容寫入新的文件才避, 默認10MB -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

            <!--日志文件路徑橱夭,新的 ERR 日志文件名稱,“ i ” 是個變量 -->
            <FileNamePattern>${LOG_DIR}/err_${LOG_PREFIX}%i.log</FileNamePattern>

            <!-- 配置日志的滾動時間 桑逝,表示只保留最近 10 天的日志-->
            <MaxHistory>${MAX_HISTORY}</MaxHistory>

            <!--當天的日志大小超過 ${MAX_FILE_SIZE} 文件大小時候棘劣,新的內(nèi)容寫入新的文件, 默認10MB-->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>${MAX_FILE_SIZE}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>

        <!-- 輸出的日志內(nèi)容格式化-->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>${LOG_MSG}</Pattern>
        </layout>
    </appender>

    <!-- additivity 設(shè)為false,則logger內(nèi)容不附加至root 楞遏,配置以配置包下的所有類的日志的打印茬暇,級別是 ERROR-->

    <logger name="org.springframework"     level="ERROR" />
    <logger name="org.apache.commons"      level="ERROR" />
    <logger name="org.apache.zookeeper"    level="ERROR"  />
    <logger name="com.alibaba.dubbo.monitor" level="ERROR"/>
    <logger name="com.alibaba.dubbo.remoting" level="ERROR" />

    <!-- ${LOG_ROOT_LEVEL} 日志級別 -->
    <root level="${LOG_ROOT_LEVEL}">

        <!-- 標識這個"${STDOUT}"將會添加到這個logger -->
        <appender-ref ref="${STDOUT}"/>

        <!-- FILE_ALL 日志輸出添加到 logger -->
        <appender-ref ref="FILE_ALL"/>

        <!-- FILE_ERROR 日志輸出添加到 logger -->
        <appender-ref ref="FILE_ERROR"/>
    </root>

</configuration>

2.4 代碼中使用日志

在代碼中使用日志,只需要使用如下代碼:

private Logger logger = LoggerFactory.getLogger(this.getClass());
//...
logger.debug("this is debug");
logger.info("this is info");

三寡喝、Log4j2集成

3.1 配置依賴組件

Spring Boot添加Log4j2依賴的同時而钞,需要排除Logback依賴,配置pom.xml代碼如下:

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions><!-- 去掉logback配置 -->
                <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>
</dependencies>

3.2 自定義日志配置

添加log4j2-spring.xml文件在src/main/resources文件下拘荡,配置文件代碼如下:

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <Appenders>
        <Console name="CONSOLE" target="SYSTEM_OUT">
            <PatternLayout charset="UTF-8" pattern="[%-5p] %d %c - %m%n" />
        </Console>

        <File name="File" fileName="D:\\mylog.log">
            <PatternLayout pattern="%m%n" />
        </File>
    </Appenders>

    <Loggers>
        <root level="info">
            <AppenderRef ref="CONSOLE" />
            <AppenderRef ref="File" />
        </root>
    </Loggers>
</configuration>

輸入日志到控制臺和D盤mylog.log文件中臼节。

到此為止,已經(jīng)完成了log4j2的集成珊皿,運行項目网缝,查看日志。

示例源碼:https://github.com/vipstone/springboot-example/tree/master/springboot-logging

參考資料

JAVA日志的前世今生:https://www.cnblogs.com/xiexj/p/9417128.html

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末蟋定,一起剝皮案震驚了整個濱河市粉臊,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌驶兜,老刑警劉巖扼仲,帶你破解...
    沈念sama閱讀 207,113評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異抄淑,居然都是意外死亡屠凶,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,644評論 2 381
  • 文/潘曉璐 我一進店門肆资,熙熙樓的掌柜王于貴愁眉苦臉地迎上來矗愧,“玉大人,你說我怎么就攤上這事郑原“拢” “怎么了?”我有些...
    開封第一講書人閱讀 153,340評論 0 344
  • 文/不壞的土叔 我叫張陵犯犁,是天一觀的道長属愤。 經(jīng)常有香客問我,道長酸役,這世上最難降的妖魔是什么住诸? 我笑而不...
    開封第一講書人閱讀 55,449評論 1 279
  • 正文 為了忘掉前任驾胆,我火速辦了婚禮,結(jié)果婚禮上只壳,老公的妹妹穿的比我還像新娘俏拱。我一直安慰自己暑塑,他們只是感情好吼句,可當我...
    茶點故事閱讀 64,445評論 5 374
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著事格,像睡著了一般惕艳。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上驹愚,一...
    開封第一講書人閱讀 49,166評論 1 284
  • 那天远搪,我揣著相機與錄音,去河邊找鬼逢捺。 笑死谁鳍,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的劫瞳。 我是一名探鬼主播倘潜,決...
    沈念sama閱讀 38,442評論 3 401
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼志于!你這毒婦竟也來了涮因?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,105評論 0 261
  • 序言:老撾萬榮一對情侶失蹤伺绽,失蹤者是張志新(化名)和其女友劉穎养泡,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體奈应,經(jīng)...
    沈念sama閱讀 43,601評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡澜掩,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,066評論 2 325
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了杖挣。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片输硝。...
    茶點故事閱讀 38,161評論 1 334
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖程梦,靈堂內(nèi)的尸體忽然破棺而出点把,到底是詐尸還是另有隱情,我是刑警寧澤屿附,帶...
    沈念sama閱讀 33,792評論 4 323
  • 正文 年R本政府宣布郎逃,位于F島的核電站,受9級特大地震影響挺份,放射性物質(zhì)發(fā)生泄漏褒翰。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 39,351評論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望优训。 院中可真熱鬧朵你,春花似錦、人聲如沸揣非。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,352評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽早敬。三九已至忌傻,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間搞监,已是汗流浹背水孩。 一陣腳步聲響...
    開封第一講書人閱讀 31,584評論 1 261
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留琐驴,地道東北人俘种。 一個月前我還...
    沈念sama閱讀 45,618評論 2 355
  • 正文 我出身青樓,卻偏偏與公主長得像绝淡,于是被迫代替她去往敵國和親宙刘。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 42,916評論 2 344

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