如何以编程方式配置Log4j 2.x的日志输出编码？

我之前也纠结过这个问题——Log4j2的编程式配置里，编码这块确实不像XML/YAML配置那么直观，不过亲测有几种靠谱的方法能搞定：

1. 针对ConsoleAppender设置编码 #

如果是直接用代码构建控制台输出附加器，只需要在构建器里调用setCharset()方法指定你需要的编码就行，比如UTF-8：

// 构建ConsoleAppender实例
ConsoleAppender consoleAppender = ConsoleAppender.newBuilder()
    .setName("ConsoleLogger")
    .setLayout(PatternLayout.newBuilder()
        .withPattern("%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n")
        .build())
    .setCharset(Charset.forName("UTF-8")) // 这里指定输出编码
    .build();

// 将附加器添加到日志配置中
LoggerContext context = (LoggerContext) LogManager.getContext(false);
Configuration config = context.getConfiguration();
config.addAppender(consoleAppender);

// 关联到根日志器
AppenderRef appenderRef = AppenderRef.createAppenderRef("ConsoleLogger", null, null);
LoggerConfig rootConfig = LoggerConfig.createLogger(
    false, Level.INFO, "root", "true", new AppenderRef[]{appenderRef}, 
    null, config, null);
rootConfig.addAppender(consoleAppender, null, null);
config.addLogger("root", rootConfig);
context.updateLoggers(config);

2. 针对FileAppender/RollingFileAppender设置编码 #

文件类的附加器配置逻辑和控制台的一致，同样在构建器里设置字符集就行，比如输出到文件用UTF-8编码：

FileAppender fileAppender = FileAppender.newBuilder()
    .setName("FileLogger")
    .setFileName("application.log")
    .setLayout(PatternLayout.newBuilder()
        .withPattern("%d{yyyy-MM-dd HH:mm:ss} [%t] %-5level %logger - %msg%n")
        .build())
    .setCharset(StandardCharsets.UTF_8) // 也可以用StandardCharsets里的常量
    .build();

// 后续添加到配置、关联日志器的步骤和上面控制台的代码一致

3. 自定义Configuration实现全局编码配置 #

如果你的项目需要统一配置所有附加器的编码，可以自定义一个Configuration类，在里面统一处理：

public class GlobalLogConfig extends DefaultConfiguration {
    public GlobalLogConfig() {
        super();
        // 配置控制台附加器
        ConsoleAppender consoleAppender = ConsoleAppender.newBuilder()
            .setName("GlobalConsole")
            .setLayout(createDefaultLayout())
            .setCharset(Charset.forName("UTF-8"))
            .build();
        addAppender(consoleAppender);

        // 配置文件附加器
        FileAppender fileAppender = FileAppender.newBuilder()
            .setName("GlobalFile")
            .setFileName("global.log")
            .setLayout(createDefaultLayout())
            .setCharset(Charset.forName("UTF-8"))
            .build();
        addAppender(fileAppender);

        // 关联到根日志器
        LoggerConfig rootLogger = getRootLogger();
        rootLogger.addAppender(consoleAppender, Level.INFO, null);
        rootLogger.addAppender(fileAppender, Level.INFO, null);
    }
}

然后需要一个对应的ConfigurationFactory来加载这个配置：

public class GlobalConfigFactory extends ConfigurationFactory {
    @Override
    public Configuration getConfiguration(LoggerContext loggerContext, ConfigurationSource source) {
        return new GlobalLogConfig();
    }

    @Override
    public Configuration getConfiguration(LoggerContext loggerContext, String name, URI configLocation) {
        return new GlobalLogConfig();
    }

    @Override
    protected String[] getSupportedTypes() {
        return new String[]{"*"};
    }
}

最后在项目启动时指定这个工厂类：

System.setProperty("log4j.configurationFactory", "com.yourpackage.GlobalConfigFactory");

几个注意点 #

• 一定要确保指定的编码是当前系统支持的，比如UTF-8、GBK，不然会抛出UnsupportedCharsetException
• 如果是Web应用，建议在上下文初始化阶段执行这些配置代码，避免Log4j2先加载默认配置
• 大部分附加器（比如RollingFileAppender）都支持setCharset()方法，配置逻辑通用

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