Spring集成Log4j2 - 《Spring框架实战》 - 严富坤的知识库专栏(yanfukun.com)

Log4j2概述
- 什么是Log4j2
- Log4j2的核心组件
Spring集成Log4j2的步骤
Log4j2高级配置
Spring Boot集成Log4j2
优化与调优
常见问题与解决方案
实战案例：Spring Boot项目集成Log4j2
- 项目结构
- 代码实现
总结

日志记录在软件开发中扮演着至关重要的角色。它不仅帮助开发者调试和维护代码，还在应用程序监控和问题诊断中发挥重要作用。Log4j2是Apache基金会开发的一个功能强大且灵活的日志框架。本文将详细介绍如何在Spring框架中集成Log4j2，包括其配置、使用和优化。

Log4j2概述

什么是Log4j2

Log4j2是Log4j的升级版，是一个基于Java的日志记录工具，提供了丰富的日志记录功能和良好的性能。Log4j2的主要特性包括：

异步日志：通过异步日志提高应用程序性能。
插件架构：支持各种自定义插件。
高级过滤机制：通过自定义过滤器实现复杂的日志记录需求。
多种日志输出方式：支持将日志输出到控制台、文件、数据库等。

Log4j2的核心组件

Log4j2由多个核心组件组成：

Logger：记录日志的主体，负责生成日志事件。
Appender：日志输出组件，将日志事件输出到指定的目标，如控制台、文件、数据库等。
Layout：日志格式化组件，定义日志的输出格式。
Filter：日志过滤组件，控制哪些日志事件需要记录。

Spring集成Log4j2的步骤

引入Log4j2依赖

首先，需要在Spring项目中引入Log4j2的依赖。对于使用Maven的项目，可以在pom.xml文件中添加以下依赖：

<dependencies>
    <!-- Spring依赖 -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>5.3.10</version>
    </dependency>
    <!-- Log4j2依赖 -->
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-api</artifactId>
        <version>2.14.1</version>
    </dependency>
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-core</artifactId>
        <version>2.14.1</version>
    </dependency>
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-slf4j-impl</artifactId>
        <version>2.14.1</version>
    </dependency>
</dependencies>

对于使用Gradle的项目，可以在build.gradle文件中添加以下依赖：

dependencies {
    // Spring依赖
    implementation 'org.springframework:spring-context:5.3.10'
    // Log4j2依赖
    implementation 'org.apache.logging.log4j:log4j-api:2.14.1'
    implementation 'org.apache.logging.log4j:log4j-core:2.14.1'
    implementation 'org.apache.logging.log4j:log4j-slf4j-impl:2.14.1'
}

配置Log4j2

Log4j2提供了多种配置方式，包括XML、JSON、YAML和Properties文件。下面以XML配置为例，创建一个log4j2.xml文件，并将其放置在src/main/resources目录下。

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n"/>
        </Console>
        <File name="File" fileName="logs/app.log">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n"/>
        </File>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="Console"/>
            <AppenderRef ref="File"/>
        </Root>
        <Logger name="com.example" level="debug" additivity="false">
            <AppenderRef ref="Console"/>
        </Logger>
    </Loggers>
</Configuration>

在上述配置中，我们定义了两个Appender：一个输出到控制台，一个输出到文件。同时，我们定义了根Logger的日志级别为info，并为com.example包中的类定义了一个debug级别的Logger。

在Spring中使用Log4j2

引入Log4j2依赖并配置完成后，我们可以在Spring项目中使用Log4j2记录日志。可以通过注入Logger对象或使用SLF4J的LoggerFactory来创建Logger实例。

package com.example.service;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.stereotype.Service;
@Service
public class MyService {
    private static final Logger logger = LogManager.getLogger(MyService.class);
    public void performOperation() {
        logger.debug("Debug level log message");
        logger.info("Info level log message");
        logger.error("Error level log message");
    }
}

Log4j2高级配置

异步日志

Log4j2支持异步日志，通过异步日志可以显著提高应用程序的性能。可以在配置文件中使用AsyncAppender来配置异步日志。

<Appenders>
    <Console name="Console" target="SYSTEM_OUT">
        <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n"/>
    </Console>
    <Async name="Async">
        <AppenderRef ref="Console"/>
    </Async>
</Appenders>
<Loggers>
    <Root level="info">
        <AppenderRef ref="Async"/>
    </Root>
</Loggers>

自定义日志格式

Log4j2允许使用自定义的日志格式。可以通过PatternLayout定义日志的输出格式。

<PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} [%t] %-5p %c{2} - %m%n"/>

常用的日志格式占位符包括：

%d：日志事件的时间戳。
%t：线程名称。
%p：日志级别。
%c：日志记录器的名称。
%m：日志消息。
%n：平台依赖的换行符。

使用过滤器

Log4j2提供了多种过滤器，可以在日志记录过程中进行精细控制。常用的过滤器包括ThresholdFilter、RegexFilter、MarkerFilter等。

<Appenders>
    <Console name="Console" target="SYSTEM_OUT">
        <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n"/>
        <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
    </Console>
</Appenders>

在上述配置中，我们使用ThresholdFilter仅记录级别为warn及以上的日志事件。

多环境配置

在实际项目中，通常需要针对不同的环境（如开发、测试、生产）进行不同的日志配置。Log4j2支持通过多个配置文件或配置文件中的环境变量来实现多环境配置。

<Configuration status="WARN">
    <Properties>
        <Property name="log-path">logs/${sys:log-dir}</Property>
    </Properties>
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n"/>
        </Console>
        <File name="File" fileName="${log-path}/app.log">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n"/>
        </File>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="Console"/>
            <AppenderRef ref="File"/>
        </Root>
    </Loggers>
</Configuration>

Spring Boot集成Log4j2

引入Log4j2依赖

Spring Boot项目中集成Log4j2的第一步是引入相关依赖。编辑pom.xml文件，添加如下依赖：

<dependencies>
    <!-- Spring Boot依赖 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
        <version>2.5.5</version>
    </dependency>
    <!-- Log4j2依赖 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-log4j2</artifactId>
        <version>2.5.5</version>
        <exclusions>
            <exclusion>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-logging</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
</dependencies>

配置Log4j2

在Spring Boot项目中，可以在src/main/resources目录下创建log4j2-spring.xml文件进行Log4j2的配置。

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n"/>
        </Console>
        <File name="File" fileName="logs/app.log">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n"/>
        </File>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="Console"/>
            <AppenderRef ref="File"/>
        </Root>
        <Logger name="com.example" level="debug" additivity="false">
            <AppenderRef ref="Console"/>
        </Logger>
    </Loggers>
</Configuration>

使用Log4j2记录日志

在Spring Boot项目中使用Log4j2记录日志，与传统Spring项目的使用方式相同。

package com.example.service;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.stereotype.Service;
@Service
public class MyService {
    private static final Logger logger = LogManager.getLogger(MyService.class);
    public void performOperation() {
        logger.debug("Debug level log message");
        logger.info("Info level log message");
        logger.error("Error level log message");
    }
}

优化与调优

日志级别控制

在日志配置中，合理设置日志级别可以有效控制日志量，从而提高性能。常见的日志级别有TRACE、DEBUG、INFO、WARN、ERROR、FATAL。在生产环境中，建议将日志级别设置为WARN或更高，以减少不必要的日志输出。

<Loggers>
    <Root level="warn">
        <AppenderRef ref="Console"/>
        <AppenderRef ref="File"/>
    </Root>
</Loggers>

日志文件滚动

对于文件日志输出，使用日志文件滚动策略可以有效管理日志文件的大小和数量。Log4j2提供了多种滚动策略，如时间滚动和大小滚动。

<File name="File" fileName="logs/app.log" filePattern="logs/app-%d{yyyy-MM-dd}.log.gz">
    <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n"/>
    <Policies>
        <TimeBasedTriggeringPolicy interval="1" modulate="true"/>
        <SizeBasedTriggeringPolicy size="10MB"/>
    </Policies>
</File>

异步日志优化

异步日志可以显著提高日志记录的性能。在高并发环境下，使用异步日志可以减少日志记录对应用程序性能的影响。

<Appenders>
    <Console name="Console" target="SYSTEM_OUT">
        <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n"/>
    </Console>
    <Async name="Async">
        <AppenderRef ref="Console"/>
    </Async>
</Appenders>
<Loggers>
    <Root level="info">
        <AppenderRef ref="Async"/>
    </Root>
</Loggers>

自定义日志上下文

Log4j2支持MDC（Mapped Diagnostic Context）和NDC（Nested Diagnostic Context），可以在日志记录中添加自定义的上下文信息，便于日志分析和问题定位。

import org.apache.logging.log4j.ThreadContext;
public class MyService {
    private static final Logger logger = LogManager.getLogger(MyService.class);
    public void performOperation() {
        ThreadContext.put("userId", "12345");
        logger.info("User operation performed");
        ThreadContext.clearMap();
    }
}

常见问题与解决方案

日志不输出的问题

如果配置完成后日志不输出，可以检查以下几点：

配置文件位置：确保log4j2.xml或log4j2-spring.xml文件放置在src/main/resources目录下。
依赖冲突：检查项目依赖中是否存在与Log4j2冲突的依赖，如Logback或其他日志框架。
配置正确性：确保配置文件的语法和内容正确。

日志重复输出的问题

日志重复输出通常是由于Logger的additivity属性设置不当引起的。可以通过设置additivity属性为false来避免重复输出。

<Logger name="com.example" level="debug" additivity="false">
    <AppenderRef ref="Console"/>
</Logger>

异步日志性能问题

异步日志可以提高性能，但如果配置不当，可能会导致性能问题或日志丢失。可以通过调整AsyncAppender的配置参数来优化性能，如队列大小和阻塞策略。

<Async name="Async" bufferSize="1024" blocking="true">
    <AppenderRef ref="Console"/>
</Async>

实战案例：Spring Boot项目集成Log4j2

项目结构

假设我们有一个Spring Boot项目，项目结构如下：

src/main/java
    ├── com.example
        ├── config
        │   └── Log4j2Config.java
        ├── controller
        │   └── MyController.java
        ├── service
        │   └── MyService.java
        └── MyApplication.java
src/main/resources
    └── log4j2-spring.xml

代码实现

Log4j2Config.java

package com.example.config;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class Log4j2Config {
    private static final Logger logger = LogManager.getLogger(Log4j2Config.class);
    @Bean
    public void configure() {
        logger.info("Log4j2 configured successfully");
    }
}

MyController.java

package com.example.controller;
import com.example.service.MyService;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class MyController {
    private static final Logger logger = LogManager.getLogger(MyController.class);
    @Autowired
    private MyService myService;
    @GetMapping("/perform")
    public String performOperation() {
        logger.info("Controller: performOperation called");
        myService.performOperation();
        return "Operation performed";
    }
}

MyService.java

package com.example.service;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.stereotype.Service;
@Service
public class MyService {
    private static final Logger logger = LogManager.getLogger(MyService.class);
    public void performOperation() {
        logger.debug("Service: performOperation called");
        logger.info("Service: Performing operation...");
        // 业务逻辑
        logger.info("Service: Operation performed successfully");
    }
}

MyApplication.java

package com.example;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

log4j2-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n"/>
        </Console>
        <File name="File" fileName="logs/app.log">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n"/>
        </File>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="Console"/>
            <AppenderRef ref="File"/>
        </Root>
        <Logger name="com.example" level="debug" additivity="false">
            <AppenderRef ref="Console"/>
        </Logger>
    </Loggers>
</Configuration>

总结

Spring集成Log4j2为应用程序提供了强大的日志记录功能。通过详细介绍Log4j2的核心组件、配置方式以及在Spring和Spring Boot项目中的集成步骤，我们可以轻松地在项目中实现灵活且高效的日志记录。本文还介绍了Log4j2的高级配置和优化技巧，帮助开发者在实际项目中更好地应用Log4j2。希望本文对您在Spring项目中集成Log4j2有所帮助，提高日志管理的效率和质量。