Java中使用Logback生成JSON格式日志失败求助

问题背景 #

在Java项目中配置Logback生成JSON格式日志，参考配置了logback.xml，但执行clean-install构建时出现布局兼容警告，最终日志未转为JSON格式。

原配置内容：

<configuration>
    <appender name="json" class="ch.qos.logback.core.ConsoleAppender">
    <layout class="ch.qos.logback.contrib.json.classic.JsonLayout">
        <jsonFormatter
            class="ch.qos.logback.contrib.jackson.JacksonJsonFormatter">
            <prettyPrint>true</prettyPrint>
        </jsonFormatter>
        <timestampFormat>yyyy-MM-dd' 'HH:mm:ss.SSS</timestampFormat>
    </layout>
</appender>

<logger name="jsonLogger" level="TRACE">
    <appender-ref ref="json" />
</logger>
</configuration>

构建时日志显示关键警告：

15:02:23,591 |-WARN in ch.qos.logback.core.ConsoleAppender[json] - This appender no longer admits a layout as a sub-component, set an encoder instead.
15:02:23,591 |-WARN in ch.qos.logback.core.ConsoleAppender[json] - To ensure compatibility, wrapping your layout in LayoutWrappingEncoder.

问题原因 #

1. Logback版本兼容问题：新版ConsoleAppender不再支持直接嵌套Layout，必须使用Encoder。虽然Logback会自动兼容包装，但可能导致JSON布局未正常生效。
2. Logger未正确关联：代码中可能未使用配置中指定的jsonLogger，而是使用了默认RootLogger或其他Logger名称。
3. 配置文件优先级：构建日志显示加载的是logback-test.xml，若该文件配置与logback.xml不一致，会覆盖预期配置。

解决方案 #

1. 修正Logback配置，改用Encoder包装JsonLayout #

将原配置中的直接嵌套Layout改为用LayoutWrappingEncoder包装，符合新版Logback要求：

<configuration>
    <appender name="json" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
            <layout class="ch.qos.logback.contrib.json.classic.JsonLayout">
                <jsonFormatter class="ch.qos.logback.contrib.jackson.JacksonJsonFormatter">
                    <prettyPrint>true</prettyPrint>
                </jsonFormatter>
                <timestampFormat>yyyy-MM-dd' 'HH:mm:ss.SSS</timestampFormat>
                <!-- 可选：添加更多日志字段，提升可读性 -->
                <includeThreadName>true</includeThreadName>
                <includeLevel>true</includeLevel>
                <includeLoggerName>true</includeLoggerName>
            </layout>
        </encoder>
    </appender>

    <!-- 保持指定Logger关联JSON Appender -->
    <logger name="jsonLogger" level="TRACE">
        <appender-ref ref="json" />
    </logger>

    <!-- 可选：若需全局日志输出JSON，添加RootLogger配置 -->
    <!--
    <root level="INFO">
        <appender-ref ref="json" />
    </root>
    -->
</configuration>

2. 确保代码中使用正确的Logger #

在业务代码中，必须获取名称为jsonLogger的Logger实例：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class DemoService {
    private static final Logger logger = LoggerFactory.getLogger("jsonLogger");

    public void execute() {
        logger.info("业务操作执行，日志将以JSON格式输出");
        logger.debug("调试信息，仅TRACE级别可见");
    }
}

3. 统一配置文件优先级 #

• 若不需要logback-test.xml，直接删除该文件，确保系统加载logback.xml。
• 若保留logback-test.xml，需将上述修正后的配置同步到该文件中。

验证步骤 #

1. 执行mvn clean install，确认构建日志中不再出现Layout相关警告。
2. 运行项目，触发日志输出，检查控制台是否显示格式化后的JSON日志。

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