Spring Boot应用：如何在Log4j2中获取Spring Profile以命名日志文件

刚好之前在项目里实现过这个需求——在Log4j2里根据Spring激活的Profile给日志文件名加标识。直接在log4j2.xml里写${spring.profiles.active}是拿不到值的，因为Log4j2的初始化时机比Spring环境加载早，给你几个实用的解决方案：

Spring Boot对Log4j2有专门的扩展支持，只要把你的日志配置文件重命名为log4j2-spring.xml，Spring就会先加载完环境变量（包括激活的Profile）再初始化日志系统，这时候${spring.profiles.active}就能正常取值了。

示例配置：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="INFO">
    <Properties>
        <Property name="log-path">c:/logs</Property>
        <!-- 加上默认值`default`，防止没有激活任何Profile时出现空值 -->
        <Property name="targetEnv">${spring.profiles.active:default}</Property>
    </Properties>
    <Appenders>
        <!-- 日志文件名自动带上环境标识 -->
        <RollingFile name="RollingFile" fileName="${log-path}/app-${targetEnv}.log"
                     filePattern="${log-path}/app-${targetEnv}-%d{yyyy-MM-dd}-%i.log.gz">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
            <SizeBasedTriggeringPolicy size="10MB"/>
            <DefaultRolloverStrategy max="10"/>
        </RollingFile>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="RollingFile"/>
        </Root>
    </Loggers>
</Configuration>

如果不想修改配置文件名，可以在启动应用时，把spring.profiles.active同步为Log4j2能识别的系统属性，比如：

java -jar your-app.jar -Dspring.profiles.active=dev -Dlog.targetEnv=dev

然后在log4j2.xml里通过${sys:}前缀读取这个系统属性：

<Properties>
    <Property name="log-path">c:/logs</Property>
    <Property name="targetEnv">${sys:log.targetEnv:default}</Property>
</Properties>

这个方法需要手动保持系统属性和Spring Profile的一致性，适合应急场景，灵活性稍差。

如果需要更灵活地获取Spring环境变量，可以自定义一个Log4j2的Lookup类，直接从Spring上下文读取激活的Profile：

import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.lookup.StrLookup;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component;

@Component
@Plugin(name = "springProfile", category = StrLookup.CATEGORY)
public class SpringProfileLookup implements StrLookup, ApplicationContextAware {

    private static ApplicationContext applicationContext;

    @Override
    public void setApplicationContext(ApplicationContext context) {
        applicationContext = context;
    }

    @Override
    public String lookup(String key) {
        if ("active".equals(key)) {
            // 多Profile激活时用逗号拼接
            return String.join(",", applicationContext.getEnvironment().getActiveProfiles());
        }
        return null;
    }

    @Override
    public String lookup(LogEvent event, String key) {
        return lookup(key);
    }
}

然后在log4j2.xml里用自定义的Lookup获取值：

<Properties>
    <Property name="log-path">c:/logs</Property>
    <Property name="targetEnv">${springProfile:active:default}</Property>
</Properties>

这个方案适合需要扩展更多Spring环境变量读取的场景，但需要额外编写代码。

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