1.說明
本文詳細介紹Spring Boot集成Log4j2框架的方法，
基於已經創建好的Spring Boot工程，
由於Spring Boot默認使用的是Logback框架，
需要先排除掉Logback框架，
然后引入Log4j2框架，
再使用日志門面Slf4j框架打印日志。
2.修改pom.xml文件
首先排除掉Logback框架，
由於spring-boot-starter依賴的spring-boot-starter-logging
默認使用的是Logback框架，
所以需要排除掉spring-boot-starter-logging依賴；
然后引入spring-boot-starter-log4j2依賴，
它包含了引入Log4j2框架需要的所有依賴。
修改在pom.xml文件如下：
<!-- Log4j2 start 日志框架 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>
<!-- Log4j2 end -->
如果引入了第三方的框架依賴，
注意一定要把Logback的依賴排除干凈，
可以通過IDE工具查看Maven依賴，
把所有Logback的依賴排除掉即可。
3.新增log4j2.xml文件
注意修改日志包路徑com.example.demo,
對應的日志級別需要為DEBUG：
<?xml version="1.0" encoding="UTF-8"?>
<!--status:Log4j2內部日志的輸出級別,設置為TRACE對研究Log4j2非常有用 -->
<!--monitorInterval:定時檢測配置文件的修改,有變化則自動重新加載配置,時間單位為秒,最小間隔為5s -->
<Configuration status="WARN" monitorInterval="600">
<!--properties:設置全局變量 -->
<properties>
<!--LOG_HOME:指定當前日志存放的目錄 -->
<property name="LOG_HOME">logs</property>
<!--FILE_NAME:指定日志文件的名稱 -->
<property name="FILE_NAME">mybatis_plus_demo</property>
</properties>
<!--Appenders:定義日志輸出目的地，內容和格式等 -->
<Appenders>
<!--Console:日志輸出到控制台標准輸出 -->
<Console name="Console" target="SYSTEM_OUT">
<!--pattern:日期,線程名,日志級別,日志名稱,日志信息,換行 -->
<PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level [%L] - %msg%n" />
</Console>
<!--RollingFile:日志輸出到文件,下面的文件都使用相對路徑 -->
<!--fileName:當前日志輸出的文件名稱 -->
<!--filePattern:備份日志文件名稱，備份目錄為logs下面以年月命名的目錄，備份時使用gz格式壓縮 -->
<RollingFile name="RollingFile" fileName="${LOG_HOME}/${FILE_NAME}.log"
filePattern="${LOG_HOME}/$${date:yyyy-MM}/${FILE_NAME}-%d{yyyy-MM-dd}-%i.log.gz">
<!-- 輸出日志事件調用者的完全限定名、源文件名和行號，注意可能會影響性能，請謹慎使用。 -->
<PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level [%l] - %msg%n" />
<!--Policies:觸發策略決定何時執行備份 -->
<Policies>
<!--TimeBasedTriggeringPolicy:日志文件按照時間備份 -->
<!--interval:每1天分鍾生成一個新文件，需要結合filePattern時間%d{yyyy-MM-dd} -->
<!--同理，如果要每1小時生成一個新文件，則改成%d{yyyy-MM-ddHH} -->
<!--modulate:對備份日志的生成時間糾偏，糾偏以0為基准進行，"0+interval"決定啟動后第一次備份時間 -->
<TimeBasedTriggeringPolicy interval="1" modulate="true" />
<!--SizeBasedTriggeringPolicy:日志文件按照大小備份 -->
<!--size:指定日志文件最大為100MB，單位可以為KB、MB或GB -->
<SizeBasedTriggeringPolicy size="100MB" />
</Policies>
<!--DefaultRolloverStrategy:翻轉策略決定如何執行備份 -->
<!--max:最多保存5個日志備份文件，結合時間使用后，在每個時間段內最多有5個備份，多出來的會被覆蓋 -->
<!--compressionLevel:配置日志壓縮級別，范圍0-9，0不壓縮，1壓縮速度最快，9壓縮率最好，目前只對於zip壓縮文件類型有效 -->
<DefaultRolloverStrategy max="5" compressionLevel="1">
<!--Delete:刪除匹配到的過期備份日志文件 -->
<!--maxDepth:由於備份日志保存在${LOG_HOME}/$${date:yyyy-MM},所以目錄深度設置為2 -->
<Delete basePath="${LOG_HOME}" maxDepth="2">
<!--IfFileName:匹配文件名稱 -->
<!--glob:匹配2級目錄深度下的以.log.gz結尾的備份文件 -->
<IfFileName glob="*/*.log.gz" />
<!--IfLastModified:匹配文件修改時間 -->
<!--age:匹配超過180天的文件，單位D、H、M、S分別表示天、小時、分鍾、秒-->
<IfLastModified age="180D" />
</Delete>
</DefaultRolloverStrategy>
</RollingFile>
</Appenders>
<!--Loggers:定義日志級別和使用的Appenders -->
<Loggers>
<!--name: 打印日志的類的包路徑 -->
<!--additivity: true當前的Logger打印的日志附加到Root，false僅僅打印到RollingFile -->
<Logger name="com.example.demo" level="DEBUG" additivity="true">
<AppenderRef ref="RollingFile" />
</Logger>
<!--dao:控制mybatis打印執行的SQL日志 -->
<Logger name="com.example.demo.dao" level="DEBUG" additivity="true">
<AppenderRef ref="RollingFile" />
</Logger>
<!--Root:日志默認打印到控制台 -->
<!--level日志級別: ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF -->
<Root level="ERROR">
<AppenderRef ref="Console" />
</Root>
</Loggers>
</Configuration>
4.使用Slf4j打印
業務打印日志需要先創建logger,
注意使用Slf4j提供的類：
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private Logger logger = LoggerFactory.getLogger(getClass());
然后在業務需要的地方打印日志即可，
包含日志的完整業務代碼如下：
package com.example.demo.controller.impl;
import java.util.List;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RestController;
import com.example.demo.controller.UserController;
import com.example.demo.entity.User;
import com.example.demo.service.UserService;
@RestController
public class UserControllerImpl implements UserController {
private Logger logger = LoggerFactory.getLogger(getClass());
@Autowired
UserService userService;
@Override
public List<User> getUsersAll() {
logger.debug("UserControllerImpl.getUsersAll() start");
List<User> users = userService.getUsersAll();
logger.debug("UserControllerImpl.getUsersAll() end, result users={}", users);
return users;
}
}
5.開始日志打印
啟動Spring Boot應用，
然后調用業務提供的接口，
可以看到如下日志：
2020-07-02 15:57:11.723 [http-nio-8088-exec-1] DEBUG [24] - UserControllerImpl.getUsersAll() start
2020-07-02 15:57:11.883 [http-nio-8088-exec-1] DEBUG [143] - ==> Preparing: SELECT id,name,age,email FROM TBL_USER
2020-07-02 15:57:11.901 [http-nio-8088-exec-1] DEBUG [143] - ==> Parameters:
2020-07-02 15:57:11.920 [http-nio-8088-exec-1] DEBUG [143] - <== Total: 5
2020-07-02 15:57:11.925 [http-nio-8088-exec-1] DEBUG [26] - UserControllerImpl.getUsersAll() end, result users=[User [id=1, name=Jone, age=18, email=test1@baomidou.com], User [id=2, name=Jack, age=20, email=test2@baomidou.com], User [id=3, name=Tom, age=28, email=test3@baomidou.com], User [id=4, name=Sandy, age=21, email=test4@baomidou.com], User [id=5, name=Billie, age=24, email=test5@baomidou.com]]
同時可以看到工程根目錄下生成了日志文件：
logs\mybatis_plus_demo.log