logback-test.xml配置文件模板

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!--设置logback输出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    <!-- 在程序的开发测试阶段,可以调整level的级别,常用级别优先级为: -->
    <!-- TRACE < DEBUG < INFO < WARN < ERROR  -->
    <!--
    下面的设置可以让mybatis打印sql语句,已经sql执行过程
    与mybatis一起开发时建议使用
    注意,这里设置之后,在mybatis的全局设置文件中,还需要添加一句
    <settings>
        ......
        <setting name="logImpl" value="STDOUT_LOGGING"/>
        ......
    </settings>
    -->
    <logger name="com.ibatis" level="DEBUG"/>
    <logger name="com.ibatis.common.jdbc.SimpleDataSource" level="DEBUG"/>
    <logger name="com.ibatis.common.jdbc.ScriptRunner" level="DEBUG"/>
    <logger name="com.ibatis.sqlmap.engine.impl.SqlMapClientDelegate" level="DEBUG"/>
    <logger name="java.sql.Connection" level="DEBUG"/>
    <logger name="java.sql.Statement" level="DEBUG"/>
    <logger name="java.sql.PreparedStatement" level="DEBUG"/>
    <logger name="java.sql.ResultSet" level="DEBUG"/>
    <!--这里最关键,设置你的dao层所在包即可-->
    <logger name="com.xxx.xxx.dao" level="DEBUG"/>
    <!--设置文件保存日志-->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
            <charset>utf-8</charset>
        </encoder>
        <!--文件路径,这里设置的是工程根目录下的log目录下-->
        <file>log/output.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <fileNamePattern>log/output.log.%i</fileNamePattern>
        </rollingPolicy>
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>1MB</MaxFileSize>
        </triggeringPolicy>
    </appender>

    <root level="INFO">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE"/>
    </root>
</configuration>
<think>嗯,用户之前已经问过如何在Spring Boot中使用Logback和线程池时,通过TransmittableThreadLocal优化MDC的logid传递。现在他们的问题更具体了,需要直接通过MDC获取值,并在logback.xml中使用%mdc{logid}来获取。可能用户在实际操作中发现原有的方法无法直接使用MDC的API或者logback的%mdc占位符无法获取到值,所以需要进一步调整。 首先,我需要回顾一下之前的解决方案。之前是创建了一个自定义的TtlMDCAdapter,使用TransmittableThreadLocal来存储logid,并替换了拦截器中的MDC操作。但Logback默认的MDC实现是基于ThreadLocal的,用户现在希望直接用MDC.get("logid"),并且在logback配置中用%mdc{logid},这意味着需要将自定义的TtlMDCAdapter与Logback的MDC集成起来,可能需要覆盖默认的MDCAdapter。 接下来,我需要考虑如何让Logback使用自定义的MDC实现。查一下Logback的文档,发现MDCAdapter是一个可以替换的组件。用户需要实现自己的MDCAdapter,并在Logback配置中通过<contextListener>来设置,这样Logback在初始化时会使用自定义的适配器。 然后,用户提到的%mdc{logid}在logback.xml中使用,这需要确保MDC中的值能被Logback的原生支持获取到。因此,自定义的MDCAdapter必须实现Logback的MDCAdapter接口,这样%mdc才会生效。原来的TtlMDCAdapter可能没有实现这个接口,导致无法被Logback识别。 所以,步骤应该是: 1. 创建一个自定义的MDCAdapter类,继承自Logback的MDCAdapter,并使用TransmittableThreadLocal作为存储。 2.Logback配置中添加一个上下文监听器,替换默认的MDCAdapter为自定义的实现。 3. 确保线程池被正确包装,使用TTL的装饰器。 4. 在代码中使用MDC.put("logid", value)而不是之前的TtlMDCAdapter,这样可以直接通过MDC获取。 同时,需要检查依赖是否正确引入,尤其是TransmittableThreadLocal的版本。另外,需要注意在初始化Logback之前替换MDCAdapter,可能需要通过配置文件或者Spring的配置来实现。 用户可能遇到的问题包括:配置不正确导致自定义MDCAdapter未生效,或者线程池未正确包装导致上下文未传递。需要确保所有步骤都被正确执行,例如在logback.xml中添加监听器,以及使用TtlExecutors包装线程池。 总结来说,解决方案的核心是将自定义的MDCAdapter注册到Logback,并确保线程池被TTL装饰,这样MDC的值就能跨线程传递,同时Logback的%mdc也能正确获取到值。</think>--- 在 Spring Boot 中结合 Logback 使用线程池时,若需要直接通过 `MDC.get("logid")` 获取值,并在 `logback.xml` 中使用 `%mdc{logid}` 格式提取,需通过以下步骤实现 `TransmittableThreadLocal` 对原生 `MDC` 的适配: --- ### 一、核心思路 1. **原生 MDC 的局限性** Logback 的 `MDC` 默认基于 `ThreadLocal`,无法在子线程中透传上下文。 2. **TTL 的增强作用** 使用 `TransmittableThreadLocal` 替代原生 `ThreadLocal`,并重写 `MDCAdapter` 实现跨线程透传。 3. **Logback 配置适配** 在 `logback.xml` 中直接使用 `%mdc{logid}` 提取值,需确保底层 `MDC` 实现已支持透传。 --- ### 二、实现步骤 #### 步骤1:引入依赖 ```xml <!-- Maven 依赖 --> <dependency> <groupId>com.alibaba</groupId> <artifactId>transmittable-thread-local</artifactId> <version>2.14.2</version> </dependency> ``` #### 步骤2:自定义 MDCAdapter 实现 Logback 的 `MDCAdapter` 接口,底层使用 `TransmittableThreadLocal`: ```java import ch.qos.logback.classic.util.LogbackMDCAdapter; import com.alibaba.ttl.TransmittableThreadLocal; import org.slf4j.spi.MDCAdapter; import java.util.Collections; import java.util.HashMap; import java.util.Map; public class TtlMDCAdapter implements MDCAdapter { private final ThreadLocal<Map<String, String>> context = new TransmittableThreadLocal<Map<String, String>>() { @Override protected Map<String, String> initialValue() { return new HashMap<>(); } @Override public Map<String, String> copy(Map<String, String> parentValue) { return parentValue != null ? new HashMap<>(parentValue) : null; } }; @Override public void put(String key, String val) { context.get().put(key, val); } @Override public String get(String key) { return context.get().get(key); } @Override public void remove(String key) { context.get().remove(key); } @Override public void clear() { context.get().clear(); context.remove(); } @Override public Map<String, String> getCopyOfContextMap() { return new HashMap<>(context.get()); } @Override public void setContextMap(Map<String, String> contextMap) { context.set(new HashMap<>(contextMap)); } } ``` #### 步骤3:替换 Logback 默认 MDCAdapter 在 `logback-spring.xml` 中添加监听器,强制替换 MDC 实现: ```xml <configuration> <!-- 关键:替换 MDCAdapter --> <contextListener class="ch.qos.logback.classic.selector.ContextJNDISelector"> <supplementalConfiguration> <replaceMDCAdapter class="your.package.TtlMDCAdapter" /> </supplementalConfiguration> </contextListener> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <!-- 直接使用 %mdc{logid} --> <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %mdc{logid} - %msg%n</pattern> </encoder> </appender> <root level="INFO"> <appender-ref ref="STDOUT" /> </root> </configuration> ``` #### 步骤4:包装线程池 确保线程池被 `TtlExecutors` 装饰: ```java @Configuration public class ThreadPoolConfig { @Bean public ExecutorService asyncExecutor() { ExecutorService executor = Executors.newCachedThreadPool(); return TtlExecutors.getTtlExecutorService(executor); // TTL 装饰 } } ``` #### 步骤5:使用原生 MDC API 在代码中直接使用 `MDC.put()` 和 `MDC.get()`: ```java @Slf4j @Component public class LogInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) { String logId = UUID.randomUUID().toString(); MDC.put("logid", logId); // 直接使用原生 MDC API log.info("Request started"); return true; } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) { MDC.clear(); // 清理上下文 } } ``` --- ### 三、验证与测试 #### 1. 控制器验证跨线程取值 ```java @RestController public class TestController { @Autowired private ExecutorService asyncExecutor; // 注入 TTL 装饰后的线程池 @GetMapping("/test") public String test() { log.info("Main thread logid: {}", MDC.get("logid")); // 主线程取值 asyncExecutor.execute(() -> { // 子线程中通过 MDC.get("logid") 直接获取 log.info("Sub thread logid: {}", MDC.get("logid")); }); return "OK"; } } ``` #### 2. 预期输出 ```plaintext 2023-10-05 14:30:00 [http-nio-8080-exec-1] INFO abc123 - Main thread logid: abc123 2023-10-05 14:30:00 [pool-1-thread-1] INFO abc123 - Sub thread logid: abc123 ``` --- ### 四、关键问题排查 1. **MDC 取值为空** - 检查是否漏掉线程池的 `TtlExecutors` 包装。 - 确保 `logback.xml` 中的 `contextListener` 配置正确。 2. **日志模式不生效** - 确认 `logback.xml` 的 `<pattern>` 中使用了 `%mdc{logid}`。 - 检查自定义 `TtlMDCAdapter` 是否完整实现 `MDCAdapter` 接口。 3. **内存泄漏风险** - 在拦截器、过滤器等入口/出口处调用 `MDC.clear()`。 - 避免在异步任务中手动修改 `MDC` 后未清理。 --- ### 五、扩展优化 1. **与 SLF4J 兼容** 通过实现 `MDCAdapter` 接口,确保所有 SLF4J 门面 API(如 `LoggerFactory`)均可直接操作 `MDC`。 2. **性能监控** 通过 `Micrometer` 监控 TTL 的上下文复制耗时,确保额外开销在可接受范围内。 --- 通过上述实现,既保留了 `MDC` 原生 API 的简洁性(直接使用 `MDC.put()/get()`),又通过 `TransmittableThreadLocal` 解决了线程池场景下的上下文透传问题,最终在日志模板中可直接使用 `%mdc{logid}` 输出全链路追踪标识。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

国服酱紫牙

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值