transmittable-thread-local 使用记录

thread如何存储

threadlocal 无法在子线程中传递。InheritableThreadLocal 可以在子线程中传递
Thread 类的属性中存在两个map,也即是每个线程对象中都存在这两个map,
threadLocal.threadLocals的key为 theadlocal
inheritableThreadLocals的key 为InheritableThreadLocal

threadLocal.ThreadLocalMap threadLocals
ThreadLocal.ThreadLocalMap inheritableThreadLocals

InheritableThreadLocal 如何传递到子线程中

// 创建线程的主线程
Thread parent = currentThread();
// 如果父线程的inheritableThreadLocals 不为null 则把父线程的inheritableThreadLocals 传递到本线程
if (inheritThreadLocals && parent.inheritableThreadLocals != null)
    this.inheritableThreadLocals =
        ThreadLocal.createInheritedMap(parent.inheritableThreadLocals);



private ThreadLocalMap(ThreadLocalMap parentMap) {
    Entry[] parentTable = parentMap.table;
    int len = parentTable.length;
    setThreshold(len);
    table = new Entry[len];

    for (int j = 0; j < len; j++) {
        Entry e = parentTable[j];
        if (e != null) {
            @SuppressWarnings("unchecked")
            ThreadLocal<Object> key = (ThreadLocal<Object>) e.get();
            if (key != null) {
                // inheritableThreadLocals childValue()方法获取值 并赋予子线程
                Object value = key.childValue(e.value);
                Entry c = new Entry(key, value);
                int h = key.threadLocalHashCode & (len - 1);
                while (table[h] != null)
                    h = nextIndex(h, len);
                table[h] = c;
             size++;
            }
        }
    }
}

InheritableThreadLocal.java
// 缺省返回父线程的引用
protected T childValue(T parentValue) {
    return parentValue;
}

我们知道java 参数传递都是值传递，如果我们通过InheritableThreadLocal 线程传递的是个可变对象，比如Map<String,Object> 可能会存在线程安全问题

transmittable-thread-local 使用的线上问题

transmittable-thread-local 是阿里开源的基于InheritableThreadLocal 的增强，可以在线程池中传递ThreadLocal对象。
下面的场景是使用Map<String,Object> 类型 transmittable-thread-local 出现的线程安全问题。
我们的业务大概是这样的，前端点击导出后，后端开启异步线程导出，请求立刻返回导出中，异步线程中会获取操作人的一些信息，这些信息是在前置的loginFilter中设置的。
每次请求进来时会重新设置 threadlocal的值，put更新hashMap中的键值对。所以异步的导出线程获取的操作人的信息可能是下一个请求的用户信息，导致了业务异常。

LoginContext.java
private static TransmittableThreadLocal<Map<String, Object>> transmitContext =
        TransmittableThreadLocal.withInitial(HashMap::new);

// LoginFilter.java
LoginContext.put(LoginContext.USER_ID, userId);
@Override
public Object put(String key, Object value) {
    return transmitContext.get().put(key,value);
}

当然这主要是因为对InheritableThreadLocal transmittable-thread-local 的使用手册没有认真了解。下面引用的 transmittable-thread-local的 user guide
意思也是如上描述，因为默认的值传递，没有做深拷贝，会出现线程安全问题。

TransmittableThreadLocal继承InheritableThreadLocal，使用方式也类似。相比InheritableThreadLocal，添加了protected的transmitteeValue()方法，用于定制 任务提交给线程池时 的ThreadLocal值传递到 任务执行时 的传递方式，缺省是简单的赋值传递。注意：如果传递的对象（引用类型）会被修改，且没有做深拷贝（如直接传递引用或是浅拷贝），那么
因为跨线程传递而不再有线程封闭，传递对象在多个线程之间是有共享的。
与JDK的InheritableThreadLocal.childValue()一样，需要使用者/业务逻辑注意保证传递对象的线程安全。

如何解决

我们的业务场景是不希望复用主线程的transmittable-thread-local值改变异步线程的值。
解决方法也比较简单，只需要改写transmitteeValue的默认实现，对transmittable-thread-local值做一次深拷贝。
这样父线程和子线程使用不同的对象。不存在线程安全问题。如下

private static TransmittableThreadLocal<Map<String, Object>> transmitContext =
        TransmittableThreadLocal.withInitialAndCopier(HashMap::new, e->{
            String s = JSONObject.toJSONString(e);
            return (Map<String,Object>) JSONObject.parseObject(s,Map.class);
        });