TransmittableThreadLocal会不会有内存泄漏的风险？

[yexuerui]

• 声明的TransmittableThreadLocal一般为静态变量；
• 或者在Spring的bean中声明（单例模式）。

TransmittableThreadLocal一直被强引用持有。

那么 holder即使设计的为InheritableThreadLocal<WeakHashMap<TransmittableThreadLocal<Object>, ?>>，
若不在子线程显式调用remove()方法，也不会被GC回收吧。

[oldratlee]

……
那么 holder即使设计的为InheritableThreadLocal<WeakHashMap<TransmittableThreadLocal<Object>, ?>>，
若不在子线程显式调用remove()方法，也不会被GC回收吧。

简单地说：不显式调用remove()方法，不被GC回收，是正确的功能。

如果 不调用remove()/重新set()，ThreadLocal持有的对象被GC回收， 则是Bug。 @yexuerui
（无故消失，不能正确持有！）

……
TransmittableThreadLocal一直被强引用持有

TransmittableThreadLocal是否强引用一直持有（即如作为static字段）由业务需求决定。

对于ThreadLocal（含InheritableThreadLocal 、TransmittableThreadLocal），
一般场景、绝大多数场景下，static的方式是合理的；
具体需要 使用方 根据业务场景来分析来决定使用方式。

PS

与 下面的Issue 类似/重复：

• 如何保证资源被清理，不会内存泄漏？ #160
• 是否会由上下文传递过程引入内存泄漏 #140 (comment)
• 是否有内存泄露的风险? #96 (comment)

---

关于内存泄漏

任何持有内存的字段或功能，都会有内存泄漏的风险；需要注意正确使用。

TransmittableThreadLocal功能本身没有内存泄漏的问题。 @yexuerui
即 TransmittableThreadLocal在正确使用的前提下，业务逻辑不会内存泄漏。

相关Issue

• TransmittableThreadLocal 是否线程安全 #175

[oldratlee]

@yexuerui 有涉及出现内存泄漏、具体业务场景下碰到的实际问题吗？

• 上面我泛泛讨论内存泄漏，可能不方便有体感。
• 对于你分析与理解内存泄漏也会比较困难。 😁

[yexuerui]

因为TransmittableThreadLocal继承的是InheritableThreadLocal，

• 在某个线程池第一次创建线程的时候，执行Thread的init方法，完成的数据的跨线程传递。
  (即子线程的InheritableThreadLocal的inheritableThreadLocals会存储值)
• 而holder也是InheritableThreadLocal变量，在子线程创建时，执行init方法。子线程的holder也会继承父线程的值。

前提：

1. 线程池的线程第一次被创建；
2. 在创建子线程前，主线程中调用了TransmittableThreadLocal的set方法；
3. 主线程结束后，调用remove方法；
4. 请求再次进来，调用同一个线程池，发现子线程的InheritableThreadLocal依旧存在步骤2存入的值。

代码验证

local/t4的dubug效果：

也就是在第一次创建Thread时，会有些对象无法回收。

那么上述，如何清除泄漏的对象呢？

---

我理解TransmittableThreadLocal：

在restoreTtlValues方法中，会清除子线程设置的holder和TransmittableThreadLocal值（用户无需调用remove方法），
但是我想问的是，在线程第一次创建的holder如何被清除？

---

我个人理解，普通线程池（非ForkJoinPool），且不是CallerRunsPolicy拒绝策略。
子线程调用remove()方法，父线程的TransmittableThreadLocal不会被remove吧？

[oldratlee]

1. 关于 Inheritable能力/功能 （即创建Thread时的上下文传递）引发的问题

……
4. 请求再次进来，调用同一个线程池，发现子线程的InheritableThreadLocal依旧存在步骤2存入的值。

……

也就是在第一次创建Thread时，会有些对象无法回收。
那么上述，如何清除泄漏的对象呢？

……

但是我想问的是，在线程第一次创建的holder如何被清除？

上面你讨论的是：
Inheritable能力/功能 （即创建Thread时的上下文传递）引发的问题。

解决方法 参见 #279 (comment) ： @yexuerui

TTL提供了 关闭 Inheritable能力的解法：
（可能要理解一下 这个解法及其背景原因，有些复杂性。 😄 ）

• 参见TransmittableThreadLocal主类的 javadoc 说明：
  https://alibaba.github.io/transmittable-thread-local/apidocs/2.12.6/com/alibaba/ttl/TransmittableThreadLocal.html
  
• 对于线程池 TTL提供的DisableInheritable 支持
  https://alibaba.github.io/transmittable-thread-local/apidocs/2.12.6/com/alibaba/ttl/threadpool/DisableInheritableThreadFactory.html
• disable Inheritable when it's not necessary and buggy(eg. has potential memory leaking problem) #100
  这个Issue中解释了 为什么要做关闭Inheritable能力的原因（即你关注到的问题）

2. 关于Remove的时机

我个人理解，普通线程池（非ForkJoinPool），且不是CallerRunsPolicy拒绝策略。
子线程调用remove()方法，父线程的TransmittableThreadLocal不会被remove吧？

子线程remove/set操作不应该影响父线程。更进一步表述：

• ThreadLocal值在不同线程之间是独立的（这其实是ThreadLocal的定义和命名）。
  • 即 更新操作 不会影响 别的线程的ThreadLocal值，这是正确的功能。
• 在约定的时机会 传递。
  • 这样的传递时机，作为功能 命名成如 Inheritable、Transmittable。
  • 更多关于『传递时机』的讨论参见
    如何实现完成线程传递后的初始化操作 #383 (comment)

---

线程池 且拒绝策略 CallerRunsPolicy 也会 做remove。 @yexuerui
（remove说成restore，是更合理、严谨的设计）。

『也会 做remove』原因 简单说明：
CRR操作的上下文的恢复（restore）操作是在try-finally的finally中完成的。

更多的说明参见下面的内容：

文档 怎么设计一个『上下文传递流程』方案保证上下文的生命周期的正确性：

本质原因是：ThreadLocal的set/remove的上下文传递模式 在使用线程池等异步执行组件的情况下不再是有效的。常见的典型例子：

……

怎么设计一个『上下文传递流程』方案（即上下文的生命周期），以保证没有上面的问题？

期望：上下文生命周期的操作从业务逻辑中分离出来。业务逻辑不涉及生命周期，就不会有业务代码如疏忽清理而引发的问题了。整个上下文的传递流程或说生命周期可以规范化成：捕捉、回放和恢复这3个操作，即CRR(capture/replay/restore)模式。

……

相关文档与Issue：

• 文档 怎么设计一个『上下文传递流程』方案保证上下文的生命周期的正确性：
  
• 文档 所有TTL值的抓取、回放和恢复方法（即CRR操作）
• 能在详细讲解一下replay、restore的设计理念吗？没有思考明白，为什么还需要有恢复步骤 #201