Each release of the TCP client SDK for Java is listed with its date, changes, regional availability, and download link. Use this page to select the right SDK version for your workload and to evaluate upgrades.
Compatibility and restrictions
JDK requirements
All SDK versions support JDK 1.8.
JDK 1.6 is supported only by V1.8.4.Final and earlier. To avoid compatibility issues during upgrades, use JDK 1.8.
V2.x.x.Final restrictions
Before you upgrade to V2.x.x.Final, confirm that all of the following conditions are met:
Region availability: V2.x.x.Final is available only in the following regions: China (Hangzhou), China (Qingdao), China (Beijing), China (Zhangjiakou), China (Hohhot), China (Shenzhen), China (Chengdu), China (Hong Kong), Germany (Frankfurt), and Indonesia (Jakarta). Do not upgrade in other regions.
VPC access only: V2.x.x.Final connects to ApsaraMQ for RocketMQ only through Virtual Private Clouds (VPCs). If your instance uses the classic network, do not upgrade.
Namespace required: V2.x.x.Final works only with instances that contain namespaces. All ApsaraMQ for RocketMQ 5.x instances have namespaces by default. For a 4.x instance, check the Basic Information section on the Instance Details page in the ApsaraMQ for RocketMQ console.
Maven dependency
For Maven coordinates and setup instructions, see Prepare the environment.
V2.x.x releases
These releases are available only in the regions listed for each version. See
2.0.6.Final
Release date: 2023-09-28
Bug fixes:
Fixed security vulnerabilities in logback and Guava.
Regions: China (Hangzhou), China (Qingdao), China (Beijing), China (Zhangjiakou), China (Hohhot), China (Shenzhen), China (Chengdu), Germany (Frankfurt), Indonesia (Jakarta)
Download: ons-client-2.0.6.Final
2.0.5.Final
Release date: 2023-02-23
Features:
Added asynchronous logging.
Bug fixes:
Fixed an issue where the wait time for batch consumption could not be configured.
Fixed miscellaneous security vulnerabilities.
Regions: China (Hangzhou), China (Qingdao), China (Beijing), China (Zhangjiakou), China (Hohhot), China (Shenzhen), China (Chengdu), Germany (Frankfurt), Indonesia (Jakarta)
Download: ons-client-2.0.5.Final
2.0.3.Final
Release date: 2022-08-17
Bug fixes:
Fixed an issue where the thread pool size could not exceed 32 on newer JDK versions.
Regions: China (Hangzhou), China (Qingdao), China (Beijing), China (Zhangjiakou), China (Hohhot), China (Shenzhen), China (Chengdu), Germany (Frankfurt), Indonesia (Jakarta)
Download: ons-client-2.0.3.Final
2.0.2.Final
Release date: 2022-06-16
Bug fixes:
Fixed a potential deadlock during message sending.
Regions: China (Chengdu), China (Qingdao), China (Shenzhen)
Download: ons-client-2.0.2.Final
2.0.1.Final
Release date: 2021-11-29
Features:
Added message trace data.
Regions: China (Chengdu), China (Qingdao), China (Shenzhen)
Download: ons-client-2.0.1.Final
2.0.0.Final
Release date: 2021-10-18
Features:
Load balancing: Switched to message-level balancing for more even distribution across consumers.
Dashboard: Added metrics for accumulated messages, step-level duration, and success rate from production through consumption.
Message trace: Expanded trace query results with parameters for scheduled messages, delayed messages, transactional messages, and consumption details.
Ordered messages: Increased the maximum retry count to 16.
Broadcasting consumption: Enabled custom consumer offsets at consumer startup.
Push mode: Added consumption throttling. Improved processing logic when the consumption thread count is abnormal.
Logging: Changed the default log path. Added log levels. Added environment variable support.
Improvements:
Improved error handling for transactional messages.
Improved error handling during client creation.
Bug fixes:
Fixed a race condition in
updateCredentialwhere frequent calls caused cross-account authorization for Resource Access Management (RAM) roles through Security Token Service (STS) to fail. The root cause was a lack of atomicity when updating the AccessKey ID, AccessKey secret, and STS token.
For more details, see Release notes for the SDK for Java.
Regions: China (Chengdu), China (Qingdao), China (Shenzhen)
Download: ons-client-2.0.0.Final
V1.x.x releases
1.9.1.Final
Release date: 2024-07-15
Bug fixes:
Updated Guava to 32.1.2-jre and fixed security vulnerability CVE-2023-2976.
Download: ons-client-1.9.1.Final
1.9.0.Final
Release date: 2024-04-10
Features:
Added the
namespaceparameter to enable Internet access to serverless ApsaraMQ for RocketMQ 5.0 instances.
Download: ons-client-1.9.0.Final
1.8.8.8.Final
Release date: 2023-02-06
Bug fixes:
Added the
clientCloseSocketIfTimeoutconfiguration option to quickly close abnormal TCP connections.
Download: ons-client-1.8.8.8.Final
1.8.8.7.Final
Release date: 2023-01-11
Bug fixes:
Fixed an issue where message traces were lost during batch consumption.
Fixed an issue where some messages failed to be consumed because the maximum wait time was not configured for batch consumption.
Download: ons-client-1.8.8.7.Final
1.8.8.5.Final
Release date: 2022-05-16
Bug fixes:
Fixed a race condition in
updateCredentialwhere frequent calls caused cross-account authorization for RAM roles through STS to fail due to non-atomic updates of the AccessKey ID, AccessKey secret, and STS token.
This fix applies only to RAM role authorization. If you manually update the AccessKey ID, AccessKey secret, and STS token, the issue still occurs.
Download: ons-client-1.8.8.5.Final
1.8.8.3.Final
Release date: 2022-01-18
Bug fixes:
Fixed an issue where the message at a specific consumer offset was skipped due to broker errors.
Fixed an incorrect time unit for the message consumption timeout.
Download: ons-client-1.8.8.3.Final
1.8.8.1.Final
Release date: 2021-08-24
Bug fixes:
Fixed an error that occurred when retrying ordered message sends.
Fixed an issue where duplicate messages were generated when the client retried a failed consumption in certain scenarios.
Download: ons-client-1.8.8.1.Final
1.8.8.Final
Release date: 2021-04-02
Improvements:
Optimized heartbeat sending logic.
Reduced excessive memory usage.
Bug fixes:
Fixed an issue where messages were incorrectly sent back to the broker on consumer failure.
Fixed an issue where the per-topic message cache limit did not take effect.
Download: ons-client-1.8.8.Final
1.8.7.4.Final
Release date: 2021-02-08
Bug fixes:
Fixed delayed consumption of ordered messages in certain scenarios.
Fixed an issue where ports were occupied for liveness detection on message producers.
If you use V1.8.7.1.Final or later to consume ordered messages, upgrade to the latest version.
Download: ons-client-1.8.7.4.Final
1.8.4.Final
Release date: 2019-09-27
Features:
Added JDK 1.6 support.
Added message retry for asynchronous sends.
Added message retry for synchronous sends when brokers are busy.
Download: ons-client-1.8.4.Final
1.7.8.Final
Release date: 2018-07-06
Features:
Added dynamic renewal of STS tokens.
Improvements:
Reduced the default single log file size from 1 GB to 64 MB.
Bug fixes:
Fixed an issue where duplicate log files were generated.
Download: ons-client-1.7.8.Final