Spring Boot项目log4j2.properties无法读取Tomcat context.xml配置属性

根因说明 #

Tomcat的context.xml中<Environment>标签配置的是JNDI上下文属性，不属于操作系统环境变量（对应log4j2的${env:}前缀）也不属于JVM系统属性（对应log4j2的${sys:}前缀），因此之前的写法无法解析。

方案1：直接使用Log4j2 JNDI前缀读取（不推荐，存在安全风险） #

Log4j2 2.17.0及以上版本默认禁用JNDI Lookup，需手动开启后才能读取JNDI属性：

1. 在Tomcat启动参数中添加配置：-Dlog4j2.enableJndiLookup=true
2. 修改log4j2.properties的属性前缀为jndi:：

appender.email.SMTPHost=${jndi:java:comp/env/log4j.smtpHost}
appender.email.From=${jndi:java:comp/env/log4j.emailAddress}

注意：开启JNDI Lookup存在已知安全隐患，生产环境不建议使用。

方案2：JNDI属性转系统属性（推荐，兼容现有配置） #

Log4j2初始化时机早于Spring容器初始化，因此需要在Servlet上下文初始化阶段就把JNDI属性写入JVM系统属性，步骤如下：

1. 编写ServletContextListener实现类，放在Spring Boot扫描路径下：

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.naming.InitialContext;
import javax.naming.NamingException;

public class JndiPropInitListener implements ServletContextListener {
    @Override
    public void contextInitialized(ServletContextEvent sce) {
        try {
            InitialContext initialContext = new InitialContext();
            String smtpHost = (String) initialContext.lookup("java:comp/env/log4j.smtpHost");
            String emailAddr = (String) initialContext.lookup("java:comp/env/log4j.emailAddress");
            // 写入系统属性，log4j2可通过${sys:}前缀读取
            System.setProperty("log4j.smtpHost", smtpHost);
            System.setProperty("log4j.emailAddress", emailAddr);
        } catch (NamingException e) {
            // 可自行补充未找到JNDI属性时的默认值逻辑
            e.printStackTrace();
        }
    }
}

2. 在Spring Boot配置类中注册监听器，设置最高优先级：

import org.springframework.boot.web.servlet.ServletListenerRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class ListenerConfig {
    @Bean
    public ServletListenerRegistrationBean<JndiPropInitListener> jndiListener() {
        ServletListenerRegistrationBean<JndiPropInitListener> registrationBean = new ServletListenerRegistrationBean<>();
        registrationBean.setListener(new JndiPropInitListener());
        registrationBean.setOrder(1); // 最高优先级，确保在log4j2初始化前执行
        return registrationBean;
    }
}

3. 修改log4j2.properties配置，使用${sys:}前缀：

appender.email.SMTPHost=${sys:log4j.smtpHost}
appender.email.From=${sys:log4j.emailAddress}

方案3：使用Spring Boot外部配置（更灵活，无需绑定Tomcat配置） #

如果不需要强制依赖Tomcat的context.xml配置，可以直接用Spring Boot原生的外部配置能力实现SMTP配置动态调整，修改配置无需重新打包：

1. 引入log4j2 Spring适配依赖：

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-spring-boot</artifactId>
</dependency>

2. 将SMTP配置写到application.properties或者外部配置文件中，外部配置可在启动时指定加载路径：

# 可写在内部application.properties，也可写在外部配置文件，启动时指定：java -jar your-app.jar --spring.config.location=/path/to/external/config.properties
log4j.smtpHost=testsmtp
log4j.emailAddress=test@gmail

3. 修改log4j2.properties配置，使用${spring:}前缀读取Spring环境属性：

appender.email.SMTPHost=${spring:log4j.smtpHost}
appender.email.From=${spring:log4j.emailAddress}

内容的提问来源于stack exchange，提问作者Hitesh Kumar