后臺程序開發及上線時，一般都會用到Log信息打印及Log日志記錄，開發時通過Log信息打印可以快速的定位問題所在，幫助我們快捷開發。程序上線后如遇到Bug或錯誤，此時則需要日志記錄來查找發現問題所在。
Spring Boot 可以集成很多不同的日志系統，其中最常用的Apache Log4j，而Log4j 2是Log4j的升級版本，Log4j 2相對于Log4j 1.x 有了很多顯著的改善。所以這篇博客就直接來說說Spring Boot如何集成并配置使用Log4j2.
1. 導入Log4j2的包
如果你使用Gradle，則在 build.gradle 文件中添加以下依賴。示例代碼中使用的是Gradle方式。
|
1
2
3
4
5
6
7
|
dependencies { // log4j2 compile "org.apache.logging.log4j:log4j-api:2.8" compile "org.apache.logging.log4j:log4j-core:2.8" // 用來支持Logger中的Async compile 'com.lmax:disruptor:3.3.6'} |
如果你使用Maven，則在 pom.xml 文件中添加以下依賴。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
<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配置文件
在項目的resources資源文件根目錄下創建 log4j2.xml 文件并復制以下代碼到文件中。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
<?xml version="1.0" encoding="UTF-8"?><!-- Configuration后面的status，這個用于設置log4j2自身內部的信息輸出，可以不設置，當設置成trace時， 你會看到log4j2內部各種詳細輸出。可以設置成OFF(關閉)或Error(只輸出錯誤信息)--><Configurationstatus="OFF"> <!-- 日志文件目錄和壓縮文件目錄配置 --> <Properties> <Propertyname="fileName">/home/kylin/log/knight/spring_log</Property> <Propertyname="fileGz">/home/kylin/log/knight/spring_log/7z</Property> </Properties> <Appenders> <!-- 輸出控制臺日志的配置 --> <Consolename="console"target="SYSTEM_OUT"> <!--控制臺只輸出level及以上級別的信息（onMatch），其他的直接拒絕（onMismatch）--> <ThresholdFilterlevel="info"onMatch="ACCEPT"onMismatch="DENY"/> <!-- 輸出日志的格式 --> <PatternLayoutpattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/> </Console> <!-- 打印出所有的信息，每次大小超過size，則這size大小的日志會自動存入按年份-月份建立的文件夾下面并進行壓縮，作為存檔 --> <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級別信息 --> <ThresholdFilterlevel="error"onMatch="DENY"onMismatch="NEUTRAL"/> <ThresholdFilterlevel="info"onMatch="ACCEPT"onMismatch="DENY"/> </Filters> <!-- 指定每天的最大壓縮包個數，默認7個，超過了會覆蓋之前的 --> <DefaultRolloverStrategymax="50"/> </RollingRandomAccessFile> <!-- 存儲所有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級別信息 --> <ThresholdFilterlevel="error"onMatch="ACCEPT"onMismatch="DENY"/> </Filters> <!-- 指定每天的最大壓縮包個數，默認7個，超過了會覆蓋之前的 --> <DefaultRolloverStrategymax="50"/> </RollingRandomAccessFile> </Appenders> <!-- 全局配置，默認所有的Logger都繼承此配置 --> <Loggers> <!-- AsyncRoot - 異步記錄日志 - 需要LMAX Disruptor的支持 --> <AsyncRootlevel="info"additivity="false"> <AppenderRefref="console"/> <AppenderRefref="infoFile"/> <AppenderRefref="errorFile"/> </AsyncRoot> </Loggers></Configuration> |
3. 編寫Log4j2輔助類
做好以上的配置之后，我們可以編寫一個輔助類，讓我們更方便的使用Log4j2來記錄日志。
在utils包中創建 L.java 類文件。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
|
package com.spring.log4j2.utils;import org.apache.logging.log4j.LogManager;import org.apache.logging.log4j.Logger;/** * Logger 日志記錄輔助類 * * 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); }} |
編寫完輔助類，使用起來就很簡單了，通過下面的代碼就可以輕松使用。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
@Controllerpublic 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.getLogger() 方法獲取Logger實例來使用。
4. 結果驗證
日志的Level分級：TRACE < DEBUG < INFO < WARN < ERROR < FATAL。
因為我的log4j2中的level設置的是 INFO 級別。所以打印信息中只能看到 INFO 、 WARN 、 ERROR 三種級別(FATAL級別的信息沒有打印，否則也可以看到)。
打印信息如下圖所示：
同時在電腦系統中生成了Log文件，如下圖所示：
觀察路徑可以發現，這個路徑正是在 Log4j2.xml 中設置的路徑：
|
1
2
3
4
5
|
<!-- 日志文件目錄和壓縮文件目錄配置 --><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
以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持服務器之家。
原文鏈接：https://dkylin.com/archives/2017/spring-boot-log4j2-config.html?utm_source=tuicool&utm_medium=referral
