Slf4j MDC如何保持键值对的日志输出顺序固定一致

你在代码中按如下方式操作MDC打印日志：

MDC.put("userid", 1);
MDC.put("email", "abc@com");
Logger.info("log statement");

出现键值对输出顺序随机的问题，本质是MDC默认采用HashMap作为存储容器，HashMap本身不保证遍历顺序，所以输出时键值对的排列会随机变动。有两种成熟可行的方案可以固定输出顺序：

方案1：日志配置显式指定MDC键输出顺序（推荐，成本最低） #

不要使用%X/%mdc这类全量遍历输出所有MDC键值对的占位符，直接在日志格式配置里按你需要的顺序显式指定要输出的MDC键，输出顺序会完全和配置顺序一致，和MDC内部存储结构无关。
以Logback配置为例：

<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
        <!-- 固定先输出userid，再输出email，永远不会出现顺序颠倒 -->
        <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - userid=%X{userid}, email=%X{email} %msg%n</pattern>
    </encoder>
</appender>

这个方案零代码侵入，稳定性最高，适合MDC键集合固定的场景。

方案2：自定义MDC适配器替换内部存储为有序Map #

如果你的MDC键是动态增减的，没法提前在日志配置里写死固定顺序，可以替换日志框架默认的MDC适配器，把内部存储键值对的容器从HashMap替换为LinkedHashMap——LinkedHashMap会严格按照键值对的插入顺序做遍历，就能保证你调用MDC.put()的顺序和最终日志输出的顺序完全一致。
实现逻辑参考：

• 针对Logback：继承默认的LogbackMDCAdapter，重写内部创建存储Map、读写属性的相关方法，将Map实例化为LinkedHashMap，随后在日志配置中指定使用你自定义的适配器类即可。
• 针对Log4j2 2.17+版本：框架本身已经提供了对应配置开关，无需自行编码实现，直接在配置中开启MDC有序存储选项即可。

注意：不建议直接修改日志框架的源码来替换Map实现，后续升级日志框架版本时会出现兼容问题，优先使用框架预留的扩展点做自定义实现。

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