Spring Boot Log4j2的配置使用詳解
后臺(tái)程序開(kāi)發(fā)及上線(xiàn)時(shí),一般都會(huì)用到Log信息打印及Log日志記錄,開(kāi)發(fā)時(shí)通過(guò)Log信息打印可以快速的定位問(wèn)題所在,幫助我們快捷開(kāi)發(fā)。程序上線(xiàn)后如遇到Bug或錯(cuò)誤,此時(shí)則需要日志記錄來(lái)查找發(fā)現(xiàn)問(wèn)題所在。
Spring Boot 可以集成很多不同的日志系統(tǒng),其中最常用的Apache Log4j,而Log4j 2是Log4j的升級(jí)版本,Log4j 2相對(duì)于Log4j 1.x 有了很多顯著的改善。所以這篇博客就直接來(lái)說(shuō)說(shuō)Spring Boot如何集成并配置使用Log4j2.
1. 導(dǎo)入Log4j2的包
如果你使用Gradle,則在 build.gradle 文件中添加以下依賴(lài)。示例代碼中使用的是Gradle方式。
dependencies { // log4j2 compile "org.apache.logging.log4j:log4j-api:2.8" compile "org.apache.logging.log4j:log4j-core:2.8" // 用來(lái)支持Logger中的Async compile 'com.lmax:disruptor:3.3.6' }
如果你使用Maven,則在 pom.xml 文件中添加以下依賴(lài)。
<dependencies> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-api</artifactId> <version>2.8</version> </dependency> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-core</artifactId> <version>2.8</version> </dependency> <dependency> <groupId>com.lmax</groupId> <artifactId>disruptor</artifactId> <version>3.3.6</version> </dependency> </dependencies>
2. 添加log4j2配置文件
在項(xiàng)目的resources資源文件根目錄下創(chuàng)建 log4j2.xml 文件并復(fù)制以下代碼到文件中。
<?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ì)輸出。可以設(shè)置成OFF(關(guān)閉)或Error(只輸出錯(cuò)誤信息) --> <Configurationstatus="OFF"> <!-- 日志文件目錄和壓縮文件目錄配置 --> <Properties> <Propertyname="fileName">/home/kylin/log/knight/spring_log</Property> <Propertyname="fileGz">/home/kylin/log/knight/spring_log/7z</Property> </Properties> <Appenders> <!-- 輸出控制臺(tái)日志的配置 --> <Consolename="console"target="SYSTEM_OUT"> <!--控制臺(tái)只輸出level及以上級(jí)別的信息(onMatch),其他的直接拒絕(onMismatch)--> <ThresholdFilterlevel="info"onMatch="ACCEPT"onMismatch="DENY"/> <!-- 輸出日志的格式 --> <PatternLayoutpattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/> </Console> <!-- 打印出所有的信息,每次大小超過(guò)size,則這size大小的日志會(huì)自動(dòng)存入按年份-月份建立的文件夾下面并進(jìn)行壓縮,作為存檔 --> <RollingRandomAccessFilename="infoFile"fileName="${fileName}/web-info.log"immediateFlush="false" filePattern="${fileGz}/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.web-info.gz"> <PatternLayoutpattern="%d{yyyy-MM-dd 'at' HH:mm:ss z} [%t] %-5level %logger{36} %L %M - %msg%xEx%n"/> <Policies> <TimeBasedTriggeringPolicyinterval="6"modulate="true"/> <SizeBasedTriggeringPolicysize="50 MB"/> </Policies> <Filters> <!-- 只記錄info和warn級(jí)別信息 --> <ThresholdFilterlevel="error"onMatch="DENY"onMismatch="NEUTRAL"/> <ThresholdFilterlevel="info"onMatch="ACCEPT"onMismatch="DENY"/> </Filters> <!-- 指定每天的最大壓縮包個(gè)數(shù),默認(rèn)7個(gè),超過(guò)了會(huì)覆蓋之前的 --> <DefaultRolloverStrategymax="50"/> </RollingRandomAccessFile> <!-- 存儲(chǔ)所有error信息 --> <RollingRandomAccessFilename="errorFile"fileName="${fileName}/web-error.log"immediateFlush="false" filePattern="${fileGz}/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.web-error.gz"> <PatternLayoutpattern="%d{yyyy-MM-dd 'at' HH:mm:ss z} [%t] %-5level %logger{36} %L %M - %msg%xEx%n"/> <Policies> <TimeBasedTriggeringPolicyinterval="6"modulate="true"/> <SizeBasedTriggeringPolicysize="50 MB"/> </Policies> <Filters> <!-- 只記錄error級(jí)別信息 --> <ThresholdFilterlevel="error"onMatch="ACCEPT"onMismatch="DENY"/> </Filters> <!-- 指定每天的最大壓縮包個(gè)數(shù),默認(rèn)7個(gè),超過(guò)了會(huì)覆蓋之前的 --> <DefaultRolloverStrategymax="50"/> </RollingRandomAccessFile> </Appenders> <!-- 全局配置,默認(rèn)所有的Logger都繼承此配置 --> <Loggers> <!-- AsyncRoot - 異步記錄日志 - 需要LMAX Disruptor的支持 --> <AsyncRootlevel="info"additivity="false"> <AppenderRefref="console"/> <AppenderRefref="infoFile"/> <AppenderRefref="errorFile"/> </AsyncRoot> </Loggers> </Configuration>
3. 編寫(xiě)Log4j2輔助類(lèi)
做好以上的配置之后,我們可以編寫(xiě)一個(gè)輔助類(lèi),讓我們更方便的使用Log4j2來(lái)記錄日志。
在utils包中創(chuàng)建 L.java 類(lèi)文件。
package com.spring.log4j2.utils; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; /** * Logger 日志記錄輔助類(lèi) * * Created by Kylin on 2017/5/11. */ public classL{ private static final Logger LOGGER = LogManager.getLogger(); privateL(){ /* cannot be instantiated */ throw new UnsupportedOperationException("cannot be instantiated"); } publicstaticLoggergetLogger(){ return LOGGER; } publicstaticvoidt(String msg){ LOGGER.trace(msg); } publicstaticvoidd(String msg){ LOGGER.debug(msg); } publicstaticvoidi(String msg){ LOGGER.info(msg); } publicstaticvoidw(String msg){ LOGGER.warn(msg); } publicstaticvoide(String msg){ LOGGER.error(msg); } }
編寫(xiě)完輔助類(lèi),使用起來(lái)就很簡(jiǎn)單了,通過(guò)下面的代碼就可以輕松使用。
@Controller public classWebController{ @RequestMapping("/") publicStringindex(){ String msg = "Spring Boot系列之Log4j2的配置及使用"; L.t(msg); L.d(msg); L.i(msg); L.w(msg); L.e(msg); return "index"; } }
這里的輔助類(lèi)只是寫(xiě)了一些基本的使用方法,你可以根據(jù)你的需求進(jìn)行定制,增加更多的輔助方法。對(duì)于輔助類(lèi)中沒(méi)有提供的方法也可以使用 L.getLogger() 方法獲取Logger實(shí)例來(lái)使用。
4. 結(jié)果驗(yàn)證
日志的Level分級(jí):TRACE < DEBUG < INFO < WARN < ERROR < FATAL。
因?yàn)槲业膌og4j2中的level設(shè)置的是 INFO 級(jí)別。所以打印信息中只能看到 INFO 、 WARN 、 ERROR 三種級(jí)別(FATAL級(jí)別的信息沒(méi)有打印,否則也可以看到)。
打印信息如下圖所示:
同時(shí)在電腦系統(tǒng)中生成了Log文件,如下圖所示:
觀察路徑可以發(fā)現(xiàn),這個(gè)路徑正是在 Log4j2.xml 中設(shè)置的路徑:
<!-- 日志文件目錄和壓縮文件目錄配置 --> <Properties> <Propertyname="fileName">/home/kylin/log/knight/spring_log</Property> <Propertyname="fileGz">/home/kylin/log/knight/spring_log/7z</Property> </Properties>
5. 更多
Log4j2的Github地址:https://github.com/apache/logging-log4j2
本教程的示例代碼地址:https://github.com/dkylin/SpringBoot-Sample/tree/master/SpringBoot-log4j2
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
springboot整合x(chóng)xl-job實(shí)現(xiàn)分布式定時(shí)任務(wù)的過(guò)程
XXL-JOB是一個(gè)分布式任務(wù)調(diào)度平臺(tái),其核心設(shè)計(jì)目標(biāo)是開(kāi)發(fā)迅速、學(xué)習(xí)簡(jiǎn)單、輕量級(jí)、易擴(kuò)展,這篇文章主要介紹了springboot整合x(chóng)xl-job分布式定時(shí)任務(wù),需要的朋友可以參考下2022-08-08java結(jié)合keytool如何實(shí)現(xiàn)非對(duì)稱(chēng)簽名和驗(yàn)證詳解
這篇文章主要給大家介紹了關(guān)于java結(jié)合keytool如何實(shí)現(xiàn)非對(duì)稱(chēng)簽名和驗(yàn)證的相關(guān)資料,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2018-08-08基于HttpServletResponse 相關(guān)常用方法的應(yīng)用
本篇文章小編為大家介紹,基于HttpServletResponse 相關(guān)常用方法的應(yīng)用,需要的朋友參考下2013-04-04基于springboot攔截器HandlerInterceptor的注入問(wèn)題
這篇文章主要介紹了springboot攔截器HandlerInterceptor的注入問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-09-09springMVC之HandlerExceptionResolver使用
這篇文章主要介紹了springMVC之HandlerExceptionResolver使用,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-11-11使用DevOps開(kāi)源利器開(kāi)發(fā)部署Hygieia平臺(tái)
這篇文章主要為大家介紹了使用DevOps開(kāi)源利器開(kāi)發(fā)部署Hygieia平臺(tái)的實(shí)現(xiàn),有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步早日升職?加薪2022-03-03Java實(shí)體類(lèi)不要使用基本類(lèi)型的知識(shí)點(diǎn)總結(jié)
在本篇文章里小編給大家整理的是關(guān)于Java包裝類(lèi)之實(shí)體類(lèi)不要使用基本類(lèi)型的知識(shí)點(diǎn)內(nèi)容,需要的朋友們可以學(xué)習(xí)下。2020-02-02