Springboot整合log4j2日志全解

常用的日志框架

  • java.util.logging：是JDK在1.4版本中引入的Java原生日志框架
  • Log4j：Apache的一個(gè)開源項(xiàng)目，可以控制日志信息輸送的目的地是控制臺隘庄、文件宜狐、GUI組件等喂击，可以控制每一條日志的輸出格式，這些可以通過一個(gè)配置文件來靈活地進(jìn)行配置，而不需要修改應(yīng)用的代碼框冀。雖然已經(jīng)停止維護(hù)了钧舌，但目前絕大部分企業(yè)都是用的log4j担汤。
  • LogBack：是Log4j的一個(gè)改良版本
  • Log4j2：Log4j2已經(jīng)不僅僅是Log4j的一個(gè)升級版本了，它從頭到尾都被重寫了

日志門面slf4j

上述介紹的是一些日志框架的實(shí)現(xiàn)洼冻，這里我們需要用日志門面來解決系統(tǒng)與日志實(shí)現(xiàn)框架的耦合性崭歧。SLF4J，即簡單日志門面（Simple Logging Facade for Java）撞牢，它不是一個(gè)真正的日志實(shí)現(xiàn)率碾，而是一個(gè)抽象層（ abstraction layer），它允許你在后臺使用任意一個(gè)日志實(shí)現(xiàn)屋彪。



前面介紹的幾種日志框架一樣所宰，每一種日志框架都有自己單獨(dú)的API，要使用對應(yīng)的框架就要使用其對應(yīng)的API畜挥，這就大大的增加應(yīng)用程序代碼對于日志框架的耦合性仔粥。

使用了slf4j后，對于應(yīng)用程序來說，無論底層的日志框架如何變躯泰，應(yīng)用程序不需要修改任意一行代碼谭羔，就可以直接上線了。

為什么選用log4j2

在這列舉一下一些網(wǎng)上其他博文中對它們的性能評測：


  • 可以看到在同步日志模式下, Logback的性能是最糟糕的.

  • log4j2的性能無論在同步日志模式還是異步日志模式下都是最佳的.


log4j2優(yōu)越的性能其原因在于log4j2使用了LMAX,一個(gè)無鎖的線程間通信庫代替了,logback和log4j之前的隊(duì)列. 并發(fā)性能大大提升麦向。

整合步驟

1. 引入依賴

springboot默認(rèn)是用logback的日志框架的口糕，所以需要排除logback，不然會出現(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>

2. 配置文件

  • 如果自定義了文件名景描，需要在application.yml中配置
logging:
  config: xxxx.xml
  level:
    cn.com.xxx: debug
  • 默認(rèn)名log4j2-spring.xml，就省下了在application.yml中配置

3. 配置文件模版

log4j是通過一個(gè).properties的文件作為主配置文件的秀撇，而現(xiàn)在的log4j2則已經(jīng)棄用了這種方式超棺，采用的是.xml，.json或者.jsn這種方式來做呵燕，可能這也是技術(shù)發(fā)展的一個(gè)必然性棠绘，因?yàn)閜roperties文件的可閱讀性真的是有點(diǎn)差。這里給出一個(gè)模版再扭，供大家參考氧苍。

<?xml version="1.0" encoding="UTF-8"?>
<!--Configuration后面的status，這個(gè)用于設(shè)置log4j2自身內(nèi)部的信息輸出泛范，可以不設(shè)置让虐，當(dāng)設(shè)置成trace時(shí)，你會看到log4j2內(nèi)部各種詳細(xì)輸出-->
<!--monitorInterval：Log4j能夠自動檢測修改配置 文件和重新配置本身罢荡，設(shè)置間隔秒數(shù)-->
<configuration monitorInterval="5">
  <!--日志級別以及優(yōu)先級排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->

  <!--變量配置-->
  <Properties>
    <!-- 格式化輸出：%date表示日期赡突，%thread表示線程名，%-5level：級別從左顯示5個(gè)字符寬度 %msg：日志消息区赵，%n是換行符-->
    <!-- %logger{36} 表示 Logger 名字最長36個(gè)字符 -->
    <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="更換為你的項(xiàng)目名" />
  </Properties>

  <appenders>

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

    <!--文件會打印出所有信息，這個(gè)log每次運(yùn)行程序會自動清空笼才，由append屬性決定漱受，適合臨時(shí)測試用-->
    <File name="Filelog" fileName="${FILE_PATH}/test.log" append="false">
      <PatternLayout pattern="${LOG_PATTERN}"/>
    </File>

    <!-- 這個(gè)會打印出所有的info及以下級別的信息，每次大小超過size骡送，則這size大小的日志會自動存入按年份-月份建立的文件夾下面并進(jìn)行壓縮昂羡，作為存檔-->
    <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="${LOG_PATTERN}"/>
      <Policies>
        <!--interval屬性用來指定多久滾動一次各谚，默認(rèn)是1 hour-->
        <TimeBasedTriggeringPolicy interval="1"/>
        <SizeBasedTriggeringPolicy size="10MB"/>
      </Policies>
      <!-- DefaultRolloverStrategy屬性如不設(shè)置紧憾，則默認(rèn)為最多同一文件夾下7個(gè)文件開始覆蓋-->
      <DefaultRolloverStrategy max="15"/>
    </RollingFile>

    <!-- 這個(gè)會打印出所有的warn及以下級別的信息，每次大小超過size昌渤，則這size大小的日志會自動存入按年份-月份建立的文件夾下面并進(jìn)行壓縮赴穗，作為存檔-->
    <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屬性用來指定多久滾動一次，默認(rèn)是1 hour-->
        <TimeBasedTriggeringPolicy interval="1"/>
        <SizeBasedTriggeringPolicy size="10MB"/>
      </Policies>
      <!-- DefaultRolloverStrategy屬性如不設(shè)置般眉，則默認(rèn)為最多同一文件夾下7個(gè)文件開始覆蓋-->
      <DefaultRolloverStrategy max="15"/>
    </RollingFile>

    <!-- 這個(gè)會打印出所有的error及以下級別的信息了赵，每次大小超過size，則這size大小的日志會自動存入按年份-月份建立的文件夾下面并進(jìn)行壓縮甸赃，作為存檔-->
    <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屬性用來指定多久滾動一次，默認(rèn)是1 hour-->
        <TimeBasedTriggeringPolicy interval="1"/>
        <SizeBasedTriggeringPolicy size="10MB"/>
      </Policies>
      <!-- DefaultRolloverStrategy屬性如不設(shè)置埠对，則默認(rèn)為最多同一文件夾下7個(gè)文件開始覆蓋-->
      <DefaultRolloverStrategy max="15"/>
    </RollingFile>

  </appenders>

  <!--Logger節(jié)點(diǎn)用來單獨(dú)指定日志的形式络断，比如要為指定包下的class指定不同的日志級別等。-->
  <!--然后定義loggers项玛，只有定義了logger并引入的appender貌笨，appender才會生效-->
  <loggers>

    <!--過濾掉spring和mybatis的一些無用的DEBUG信息-->
    <logger name="org.mybatis" level="info" additivity="false">
      <AppenderRef ref="Console"/>
    </logger>
    <!--監(jiān)控系統(tǒng)信息-->
    <!--若是additivity設(shè)為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>

配置參數(shù)簡介

1. 日志級別

機(jī)制：如果一條日志信息的級別大于等于配置文件的級別，就記錄开伏。

低 --> 高

  • trace：追蹤膀跌，就是程序推進(jìn)一下，可以寫個(gè)trace輸出
  • debug：調(diào)試固灵，一般作為最低級別捅伤，trace基本不用。
  • info：輸出重要的信息怎虫，使用較多
  • warn：警告暑认，有些信息不是錯(cuò)誤信息困介，但也要給程序員一些提示大审。
  • error：錯(cuò)誤信息。用的也很多座哩。
  • fatal：致命錯(cuò)誤徒扶。

2. 輸出源

  • CONSOLE（輸出到控制臺）
  • FILE（輸出到文件）

3. 格式

  • SimpleLayout：以簡單的形式顯示
  • HTMLLayout：以HTML表格顯示
  • PatternLayout：自定義形式顯示

4. PatternLayout自定義日志布局

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

簡單使用

public class LogExampleOther {
  private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExampleOther.class);
  
  public static void main(String... args) {
    log.error("Something else is wrong here");
  }
}

使用lombok工具簡化創(chuàng)建Logger類

使用lombok后下面的代碼等效于上述的代碼，這樣會更方便的使用日志尘惧。

@Slf4j
public class LogExampleOther {
  
  public static void main(String... args) {
    log.error("Something else is wrong here");
  }
}
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 人面猴
    序言：七十年代末康栈，一起剝皮案震驚了整個(gè)濱河市，隨后出現(xiàn)的幾起案子，更是在濱河造成了極大的恐慌啥么，老刑警劉巖登舞，帶你破解...
    沈念sama閱讀 212,542評論 6贊 493
  • 死咒
    序言：濱河連續(xù)發(fā)生了三起死亡事件，死亡現(xiàn)場離奇詭異悬荣，居然都是意外死亡菠秒，警方通過查閱死者的電腦和手機(jī)，發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,596評論 3贊 385
  • 救了他兩次的神仙讓他今天三更去死
    文/潘曉璐 我一進(jìn)店門氯迂，熙熙樓的掌柜王于貴愁眉苦臉地迎上來践叠，“玉大人，你說我怎么就攤上這事嚼蚀〗臀酰” “怎么了？”我有些...
    開封第一講書人閱讀 158,021評論 0贊 348
  • 道士緝兇錄：失蹤的賣姜人
    文/不壞的土叔 我叫張陵驰坊，是天一觀的道長匾二。 經(jīng)常有香客問我，道長拳芙，這世上最難降的妖魔是什么察藐？ 我笑而不...
    開封第一講書人閱讀 56,682評論 1贊 284
  • ?港島之戀（遺憾婚禮）
    正文 為了忘掉前任，我火速辦了婚禮舟扎，結(jié)果婚禮上分飞，老公的妹妹穿的比我還像新娘。我一直安慰自己睹限，他們只是感情好譬猫，可當(dāng)我...
    茶點(diǎn)故事閱讀 65,792評論 6贊 386
  • 惡毒庶女頂嫁案：這布局不是一般人想出來的
    文/花漫 我一把揭開白布。 她就那樣靜靜地躺著羡疗，像睡著了一般染服。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上叨恨，一...
    開封第一講書人閱讀 49,985評論 1贊 291
  • 城市分裂傳說
    那天柳刮，我揣著相機(jī)與錄音嫩挤，去河邊找鬼爽蝴。 笑死，一個(gè)胖子當(dāng)著我的面吹牛澜建，可吹牛的內(nèi)容都是我干的送矩。 我是一名探鬼主播蚕甥，決...
    沈念sama閱讀 39,107評論 3贊 410
  • 雙鴛鴦連環(huán)套：你想象不到人心有多黑
    文/蒼蘭香墨 我猛地睜開眼，長吁一口氣：“原來是場噩夢啊……” “哼栋荸！你這毒婦竟也來了菇怀？” 一聲冷哼從身側(cè)響起夷家，我...
    開封第一講書人閱讀 37,845評論 0贊 268
  • 萬榮殺人案實(shí)錄
    序言：老撾萬榮一對情侶失蹤，失蹤者是張志新（化名）和其女友劉穎敏释，沒想到半個(gè)月后库快，有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體，經(jīng)...
    沈念sama閱讀 44,299評論 1贊 303
  • ?護(hù)林員之死
    正文 獨(dú)居荒郊野嶺守林人離奇死亡钥顽，尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,612評論 2贊 327
  • ?白月光啟示錄
    正文 我和宋清朗相戀三年义屏，在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片蜂大。...
    茶點(diǎn)故事閱讀 38,747評論 1贊 341
  • 活死人
    序言：一個(gè)原本活蹦亂跳的男人離奇死亡闽铐，死狀恐怖，靈堂內(nèi)的尸體忽然破棺而出奶浦，到底是詐尸還是另有隱情兄墅，我是刑警寧澤，帶...
    沈念sama閱讀 34,441評論 4贊 333
  • ?日本核電站爆炸內(nèi)幕
    正文 年R本政府宣布澳叉，位于F島的核電站隙咸，受9級特大地震影響，放射性物質(zhì)發(fā)生泄漏成洗。R本人自食惡果不足惜五督，卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 40,072評論 3贊 317
  • 男人毒藥：我在死后第九天來索命
    文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望瓶殃。 院中可真熱鬧充包，春花似錦、人聲如沸遥椿。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,828評論 0贊 21
  • 一樁弒父案，背后竟有這般陰謀
    文/蒼蘭香墨 我抬頭看了看天上的太陽冠场。三九已至家浇，卻和暖如春，著一層夾襖步出監(jiān)牢的瞬間慈鸠，已是汗流浹背蓝谨。 一陣腳步聲響...
    開封第一講書人閱讀 32,069評論 1贊 267
  • 情欲美人皮
    我被黑心中介騙來泰國打工， 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留青团，地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 46,545評論 2贊 362
  • 代替公主和親
    正文 我出身青樓咖楣，卻偏偏與公主長得像督笆，于是被迫代替她去往敵國和親。 傳聞我的和親對象是個(gè)殘疾皇子诱贿，可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,658評論 2贊 350