添加额外字段后Log4j的JsonLayout失效，无日志输出

核心问题 #

你遇到的问题是因为手动创建的Appender和Layout没有调用start()方法，Log4j的核心组件需要启动后才能正常工作。尤其是当你设置additionalFields这类需要额外初始化的属性时，不启动会导致组件处于未激活状态，完全无法输出日志。另外，直接实例化KeyValuePair虽语法合法，但用官方推荐的Builder模式能规避潜在的初始化问题。

修复后的代码 #

import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.core.Logger;
import org.apache.logging.log4j.core.appender.ConsoleAppender;
import org.apache.logging.log4j.core.layout.JsonLayout;
import org.apache.logging.log4j.core.util.KeyValuePair;

public class Try {
    Logger logger;
    Try(){
        // 用Builder规范创建KeyValuePair
        KeyValuePair kv = KeyValuePair.newBuilder()
                .setKey("hip")
                .setValue("hi")
                .build();
        KeyValuePair[] kvs = {kv};

        logger = (Logger) LogManager.getLogger("com.try1");
        logger.setLevel(Level.DEBUG);

        // 构建JsonLayout并启动
        JsonLayout jsonLayout = JsonLayout.newBuilder()
                .setProperties(true)
                .setAdditionalFields(kvs)
                .setComplete(true)
                .build();
        jsonLayout.start();

        // 构建ConsoleAppender并启动
        ConsoleAppender consoleAppender = ConsoleAppender.newBuilder()
                .setName("console.builder1")
                .setLayout(jsonLayout)
                .build();
        consoleAppender.start();

        logger.addAppender(consoleAppender);
    }
    public void debug(String message){
        System.out.println(logger.isEnabled(Level.DEBUG));
        logger.debug(message);
    }
}

关键修复点 #

• 启动组件：所有Log4j核心组件（Layout、Appender）构建完成后必须调用start()方法，否则不会进入可用状态。添加additionalFields后，Layout需要完成额外的初始化逻辑，不启动直接使用会失效。
• 规范创建KeyValuePair：使用官方提供的newBuilder()，能避免因构造函数参数变更导致的兼容性问题，也符合Log4j的设计规范。
• 分离构建步骤：将Layout和Appender的构建与启动操作分开，逻辑更清晰，也便于排查组件状态问题。

额外验证建议 #

• 可以在启动组件后打印jsonLayout.isStarted()和consoleAppender.isStarted()，确认组件是否正常激活。
• 确保使用稳定版Log4j（如2.17.x及以上），旧版本可能存在additionalFields相关的已知bug。

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