Skip to content

Latest commit

 

History

History
526 lines (413 loc) · 44 KB

README-EN.md

File metadata and controls

526 lines (413 loc) · 44 KB
Raw

📌 TransmittableThreadLocal(TTL)

Important

🚧 This branch is TransmittableThreadLocal(TTL) v3, which is in development and has not been released yet.
See issue 432 for the v3 notes, work item list and its progress.

👉 The stable version v2.x currently in use is on branch 2.x.

Fast CI Strong CI Coverage Status JDK support License Javadocs Maven Central GitHub release GitHub Stars GitHub Forks user repos GitHub issues GitHub Contributors GitHub repo size gitpod: Ready to Code

📖 English Documentation | 📖 中文文档

🔧 Functions

👉 TransmittableThreadLocal(TTL): The missing Java™ std lib(simple & 0-dependency) for framework/middleware, provide an enhanced InheritableThreadLocal that transmits values between threads even using thread pooling components. Support Java 6~21.

Class InheritableThreadLocal in JDK can transmit value to child thread from parent thread.

But when use thread pool, thread is cached up and used repeatedly. Transmitting value from parent thread to child thread has no meaning. Application need transmit value from the time task is created to the time task is executed.

If you have problem or question, please submit Issue or play fork and pull request dance.

Note

From TTL v2.13+ upgrade to Java 8. 🚀
If you need Java 6 support, use version 2.12.x Maven Central

🎨 Requirements

The Requirements listed below is also why I sort out TransmittableThreadLocal in my work.

  • Application container or high layer framework transmit information to low layer sdk.
  • Transmit context to logging without application code aware.

👥 User Guide

1. Simple usage

TransmittableThreadLocal<String> context = new TransmittableThreadLocal<>();

// =====================================================

// set in parent thread
context.set("value-set-in-parent");

// =====================================================

// read in child thread, value is "value-set-in-parent"
String value = context.get();

# See the executable demo SimpleDemo.kt with full source code.

This is the function of class InheritableThreadLocal, should use class InheritableThreadLocal instead.

But when use thread pool, thread is cached up and used repeatedly. Transmitting value from parent thread to child thread has no meaning. Application need transmit value from the time task is created to the point task is executed.

The solution is below usage.

2. Transmit value even using thread pool

2.1 Decorate Runnable and Callable

Decorate input Runnable and Callable by TtlRunnable and TtlCallable.

Sample code:

TransmittableThreadLocal<String> context = new TransmittableThreadLocal<>();

// =====================================================

// set in parent thread
context.set("value-set-in-parent");

Runnable task = new RunnableTask();
// extra work, create decorated ttlRunnable object
Runnable ttlRunnable = TtlRunnable.get(task);
executorService.submit(ttlRunnable);

// =====================================================

// read in task, value is "value-set-in-parent"
String value = context.get();

NOTE：
Even when the same Runnable task is submitted to the thread pool multiple times, the decoration operations(ie： TtlRunnable.get(task)) is required for each submission to capture the value of the TransmittableThreadLocal context at submission time; That is, if the same task is submitted next time without reperforming decoration and still using the last TtlRunnable, the submitted task will run in the context of the last captured context. The sample code is as follows:

// first submission
Runnable task = new RunnableTask();
executorService.submit(TtlRunnable.get(task));

// ... some biz logic,
// and modified TransmittableThreadLocal context ...
context.set("value-modified-in-parent");

// next submission
// reperform decoration to transmit the modified TransmittableThreadLocal context
executorService.submit(TtlRunnable.get(task));

Above code show how to dealing with Runnable, Callable is similar:

TransmittableThreadLocal<String> context = new TransmittableThreadLocal<>();

// =====================================================

// set in parent thread
context.set("value-set-in-parent");

Callable call = new CallableTask();
// extra work, create decorated ttlCallable object
Callable ttlCallable = TtlCallable.get(call);
executorService.submit(ttlCallable);

// =====================================================

// read in call, value is "value-set-in-parent"
String value = context.get();

# See the executable demo TtlWrapperDemo.kt with full source code.

2.2 Decorate thread pool

Eliminating the work of Runnable and Callable Decoration every time it is submitted to thread pool. This work can be completed in the thread pool.

Use util class TtlExecutors to decorate thread pool.

Util class TtlExecutors has below methods:

  • getTtlExecutor: decorate interface Executor
  • getTtlExecutorService: decorate interface ExecutorService
  • getTtlScheduledExecutorService: decorate interface ScheduledExecutorService

Sample code:

ExecutorService executorService = ...
// extra work, create decorated executorService object
executorService = TtlExecutors.getTtlExecutorService(executorService);

TransmittableThreadLocal<String> context = new TransmittableThreadLocal<>();

// =====================================================

// set in parent thread
context.set("value-set-in-parent");

Runnable task = new RunnableTask();
Callable call = new CallableTask();
executorService.submit(task);
executorService.submit(call);

// =====================================================

// read in Task or Callable, value is "value-set-in-parent"
String value = context.get();

# See the executable demo TtlExecutorWrapperDemo.kt with full source code.

2.3 Use Java Agent to decorate thread pool implementation class

In this usage, transmittance is transparent(no decoration operation).

Sample code:

// ## 1. upper layer logic of framework ##
TransmittableThreadLocal<String> context = new TransmittableThreadLocal<>();
context.set("value-set-in-parent");

// ## 2. biz logic ##
ExecutorService executorService = Executors.newFixedThreadPool(3);

Runnable task = new RunnableTask();
Callable call = new CallableTask();
executorService.submit(task);
executorService.submit(call);

// ## 3. underlayer logic of framework ##
// read in Task or Callable, value is "value-set-in-parent"
String value = context.get();

# See the executable demo AgentDemo.kt with full source code, run demo by the script scripts/run-agent-demo.sh.

At present, TTL agent has decorated below JDK execution components(aka. thread pool) implementation:

  • java.util.concurrent.ThreadPoolExecutor and java.util.concurrent.ScheduledThreadPoolExecutor
  • java.util.concurrent.ForkJoinTask（corresponding execution component is java.util.concurrent.ForkJoinPool）
    • decoration implementation code is in ForkJoinTtlTransformlet.java, supports since version 2.5.1.
    • NOTE: CompletableFuture and (parallel) Stream introduced in Java 8 is executed through ForkJoinPool underneath, so after supporting ForkJoinPool, TTL also supports CompletableFuture and Stream transparently. 🎉
  • java.util.TimerTask（corresponding execution component is java.util.Timer）
    • decoration implementation code is in TimerTaskTtlTransformlet.java, supports since version 2.7.0.
    • NOTE: Since version 2.11.2 decoration for TimerTask default is enable (because correctness is first concern, not the best practice like "It is not recommended to use TimerTask" :); before version 2.11.1 default is disable.
    • enabled/disable by agent argument ttl.agent.enable.timer.task:
      • -javaagent:path/to/transmittable-thread-local-2.x.y.jar=ttl.agent.enable.timer.task:true
      • -javaagent:path/to/transmittable-thread-local-2.x.y.jar=ttl.agent.enable.timer.task:false
    • more info about TTL agent arguments, see the javadoc of TtlAgent.java.

Add start options on Java command:

  • -javaagent:path/to/transmittable-thread-local-2.x.y.jar

Java command example:

java -javaagent:transmittable-thread-local-2.x.y.jar \
    -cp classes \
    com.alibaba.demo.ttl.agent.AgentDemo

# if changed the TTL jar file name or the TTL version is before 2.6.0,
# should set argument -Xbootclasspath explicitly.
java -javaagent:path/to/ttl-foo-name-changed.jar \
    -Xbootclasspath/a:path/to/ttl-foo-name-changed.jar \
    -cp classes \
    com.alibaba.demo.ttl.agent.AgentDemo

java -javaagent:path/to/transmittable-thread-local-2.5.1.jar \
    -Xbootclasspath/a:path/to/transmittable-thread-local-2.5.1.jar \
    -cp classes \
    com.alibaba.demo.ttl.agent.AgentDemo

Run the script scripts/run-agent-demo.sh to start demo of "Use Java Agent to decorate thread pool implementation class".

NOTE：

  • Because TTL agent modified the JDK std lib classes, make code refer from std lib class to the TTL classes, so the TTL Agent jar must be added to boot classpath.
  • Since v2.6.0, TTL agent jar will auto add self to boot classpath. But you should NOT modify the downloaded TTL jar file name in the maven repo(eg: transmittable-thread-local-2.x.y.jar).
    • if you modified the downloaded TTL jar file name(eg: ttl-foo-name-changed.jar), you must add TTL agent jar to boot classpath manually by java option -Xbootclasspath/a:path/to/ttl-foo-name-changed.jar.

The implementation of auto adding self agent jar to boot classpath use the Boot-Class-Path property of manifest file(META-INF/MANIFEST.MF) in the TTL Java Agent Jar:

Note

Boot-Class-Path

A list of paths to be searched by the bootstrap class loader. Paths represent directories or libraries (commonly referred to as JAR or zip libraries on many platforms). These paths are searched by the bootstrap class loader after the platform specific mechanisms of locating a class have failed. Paths are searched in the order listed.

More info:

🔌 Java API Docs

The current version Java API documentation: https://alibaba.github.io/transmittable-thread-local/apidocs/

🍪 Maven Dependency

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>transmittable-thread-local</artifactId>
    <version>2.14.4</version>
</dependency>

Check available version at maven.org.

🔨 How to compile and build

Compilation/build environment require JDK 8+; Compilation can be performed in the normal way of Maven.

# The project already contains Maven that satisfied the required version, directly run mvnw in the project root directory; there is no need to manually install Maven by yourself.

# Run test case
./mvnw test
# Compile and package
./mvnw package
# Run test case, compile and package, install TTL library to local Maven
./mvnw install

##################################################
# If you use maven installed by yourself, the version requirement: maven 3.3.9+

mvn install

🗿 More Documentation

📚 Related Resources

JDK Core Classes

💗 Who Used

Some open-source projects used TTL:

  • Middleware
    • sofastack/sofa-rpc star
      SOFARPC is a high-performance, high-extensibility, production-level Java RPC framework
    • trpc-group/trpc-java
      A pluggable, high-performance RPC framework written in java
    • tencentmusic/supersonic
      SuperSonic is an out-of-the-box yet highly extensible framework for building ChatBI
    • dromara/hmily star
      Distributed transaction solutions
    • dromara/gobrs-async star
      一款功能强大、配置灵活、带有全链路异常回调、内存优化、异常状态管理于一身的高性能异步编排框架。为企业提供在复杂应用场景下动态任务编排的能力。 针对于复杂场景下，异步线程复杂性、任务依赖性、异常状态难控制性
    • dromara/dynamic-tp star
      Lightweight dynamic threadpool, with monitoring and alarming functions, base on popular config centers (already support Nacos、Apollo、Zookeeper, can be customized through SPI)
    • opengoofy/hippo4j star
      动态线程池框架，附带监控报警功能，支持 JDK、Tomcat、Jetty、Undertow 线程池；Apache RocketMQ、Dubbo、RabbitMQ、Hystrix 消费等线程池。内置两种使用模式：轻量级依赖配置中心以及无中间件依赖版本
    • siaorg/sia-gateway
      microservice route gateway(zuul-plus)
    • huaweicloud/Sermant
      Sermant, a proxyless service mesh solution based on Javaagent
    • ZTO-Express/zms star
      ZTO Message Service
    • lxchinesszz/tomato
      一款专门为SpringBoot项目设计的幂等组件
    • ytyht226/taskflow
      一款轻量、简单易用、可灵活扩展的通用任务编排框架，基于有向无环图(DAG)的方式实现，框架提供了组件复用、同步/异步编排、条件判断、分支选择等能力，可以根据不同的业务场景对任意的业务流程进行编排
    • foldright/cffu
      🦝 Java CompletableFuture Fu, aka. CF-Fu, pronounced "Shifu"; include best practice/traps guide and a tiny sidekick library to improve user experience and reduce misuse.
    • tuya/connector
      The connector framework maps cloud APIs to local APIs based on simple configurations and flexible extension mechanisms
  • Middleware/Data Processing
    • apache/shardingsphere star
      Ecosystem to transform any database into a distributed database system, and enhance it with sharding, elastic scaling, encryption features & more
    • apache/kylin
      A unified and powerful OLAP platform for Hadoop and Cloud.
    • mybatis-flex/mybatis-flex star
      mybatis-flex is an elegant Mybatis Enhancement Framework
    • basicai/xtreme1
      The Next GEN Platform for Multisensory Training Data. #3D annotation, lidar-camera annotation and image annotation tools are supported
    • oceanbase/odc
      An open-source, enterprise-grade database tool for collaborative development
    • sagframe/sagacity-sqltoy
      Java真正智慧的ORM框架
    • dromara/stream-query star
      允许完全摆脱Mapper的mybatis-plus体验；可以使用类似“工具类”这样的静态函数进行数据库操作
    • luo-zhan/Transformer
      Transformer可能是最简单，但最强大的字段转换插件，一个注解搞定任意转换，让开发变得更加丝滑
    • SimonAlong/Neo
      Orm框架：基于ActiveRecord思想开发的至简化且功能很全的Orm框架
    • ppdaicorp/das
      数据库访问框架(data access service)，包括数据库控制台das console，数据库客户端das client和数据库服务端das server三部分
    • didi/ALITA
      a layer-based data analysis tool
    • didi/daedalus
      实现快速创建数据构造流程，数据构造流程的可视化、线上化、持久化、标准化
  • Middleware/Flow engine
  • Middleware/Log
    • dromara/TLog star
      Lightweight distributed log label tracking framework
    • fayechenlong/plumelog star
      一个java分布式日志组件，支持百亿级别
    • minbox-projects/minbox-logging star
      分布式零侵入式、链路式请求日志分析框架。提供Admin端点进行采集日志、分析日志、日志告警通知、服务性能分析等。通过Admin Ui可查看实时链路日志信息、在线业务服务列表
      • minbox-projects/api-boot star
        为接口服务而生的，基于“ SpringBoot”完成扩展和自动配置，内部封装了一系列的开箱即用Starters
    • ofpay/logback-mdc-ttl
      logback扩展，集成transmittable-thread-local支持跨线程池的mdc跟踪
    • oldratlee/log4j2-ttl-thread-context-map
      Log4j2 TTL ThreadContextMap, Log4j2 extension integrated TransmittableThreadLocal to MDC
  • Middleware/Bytecode
  • Business service or platform application
    • OpenBankProject/OBP-API
      An open source RESTful API platform for banks that supports Open Banking, XS2A and PSD2 through access to accounts, transactions, counterparties, payments, entitlements and metadata - plus a host of internal banking and management APIs
    • gz-yami/mall4j star
      电商商城 java电商商城系统 uniapp商城 多用户商城
    • Joolun/JooLun-wx star
      JooLun微信商城
    • HummerRisk/HummerRisk
      云原生安全平台，包括混合云安全治理和容器云安全检测
    • XiaoMi/mone
      Mone以微服务为核心的一站式企业协同研发平台。支持公共云、专有云和混合云多种部署形态；提供从“项目创建->开发->部署->治理->应用观测”端到端的研发全流程服务；通过云原生新技术和研发新模式，打造“双敏”，敏捷研发和敏捷组织，保障小米-中国区高复杂业务、大规模团队的敏捷研发协同，实现多倍效能提升。
    • yangzongzhuan/RuoYi-Cloud star
      基于Spring Boot、Spring Cloud & Alibaba的分布式微服务架构权限管理系统
    • somowhere/albedo star
      基于 Spring Boot 、Spring Security、Mybatis 的RBAC权限管理系统
    • qwdigital/LinkWechat star
      基于企业微信的开源 SCRM 系统，采用主流的 Java 微服务架构，是企业私域流量管理与营销的综合解决方案，助力企业提高客户运营效率，强化营销能力，拓展盈利空间
    • fushengqian/fuint star
      fuint会员营销系统是一套开源的实体店铺会员管理和营销系统
    • hiparker/opsli-boot star
      一款的低代码快速平台，零代码开发，致力于做更简洁的后台管理系统
    • topiam/eiam star
      EIAM（Employee Identity and Access Management Program）企业级开源IAM平台，实现用户全生命周期的管理、统一认证和单点登录、为数字身份安全赋能
    • Newspiral/newspiral-business
      联盟区块链底层平台
  • Tool product
    • ssssssss-team/spider-flow star
      新一代爬虫平台，以图形化方式定义爬虫流程，不写代码即可完成爬虫
    • nekolr/slime
      🍰 一个可视化的爬虫平台
    • Jackson0714/PassJava-Platform
      一款面试刷题的 Spring Cloud 开源系统。零碎时间利用小程序查看常见面试题，夯实Java基础。 该项目可以教会你如何搭建SpringBoot项目，Spring Cloud项目。 采用流行的技术，如 SpringBoot、MyBatis、Redis、 MySql、 MongoDB、 RabbitMQ、Elasticsearch，采用Docker容器化部署
    • martin-chips/DimpleBlog
      基于SpringBoot2搭建的个人博客系统
    • zjcscut/octopus
      长链接压缩为短链接的服务
    • xggz/mqr star
      茉莉QQ机器人（简称MQR），采用mirai的Android协议实现的QQ机器人服务，通过web控制机器人的启停和配置
  • Test solution or tool
    • alibaba/jvm-sandbox-repeater
      A Java server-side recording and playback solution based on JVM-Sandbox, 录制/回放通用解决方案
    • vivo/MoonBox
      Moonbox（月光宝盒）是JVM-Sandbox生态下的，基于jvm-sandbox-repeater重新开发的，一款流量回放平台产品。相较于jvm-sandbox-repeater，Moonbox功能更加丰富、数据可靠性更高，同时便于快速线上部署和使用
    • alibaba/testable-mock
      换种思路写Mock，让单元测试更简单
    • shulieTech/Takin
      measure online environmental performance test for full-links, Especially for microservices
      • shulieTech/LinkAgent
        a Java-based open-source agent designed to collect data and control Functions for Java applications through JVM bytecode, without modifying applications codes
    • alibaba/virtual-environment
      Route isolation with service sharing, 阿里测试环境服务隔离和联调机制的Kubernetes版实现
  • Spring Cloud/Spring Boot microservices framework solution or scaffold
    • YunaiV/ruoyi-vue-pro star
      一套全部开源的企业级的快速开发平台。基于 Spring Boot + MyBatis Plus + Vue & Element 实现的后台管理系统 + 微信小程序，支持 RBAC 动态权限、数据权限、SaaS 多租户、Activiti + Flowable 工作流、三方登录、支付、短信、商城等功能
    • YunaiV/yudao-cloud star
      RuoYi-Vue 全新 Cloud 版本，优化重构所有功能。基于 Spring Cloud Alibaba + MyBatis Plus + Vue & Element 实现的后台管理系统 + 用户小程序，支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能
    • zlt2000/microservices-platform star
      基于SpringBoot2.x、SpringCloud和SpringCloudAlibaba并采用前后端分离的企业级微服务多租户系统架构
    • dromara/lamp-cloud star
      基于Jdk11 + SpringCloud + SpringBoot 的微服务快速开发平台，其中的可配置的SaaS功能尤其闪耀， 具备RBAC功能、网关统一鉴权、Xss防跨站攻击、自动代码生成、多种存储系统、分布式事务、分布式定时任务等多个模块，支持多业务系统并行开发， 支持多服务并行开发，可以作为后端服务的开发脚手架
      • zuihou/lamp-util star
        打造一套兼顾 SpringBoot 和 SpringCloud 项目的公共工具类
    • matevip/matecloud star
      一款基于Spring Cloud Alibaba的微服务架构
    • gavenwangcn/vole
      SpringCloud Micro service business framework
    • liuweijw/fw-cloud-framework star
      基于springcloud全家桶开发分布式框架（支持oauth2认证授权、SSO登录、统一下单、微信公众号服务、Shardingdbc分库分表、常见服务监控、链路监控、异步日志、redis缓存等功能），实现基于Vue全家桶等前后端分离项目工程
    • liuht777/Taroco
      整合Nacos、Spring Cloud Alibaba，提供了一系列starter组件， 同时提供服务治理、服务监控、OAuth2权限认证，支持服务降级/熔断、服务权重
    • mingyang66/spring-parent
      数据库多数据源、Redis多数据源、日志组件、全链路日志追踪、埋点扩展点、Netty、微服务、开发基础框架支持、异常统一处理、返回值、跨域、API路由、监控等
    • budwk/budwk star
      BudWk 原名 NutzWk star，基于国产框架 nutz 及 nutzboot 开发的开源Web基础项目，集权限体系、系统参数、数据字典、站内消息、定时任务、CMS、微信等最常用功能，不庞杂、不面面俱到，使其具有上手容易、开发便捷、扩展灵活等特性，特别适合各类大中小型定制化项目需求
    • yinjihuan/spring-cloud
      《Spring Cloud微服务-全栈技术与案例解析》和《Spring Cloud微服务 入门 实战与进阶》配套源码
    • louyanfeng25/ddd-demo
      《深入浅出DDD》讲解的演示项目，为了能够更好的理解Demo中的分层与逻辑处理，我强烈建议你配合小册来深入了解DDD
    • nageoffer/12306
      12306 铁路购票服务是与大家生活和出行相关的关键系统，包括会员、购票、订单、支付和网关等服务。

more open-source projects used TTL, see user repos

👷 Contributors

  • Jerry Lee <oldratlee at gmail dot com> @oldratlee
  • Yang Fang <snoop.fy at gmail dot com> @driventokill
  • Zava Xu <zava.kid at gmail dot com> @zavakid
  • wuwen <wuwen.55 at aliyun dot com> @wuwen5
  • rybalkinsd <yan.brikl at gmail dot com> @rybalkinsd
  • David Dai <351450944 at qq dot com> @LNAmp
  • Your name here :-)

GitHub Contributors