Log4j2 是流行的日志框架的最新版本。在本教程中，我们将学习如何在示例 Spring Boot Web 应用程序中集成 Log4j2 配置文件。

Log4j2 是 Apache Log4j 的新版本，它借鉴了 Logback framework 的一些想法，具有改进的性能、支持多个记录器 API（Log4j、SLF4J、Commons Logging 和 JUL）、高级过滤、低垃圾收集器影响和自定义日志级别.

为了在 Spring Boot 应用程序中测试 Log4j2，让我们使用 Spring Boot Initializr 或 spring 命令行创建一个模板 Web 应用程序：

spring init -dweb demo-log4j2

从那里，我们需要改进一下配置。首先，我们将在您的 pom.xml 中添加 log4j2 的启动器：

<dependency>   <groupId>org.springframework.boot</groupId>   <artifactId>spring-boot-starter-log4j2</artifactId> </dependency>

还有一步要做，事实上在使用 Spring Boot 启动器时，Logback 用于默认记录。 Spring Boot 预先配置了带有模式和 ANSI 颜色的 Logback，以使标准输出更具可读性。作为概念证明，让我们检查一下刚刚创建的项目的 maven 依赖项：

[INFO] |  +- org.springframework.boot:spring-boot-starter:jar:2.3.3.RELEASE:compile  [INFO] |  |  +- org.springframework.boot:spring-boot:jar:2.3.3.RELEASE:compile   [INFO] |  |  +- org.springframework.boot:spring-boot-autoconfigure:jar:2.3.3.RELEASE:compile   [INFO] |  |  +- org.springframework.boot:spring-boot-starter-logging:jar:2.3.3.RELEASE:compile   [INFO] |  |  |  +- ch.qos.logback:logback-classic:jar:1.2.3:compile  [INFO] |  |  |  |  \- ch.qos.logback:logback-core:jar:1.2.3:compile  [INFO] |  |  |  \- org.apache.logging.log4j:log4j-to-slf4j:jar:2.13.3:compile  [INFO] |  |  +- jakarta.annotation:jakarta.annotation-api:jar:1.3.5:compile

因此，为了使用 LogBack 以外的 Logging 框架，我们必须从顶部的 spring-boot-starter 中排除默认的 spring-boot-starter-logging：

<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>

现在，如果我们再次检查项目依赖项，我们将看到 Log Back 不再出现在列表中：

[INFO] +- org.springframework.boot:spring-boot-starter:jar:2.3.3.RELEASE:compile [INFO] |  +- org.springframework.boot:spring-boot:jar:2.3.3.RELEASE:compile [INFO] |  |  \- org.springframework:spring-context:jar:5.2.8.RELEASE:compile [INFO] |  +- org.springframework.boot:spring-boot-autoconfigure:jar:2.3.3.RELEASE:compile [INFO] |  +- jakarta.annotation:jakarta.annotation-api:jar:1.3.5:compile [INFO] |  +- org.springframework:spring-core:jar:5.2.8.RELEASE:compile [INFO] |  |  \- org.springframework:spring-jcl:jar:5.2.8.RELEASE:compile

然后，让我们添加一个log4j2.xml 配置。好消息是，一旦 Spring Boot 在类路径中找到它的 jar 文件，它将自动配置 log4j2。因此，在 Maven 项目的 src/main/resources 文件夹中添加 log4j2.xml 或 (log4j2.properties) 就足够了：

<Configuration status="DEBUG">     <Appenders>         <Console name="LogToConsole" target="SYSTEM_OUT">             <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>         </Console>         <File name="LogToFile" fileName="logs/application.log">             <PatternLayout>                 <Pattern>%d %p %c{1.} [%t] %m%n</Pattern>             </PatternLayout>         </File>     </Appenders>     <Loggers>         <Logger name="com.example.demolog4j2" level="debug" additivity="false">             <AppenderRef ref="LogToFile"/>             <AppenderRef ref="LogToConsole"/>         </Logger>         <Logger name="org.springframework.boot" level="error" additivity="false">             <AppenderRef ref="LogToConsole"/>         </Logger>         <Root level="error">             <AppenderRef ref="LogToFile"/>             <AppenderRef ref="LogToConsole"/>         </Root>     </Loggers> </Configuration>

为了使用 log4j2，我们将添加一个极简的 Controller/Model/Repository 示例。这是 Repository 类，它记录在初始化时创建新客户对象的时间：

import org.springframework.stereotype.Component;
import javax.annotation.PostConstruct;
import java.util.ArrayList;
import java.util.List;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

@Component
public class CustomerRepository {
  List<Customer> customerList = new ArrayList<Customer>();
  private static final Logger logger = LogManager.getLogger(CustomerRepository.class);

  @PostConstruct
  public void init() {
    Customer c1 = new Customer(1, "frank");
    Customer c2 = new Customer(2, "john");
    customerList.add(c1);
    logger.debug("Added Customer : {}", () -> c1);
    customerList.add(c2);
    logger.debug("Added Customer : {}", () -> c2);
  }

  public List<Customer> getData() {
    return customerList;
  }
}

本文底部提供了完整的源代码。

现在，让我们运行 Spring Boot 应用程序：

$ mvn install spring-boot:run

通过检查日志文件夹，log4j Appender 创建了文件“application.log”：

tail -f logs/application.log  2020-08-16 18:15:52,643 INFO c.e.d.DemoApplicationTests [main] No active profile set, falling back to default profiles: default 2020-08-16 18:15:53,354 DEBUG c.e.d.CustomerRepository [main] Added Customer : Customer{id=1, name='frank'} 2020-08-16 18:15:53,359 DEBUG c.e.d.CustomerRepository [main] Added Customer : Customer{id=2, name='john'} 2020-08-16 18:15:54,067 INFO c.e.d.DemoApplicationTests [main] Started DemoApplicationTests in 1.731 seconds (JVM running for 3.383) 2020-08-16 18:15:56,957 INFO c.e.d.DemoApplication [main] Starting DemoApplication on fedora with PID 16738 (/home/francesco/git/masterspringboot/log/demo-log4j2/target/classes started by francesco in /home/francesco/git/masterspringboot/log/demo-log4j2)

配置特定的Log4j2版本

在我们目前介绍的示例中，我们使用了 spring-boot-starter-log4j2 来构建我们的应用程序。为了严格控制我们在应用程序中部署的 Log4j2 版本，建议使用 Log4j2 BOM，如果您在 Log4j2 下使用多个组件，这也是最佳选择 伞。为此，请将要在应用程序中使用的 log4j-bom 的特定版本添加到您的 pom.xml：

<dependencyManagement> 	<dependencies> 		<dependency> 			<groupId>org.apache.logging.log4j</groupId> 			<artifactId>log4j-bom</artifactId> 			<version>2.13.3</version> 			<scope>import</scope> 			<type>pom</type> 		</dependency> 	</dependencies> </dependencyManagement>

然后，在您的应用程序中添加所需的 API：

<dependency> 	<groupId>org.apache.logging.log4j</groupId> 	<artifactId>log4j-api</artifactId> </dependency> <dependency> 	<groupId>org.apache.logging.log4j</groupId> 	<artifactId>log4j-core</artifactId> </dependency>

使用 RollingFile 附加程序

RollingFileAppender 是一个 OutputStreamAppender，它写入 fileName 参数中指定的 File，并根据 TriggeringPolicy 和 RolloverPolicy 滚动文件。

让我们看一个示例配置：

<Configuration status="WARN" monitorInterval="30">     <Properties>         <Property name="LOG_PATTERN">%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %p %m%n</Property>        </Properties>     <Appenders>         <Console name="Console" target="SYSTEM_OUT" follow="true">             <PatternLayout pattern="${LOG_PATTERN}" />         </Console>           <RollingFile name="LogToFile"             fileName="logs/application.log"             filePattern="logs/application-%d{yyyy-MM-dd}-%i.log">             <PatternLayout pattern="${LOG_PATTERN}" />             <Policies>               <TimeBasedTriggeringPolicy />               <SizeBasedTriggeringPolicy size="100 MB"/>             </Policies>             <DefaultRolloverStrategy max="1" />         </RollingFile>       </Appenders>     <Loggers>           <Logger name="com.example.demolog4j2" additivity="false">             <AppenderRef ref="LogToFile" />             <AppenderRef ref="Console" />         </Logger>           <Root level="debug">             <AppenderRef ref="Console" />         </Root>     </Loggers> </Configuration>

上面的 log4j2.xml 文件将在同一天（1-7）创建最多 7 个存档，以根据当前年份和月份存储在日志目录中，并使用 gzip 压缩每个存档。

将 Loggers 配置为异步

为了使所有记录器异步，Log4j-2.9 和更高版本需要 **disruptor-3.3.4.jar 或更高版本的类路径。在 Log4j-2.9 之前，需要disruptor-3.0.0.jar 或更高版本。

因此，我们将添加到我们的 pom.xml 文件中：

<?xml version="1.0" encoding="UTF-8"?><project>
   <dependency>
           
      <groupId>com.lmax</groupId>
           
      <artifactId>disruptor</artifactId>
           
      <version>3.4.2</version>
       
   </dependency>
    
</project>

要激活异步日志记录，我们还必须将系统属性 log4j2.contextSelector 设置为 org.apache.logging.log4j.core.async.AsyncLoggerContextSelector：

mvn clean install  -Dlog4j2.contextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector spring-boot:run

从 Spring Boot 日志中，您可以验证 AsyncContext 是否已激活，因此现在日志正在异步运行：

2020-08-16 19:42:06,978 main DEBUG Registering MBean org.apache.logging.log4j2:type=AsyncContext@4b85612c 2020-08-16 19:42:06,979 main DEBUG Registering MBean org.apache.logging.log4j2:type=AsyncContext@4b85612c,component=AsyncLoggerRingBuffer 2020-08-16 19:42:06,979 main DEBUG Registering MBean org.apache.logging.log4j2:type=AsyncContext@4b85612c,component=StatusLogger 2020-08-16 19:42:06,980 main DEBUG Registering MBean org.apache.logging.log4j2:type=AsyncContext@4b85612c,component=ContextSelector 2020-08-16 19:42:06,982 main DEBUG Registering MBean org.apache.logging.log4j2:type=AsyncContext@4b85612c,component=Loggers,name=org.springframework.boot 2020-08-16 19:42:06,983 main DEBUG Registering MBean org.apache.logging.log4j2:type=AsyncContext@4b85612c,component=Loggers,name= 2020-08-16 19:42:06,984 main DEBUG Registering MBean org.apache.logging.log4j2:type=AsyncContext@4b85612c,component=Loggers,name=com.example.demolog4j2 2020-08-16 19:42:06,984 main DEBUG Registering MBean org.apache.logging.log4j2:type=AsyncContext@4b85612c,component=Appenders,name=LogToConsole 2020-08-16 19:42:06,985 main DEBUG Registering MBean org.apache.logging.log4j2:type=AsyncContext@4b85612c,component=Appenders,name=LogToFile

本教程的源代码：https://github.com/fmarchioni/masterspringboot/tree/master/log/demo-log4j2

参考资料：https://logging.apache.org/log4j/2.0/index.html