Springboot使用log4j2：从入门到精通

作为一名开发工程师，在日常开发中，日志是必不可少的一部分。而在众多的日志框架中，log4j2是一个受欢迎的选择。在Springboot中，集成log4j2也是非常方便的。本文将带你从入门到精通，从多个方面探讨Springboot使用log4j2的相关知识。

一、为什么选择log4j2

在介绍如何使用log4j2之前，让我们先来了解一下为什么要选择log4j2。

首先，log4j2可以很方便地做到日志配置的灵活性。它支持XML、JSON、YAML、Properties等多种方式的配置，可以通过配置文件的方式实现动态配置，而不需要改动代码。

其次，log4j2具有非常高的性能。其支持异步日志记录以及自动缓存机制，可以减少线程阻塞的时间，提高应用程序的响应性。

最后，log4j2还具有丰富的扩展功能。它支持多种日志格式（如JSON、HTML等），可以通过插件实现自定义的日志记录方式。

二、如何使用log4j2

1. 添加依赖

使用log4j2首先需要在项目中添加相关依赖。

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

这个依赖会自动获取最新的log4j2版本，并且与Springboot集成。

2. 配置log4j2

配置log4j2一般需要两个文件：log4j2.xml（或log4j2.yml等）和log4j2.properties。这两个文件可以放在类路径下，或者通过配置指定文件路径。

下面是一个使用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.SSS} [%t] %-5level %logger{36} - %msg%n" />
        </Console>
        <RollingFile name="file" fileName="./logs/app.log"
                     filePattern="./logs/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.log.gz">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="50 MB"/>
            </Policies>
        </RollingFile>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="console" level="info"/>
            <AppenderRef ref="file" level="debug"/>
        </Root>
    </Loggers>
</Configuration>

这个配置定义了两个Appenders（console和file）和一个Root Logger。console将日志输出到控制台，file将日志输出到指定的文件。在Root Logger中，将console和file都设置为了输出对象。

3. 记录日志

使用log4j2记录日志非常简单。只需要在需要记录日志的类中添加一个static final的Logger，并在方法中调用Logger的日志级别方法即可。

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

public class MyService {
    private static final Logger logger = LogManager.getLogger(MyService.class);

    public void myMethod() {
        logger.debug("Entering myMethod");
        // some business logic here
        logger.debug("Leaving myMethod");
    }
}

在记录日志的时候，需要注意使用正确的日志级别。log4j2定义的日志级别从小到大分别为：FATAL、ERROR、WARN、INFO、DEBUG、TRACE、ALL和OFF。只有日志级别不小于Logger的设置级别，才会记录日志。

三、log4j2的高级用法

1. 自定义Appender

除了内置的Appender，log4j2还支持自定义Appender。自定义Appender需要实现org.apache.logging.log4j.core.Appender接口，并在log4j2的配置文件中声明。

import org.apache.logging.log4j.core.Appender;
import org.apache.logging.log4j.core.Layout;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.config.Configuration;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
import org.apache.logging.log4j.core.config.plugins.PluginElement;
import org.apache.logging.log4j.core.config.plugins.PluginFactory;
import org.apache.logging.log4j.core.layout.PatternLayout;

@Plugin(name = "MyCustomAppender", category = "Core", elementType = "appender", printObject = true)
public class MyCustomAppender implements Appender {
    private final String name;
    private final Layout layout;

    private MyCustomAppender(String name, Layout layout) {
        this.name = name;
        this.layout = layout;
    }

    @PluginFactory
    public static MyCustomAppender createAppender(
            @PluginAttribute("name") String name,
            @PluginElement("Layout") Layout layout) {
        if (name == null) {
            LOGGER.error("No name provided for MyCustomAppender");
            return null;
        }
        if (layout == null) {
            layout = PatternLayout.createDefaultLayout();
        }
        return new MyCustomAppender(name, layout);
    }

    @Override
    public void append(LogEvent event) {
        // do something with the log event
    }

    // other implementation of Appender interface methods
}

在log4j2的配置文件中，需要使用这个Appender：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn">
    <Appenders>
        <MyCustomAppender name="myAppender">
            <!-- specify your own configuration for MyCustomAppender -->
        </MyCustomAppender>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="myAppender" level="info"/>
        </Root>
    </Loggers>
</Configuration>

2. 自定义Layout

类似地，log4j2还支持自定义Layout。自定义Layout需要实现org.apache.logging.log4j.core.Layout接口，并在log4j2的配置文件中声明。

import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.config.Configuration;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginFactory;
import org.apache.logging.log4j.core.layout.AbstractStringLayout;

import java.nio.charset.Charset;

@Plugin(name = "MyCustomLayout", category = "Core", elementType = "layout", printObject = true)
public class MyCustomLayout extends AbstractStringLayout {
    protected MyCustomLayout(Charset charset) {
        super(charset);
    }

    @PluginFactory
    public static MyCustomLayout createLayout(
            Configuration config,
            @PluginAttribute(value = "charset", defaultString = "UTF-8") Charset charset) {
        return new MyCustomLayout(charset);
    }

    @Override
    public String toSerializable(LogEvent event) {
        // format log event as desired
    }
}

在log4j2的配置文件中，也需要使用这个Layout：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn">
    <Appenders>
        <Console name="console" target="SYSTEM_OUT">
            <MyCustomLayout>
                <!-- specify your own format for MyCustomLayout -->
            </MyCustomLayout>
        </Console>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="console" level="info"/>
        </Root>
    </Loggers>
</Configuration>

3. 动态修改日志级别

在生产环境中，经常需要通过修改配置文件来调整应用的日志级别。但是，这种方式需要重新启动应用才能生效，不太灵活。log4j2提供了一种通过Java代码动态修改Logger的日志级别的方式。

import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.core.LoggerContext;
import org.apache.logging.log4j.core.config.Configuration;
import org.apache.logging.log4j.core.config.LoggerConfig;

public class MyService {
    private static final Logger logger = LogManager.getLogger(MyService.class);

    public void dynamicLogLevel(Level level) {
        LoggerContext context = (LoggerContext) LogManager.getContext(false);
        Configuration config = context.getConfiguration();
        LoggerConfig loggerConfig = config.getLoggerConfig(LogManager.ROOT_LOGGER_NAME);
        loggerConfig.setLevel(level);
        context.updateLoggers();
        logger.info("Dynamic log level set to " + level);
    }
}

在这个示例中，我们获取了LoggerContext和Configuration，并将root Logger的LoggerConfig对象的级别设置为指定的级别。设置完成后，我们需要调用context.updateLoggers()方法，将配置修改生效。最后，我们记录了动态日志级别被设置的信息。

四、总结

本文从log4j2的优劣点入手，详细介绍了在Springboot中使用log4j2的方法。我们介绍了log4j2的基本使用、自定义Appender和Layout、以及动态修改日志级别等高级用法。希望本文能够为大家学习和使用log4j2提供帮助。