如何让log4j.properties读取环境变量，实现多环境日志格式区分？

我之前也碰到过类似的情况，你用${env:ENVIRONMENT}没生效，导致日志里出现-my-api而不是预期的dev-my-api，大概率是Log4j版本不支持或者环境变量没被正确加载的问题，给你几个靠谱的解决方案：

• 确认Log4j版本是否支持环境变量Lookup
  Log4j 1.x是从1.2.16版本开始支持${env:VAR_NAME}这种环境变量语法的，如果你的版本低于这个，肯定用不了。可以检查一下项目依赖里的log4j版本，升级到1.2.16及以上版本试试。

• 确保环境变量被应用进程正确读取
  有时候不是配置的问题，而是环境变量没传递到应用进程里：

  • 如果是Linux/macOS启动应用，要确保启动前先导出环境变量：

    export ENVIRONMENT=dev
    java -jar your-app.jar
    

  • 如果是Windows系统，先设置环境变量再启动：

    set ENVIRONMENT=dev
    java -jar your-app.jar
    

  • 如果是IDE里运行，要在运行配置的「环境变量」里手动添加ENVIRONMENT=dev，而不是只在系统环境变量里设置。

• 改用系统属性（兼容性更好）
  如果环境变量的方式还是有问题，可以换成JVM系统属性的方式，兼容性更强：

  • 修改log4j.properties配置：

    log4j.rootLogger = INFO, stdout
    log4j.appender.stdout=org.apache.log4j.ConsoleAppender
    log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
    log4j.appender.stdout.layout.ConversionPattern= [%d{yyyy-MM-dd HH:mm:ss}] %ENVIRONMENT-my-api.%-5p: %m%n
    

  • 启动应用时加上JVM参数传递环境值：

    java -DENVIRONMENT=dev -jar your-app.jar
    

• 用MDC（映射诊断上下文）灵活处理
  如果想更灵活地控制（比如给环境变量加默认值），可以用Log4j的MDC功能：

  • 在应用初始化的代码里读取环境变量并放入MDC：

    import org.apache.log4j.MDC;
    
    public class AppStartup {
        public static void main(String[] args) {
            // 读取环境变量，不存在就设默认值为unknown
            String env = System.getenv("ENVIRONMENT");
            MDC.put("ENVIRONMENT", env != null ? env : "unknown");
            
            // 启动应用的其他逻辑
        }
    }
    

  • 修改log4j.properties里的转换模式，用%X{ENVIRONMENT}获取MDC里的值：

    log4j.appender.stdout.layout.ConversionPattern= [%d{yyyy-MM-dd HH:mm:ss}] %X{ENVIRONMENT}-my-api.%-5p: %m%n
    

你之前的日志输出出现-my-api，本质是Log4j没找到ENVIRONMENT这个环境变量，所以把${env:ENVIRONMENT}替换成了空字符串，就出现了前面的横杠。按照上面的方法调整后，应该就能得到预期的日志格式了。

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