日志追踪-TransmittableThreadLocal -源码分析-侵入业务代码形式

• • • 目标
    • 前言
    • 源码分析
    • 侵入式业务代码形式
    • • holder 的设计
      • ttl 设置值
      • ttl 获取值
      • TtlRunnable 实现
      • 核心run 方法
      • • 捕获方法（capture）
        • 重放方法（replay）
        • • 为什么需要在重放中移除不存在快照中的子线程已经存在的ttl
        • 恢复方法（restore）
        • • 为什么需要恢复方法（restore）
    • 特别注意的点
    • • 实现一个线程安全的ttl
    • 其他
    • 总结

• 了解 TransmittableThreadLocal （可传递本地线程）源码

• 了解一些应用场景

  参考：https://github.com/alibaba/transmittable-thread-local 官方源码地址

  从TransmittableThreadLocal使用前调研（源码分析） 推荐分析到位

之前想实现一个分布式链路追踪，考虑一次请求链路的TranceId，spanId 要在整当前微服务下整个方法调用中传递，考虑使用Threadlocal 和 InheritableThreadLocal 来实现存放TranceId和spanId 。但是在线程池的场景下，会复用线程池线程，会出现丢失和污染调用链路的TranceId和spanId。需要解决这个问题，我尝试通过Java agent 的形式去修改java线程池源码的方式，来实现在执行前捕获父线程的threadlocal信息。在之前线程方法时使用。但是,改造点有点多，后来不了了之。

最近看一些日志记录的追踪文章，提到了TransmittableThreadLocal 框架提供了在使用线程池等会池化复用线程的执行组件情况下，提供ThreadLocal值的传递功能，解决异步执行时上下文传递的问题。所以，需要看下这个框架的实现。

官方地址：https://github.com/alibaba/transmittable-thread-local

在官方文档上介绍，使用TTL 有两种形式，

第一种是使用封装好的修饰类， TransmittableThreadLocal 来在线程池中传递上下文，TtlRunnable 和 TtlCallable 来代替java原生的 Runable 和 Callable 。当然也可以使用修饰的线程池

通过工具类com.alibaba.ttl.threadpool.TtlExecutors完成，有下面的方法：
 
getTtlExecutor：修饰接口Executor
getTtlExecutorService：修饰接口ExecutorService
getTtlScheduledExecutorService：修饰接口ScheduledExecutorService

第二种方式是使用java agent 的形式，不入侵业务代码，通过修改字节码的技术，来实现的。第二种方式，放在下一篇描述。

核心源码：com.alibaba.ttl.TransmittableThreadLocal 继承了 InheritableThreadLocal

// 继承于 InheritableThreadLocal
public class TransmittableThreadLocal extends InheritableThreadLocal implements TtlCopier {

声明了一个类变量holder（类变量在当前jvm下，只会存在一个） , 特别注意 holder 是 InheritableThreadLocal 类型， 在我们操作 InheritableThreadLocal 变量时（set 或者 get）是会从当前线程去获取的， holder 的作用存一个线程中所有出家门和口岸的的 TransmittableThreadLocal

特别说明： holder 存放了一个 weakhashmap ，这个map的key为 TransmittableThreadLocal 并且value 为null。

WeakHashMap 修饰弱引用的键，当某个弱键不再被强引用，那么下一次GC ，将会回收弱引用对象，那么弱键对应的键值对，将会被WeakHashMao 移除， 而在这里修饰的弱键，就是 TransmittableThreadLocal。为了防止内存泄露

    private static final InheritableThreadLocal, ?>> holder =
            new InheritableThreadLocal, ?>>() {
                // 重写了 initialValue 方法
                @Override
                protected WeakHashMap, ?> initialValue() {
                    return new WeakHashMap<>();
                }
              // 重写了 childValue 方法
                @Override
                protected WeakHashMap, ?> childValue(WeakHashMap, ?> parentValue) {
                    return new WeakHashMap, Object>(parentValue);
                }
            };

参考：http://events.jianshu.io/p/79650be29e34

来记录某个线程所有的TransmittableThreadLocal对象，线程级别的缓存。

主线程需要将TransmittableThreadLocal传递到子线程，那么主线程如何记录所有的TransmittableThreadLocal？

使用 InheritableThreadLocal 存放了一个WeakHashMap ，其中key 存放的TransmittableThreadLocal，value 默认为null

先看 Ttl 设置一个上下文变量会有哪些步骤

@Override
public final void set(T value) {
    if (!disableIgnoreNullValueSemantics && null == value) {
        // may set null to remove value
        remove();
    } else {
        // 调用父类的set 方法  threadloacl
        super.set(value);
        // 添加当前对象到  holder 持有者
        addThisToHolder();
    }
}
 
    @SuppressWarnings("unchecked")
    private void addThisToHolder() {
        // 不存在该key，就存入，判断当前创建的 TransmittableThreadLocal 实例对象没有被加入，就存入holder
        if (!holder.get().containsKey(this)) {
            holder.get().put((TransmittableThreadLocal