Tomcat9下Spring5.3.18项目web.xml配置双Log4j2实例失败排查

问题根源 #

Log4j2的Log4jServletContextListener和Log4jServletFilter仅会识别固定名称的初始化参数：log4jContextName和log4jConfiguration。你自定义的log4jContextName1、log4jConfiguration1这类带后缀的参数，完全不会被这两个组件读取，导致第二个日志实例的配置根本没生效，甚至可能干扰了第一个实例的上下文初始化流程，最终两个实例都无法正常工作。

正确实现多日志实例的方式 #

不要通过重复配置Listener/Filter来创建多上下文，而是通过Log4j2的API手动初始化第二个独立的LoggerContext：

1. 保留原有主日志实例的配置 #

继续在web.xml中保留第一个日志实例的配置（对应项目主日志）：

<listener>
    <listener-class>org.apache.logging.log4j.web.Log4jServletContextListener</listener-class>
</listener>
<filter>
    <filter-name>log4jServletFilter</filter-name>
    <filter-class>org.apache.logging.log4j.web.Log4jServletFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>log4jServletFilter</filter-name>
    <url-pattern>/*</url-pattern>
    <dispatcher>REQUEST</dispatcher>
    <dispatcher>FORWARD</dispatcher>
    <dispatcher>INCLUDE</dispatcher>
    <dispatcher>ERROR</dispatcher>
</filter-mapping>
<context-param>
    <param-name>log4jContextName</param-name>
    <param-value>PrimaryLogContext</param-value>
</context-param>
<context-param>
    <param-name>log4jConfiguration</param-name>
    <param-value>/WEB-INF/log4j2-primary.xml</param-value>
</context-param>

2. 手动初始化第二个日志实例 #

创建一个Spring初始化Bean，在项目启动时手动初始化第二个独立的LoggerContext：

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.core.LoggerContext;
import org.springframework.stereotype.Component;
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import javax.servlet.ServletContext;
import org.springframework.web.context.ServletContextAware;
import java.io.File;

@Component
public class SecondaryLogInitializer implements ServletContextAware {

    private ServletContext servletContext;
    private LoggerContext secondaryLogContext;

    @Override
    public void setServletContext(ServletContext servletContext) {
        this.servletContext = servletContext;
    }

    @PostConstruct
    public void initSecondaryLog() {
        // 获取第二个日志配置文件的真实路径
        String configPath = servletContext.getRealPath("/WEB-INF/log4j2-secondary.xml");
        File configFile = new File(configPath);
        
        // 创建唯一名称的独立上下文
        secondaryLogContext = new LoggerContext("SecondaryLogContext");
        secondaryLogContext.setConfigLocation(configFile.toURI());
        secondaryLogContext.start();
        
        // 将上下文存入全局容器，方便后续获取
        LogManager.getContext(false).putObject("SecondaryLogContext", secondaryLogContext);
    }

    @PreDestroy
    public void shutdownSecondaryLog() {
        // 项目关闭时手动停止上下文，避免资源泄漏
        if (secondaryLogContext != null && secondaryLogContext.isStarted()) {
            secondaryLogContext.stop();
        }
    }
}

3. 获取第二个实例的Logger #

在需要使用第二个日志的地方，通过上下文名称获取对应的Logger：

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

// 获取第二个日志上下文
LoggerContext secondaryContext = (LoggerContext) LogManager.getContext(false).getObject("SecondaryLogContext");
// 获取该上下文下的Logger
Logger secondaryLogger = secondaryContext.getLogger("SecondaryBusinessLogger");

关键注意事项 #

• 两个LoggerContext必须设置唯一的上下文名称，避免上下文冲突。
• 手动创建的上下文必须在项目关闭时手动停止，防止Tomcat资源泄漏。
• 确保第二个日志配置文件的路径正确，优先使用Web应用的真实路径（通过ServletContext.getRealPath()获取）。

内容的提问来源于stack exchange，提问作者Magitrix Alyxra