Release notes for ApsaraMQ for RocketMQ TCP client SDK for Java - ApsaraMQ for RocketMQ

This topic describes the release notes for the TCP client SDK for Java, including the usage notes, release date, download link, and feature updates for each release. You can choose a version of the SDK for Java that meets your business requirements to send and receive messages based on the description of this topic.

Limits

Java Development Kit (JDK) 1.8 is supported by all versions of the TCP client SDK for Java. JDK 1.6 is supported only by the TCP client SDK for Java V1.8.4.Final and earlier versions. To prevent JDK compatibility issues when you update the SDK version, we recommend that you use JDK V1.8.
You can upgrade your TCP client SDK for Java to V2.x.x.Final 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 your TCP client SDK for Java to V2.x.x.Final in other regions. Otherwise, you cannot use the SDK to connect to ApsaraMQ for RocketMQ.
You can use the TCP client SDK for Java 2.x. x.Final to access ApsaraMQ for RocketMQ only in virtual private clouds (VPCs).
If you use an existing ApsaraMQ for RocketMQ instance and access the instance in the classic network, do not upgrade the TCP client SDK for Java to 2.x.x.Final. Otherwise, you cannot access the ApsaraMQ for RocketMQ instance.
You can use the TCP client SDK for Java 2.x.x.Final to access only instances that contain namespaces. If the instance that you use does not contain a namespace, do not upgrade the TCP client SDK for Java to 2.x.x.Final.
By default, all ApsaraMQ for RocketMQ 5.x instances contain namespaces. If you use an ApsaraMQ for RocketMQ 4.x instance, you can check whether the instance contains a namespace in the Basic Information section of the Instance Details page in the ApsaraMQ for RocketMQ console.
For information about how to obtain a Maven dependency, see Prepare the environment.

2.0.6.Final

Release date

Description

Supported region

Download link

2023-09-28

Fixed issue

Security vulnerabilities in logback and guava are fixed.

This version of SDK is available only in the following regions: China (Hangzhou), China (Qingdao), China (Beijing), China (Zhangjiakou), China (Hohhot), China (Shenzhen), China (Chengdu), Germany (Frankfurt), and Indonesia (Jakarta).

ons-client-2.0.6.Final

2.0.5.Final

Release date

Description

Supported region

Download link

2023-02-23

Optimized feature

Asynchronous logs are added.

Fixed issues

The waiting time for batch consumption cannot be specified.
Some security vulnerabilities are fixed.

ons-client-2.0.5.Final

2.0.3.Final

Release date

Description

Supported region

Download link

2022-08-17

Fixed issue

The number of threads in a thread pool cannot be increased to a value larger than 32 in later JDK versions.

ons-client-2.0.3.Final

2.0.2.Final

Release date

Description

Supported region

Download link

2022-06-16

Fixed issue

A deadlock might be triggered during message sending.

This version of SDK is available only in the following regions:

China (Chengdu)
China (Qingdao)
China (Shenzhen)

ons-client-2.0.2.Final

2.0.1.Final

Release date

Description

Supported region

Download link

2021-11-29

Optimized feature

Data about message traces is added.

This version of SDK is available only in the following regions:

China (Chengdu)
China (Qingdao)
China (Shenzhen)

ons-client-2.0.1.Final

2.0.0.Final

Release date

Description

Supported region

Download link

2021-10-18

Optimized features

Load balancing: Load balancing is performed based on messages. This makes message loads more balanced.
Dashboard: Various metrics are added. The added metrics include the number of accumulated messages and the duration and success rate of each step from message production to message consumption.
Message trace: More parameters are included in trace query results. These parameters are related to scheduled messages, delayed messages, transactional messages, and message consumption.
Ordered messages: The maximum number of retries is changed to 16.
Transactional messages: The logic for handling the errors related to transactional messages is optimized.
Broadcasting consumption: The consumer offset can be customized when you start a consumer.
Push mode: The consumption throttling feature is supported. The processing logic is optimized for scenarios in which the number of consumption threads is abnormal.
Logging configuration: The default log path is changed. Log levels are added. Environment variables are supported.
Client creation: The logic for handling errors is optimized.

Fixed issue

When the updateCredential operation is frequently called, cross-account authorization for Resource Access Management (RAM) roles by using Security Token Service (STS) fails because atomicity is not ensured when the AccessKey ID, AccessKey secret, and STS token are updated.

Note

For more information, see Release notes for the SDK for Java.

This version of SDK is available only in the following regions:

China (Chengdu)
China (Qingdao)
China (Shenzhen)

ons-client-2.0.0.Final

1.9.1.Final

Release date

Description

Download link

2024-07-15

Fixed issue

The version of Guava is updated to 32.1.2-jre, and the security vulnerability CVE-2023-2976 is fixed.

ons-client-1.9.1.Final

1.9.0.Final

Release date

Description

Download link

2024-04-10

Added feature

The namespace parameter is added. This allows you to access serverless ApsaraMQ for RocketMQ 5.0 instances over the Internet.

ons-client-1.9.0.Final

1.8.8.8.Final

Release date

Description

Download link

2023-02-06

Fixed issue

The modifiable configuration item clientCloseSocketIfTimeout is added to quickly close abnormal TCP connections.

ons-client-1.8.8.8.Final

1.8.8.7.Final

Release date

Description

Download link

2023-01-11

Fixed issues

Message traces are lost when multiple messages are consumed at a time.
Some messages fail to be consumed because the maximum wait time is not configured when multiple messages are consumed at a time.

ons-client-1.8.8.7.Final

1.8.8.5.Final

Release date

Description

Download link

2022-05-16

Fixed issue

When the updateCredential operation is frequently called, cross-account authorization for RAM roles by using STS fails because atomicity is not ensured when the AccessKey ID, AccessKey secret, and STS token are updated.

Note

This issue is fixed only in scenarios in which RAM roles are used for authorization. This issue still occurs if you manually update the AccessKey ID, AccessKey secret, and STS token during authorization.

ons-client-1.8.8.5.Final

1.8.8.3.Final

Release date

Description

Download link

2022-01-18

Optimized features

The message that corresponds to a specific consumer offset is skipped due to broker errors.
The unit of the timeout period for message consumption is incorrect.

ons-client-1.8.8.3.Final

1.8.8.1.Final

Release date

Description

Download link

2021-08-24

Optimized features

An error occurs when the system retries to send an ordered message.
Multiple duplicate messages are generated when the client retries to send a message that fails to be consumed in specific scenarios.

ons-client-1.8.8.1.Final

1.8.8.Final

Release date

Description

Download link

2021-04-02

Optimized features

The logic for sending heartbeats is optimized.
The SDK uses an excessive amount of memory.
A message is sent back to the broker if the consumer fails to consume the message.
A topic-specific message cache limit does not take effect.

ons-client-1.8.8.Final

1.8.7.4.Final

Release date

Description

Download link

2021-02-08

Optimized features

The consumption of ordered messages is delayed in specific scenarios.
Ports are occupied for liveness detection on message producers.

ons-client-1.8.7.4.Final

Note

If you use the SDK for Java V1.8.7.1.Final or later to consume ordered messages, we recommend that you update the SDK client to the latest version.

1.8.4.Final

Release date

Description

Download link

2019-09-27

Added features

JDK V1.6 is supported.
The message retry feature is supported for asynchronous sending.
The message retry feature is supported for synchronous sending in scenarios in which brokers are busy.

ons-client-1.8.4.Final

1.7.8.Final

Release date

Description

Download link

2018-07-06

Added feature

STS tokens can be dynamically renewed.

Fixed issues

The default size of a single log file is changed from 1 GB to 64 MB.
Two copies of logs are generated.

ons-client-1.7.8.Final

Earlier versions

1.7.7.Final

Release date

Description

Download link

2018-04-25

Fixed issue

Message traces cannot be sent when multiple consumer or producer instances are initialized in the same process. This issue may occur in V1.7.5 and V1.7.6. We recommend that you update your SDK.

ons-client-1.7.7.Final

1.7.6.Final

Release date

Description

Download link

2018-04-04

Added feature

All log frameworks are supported.

Fixed issues

Apache Log4j2 is supported.
A client is unexpectedly shut down when it fetches name servers.
The Fastjson version is updated to 1.2.48.

ons-client-1.7.6.Final

1.7.5.Final

Release date

Description

Download link

2018-03-23

Fixed issue

Internal dependencies of Alibaba Cloud are used.

ons-client-1.7.5.Final

1.7.4.Final

Release date

Description

Download link

2018-03-02

Added features

Access to ApsaraMQ for RocketMQ by using STS tokens is supported.
Priorities can be assigned for ApsaraMQ for RocketMQ brokers when you send message trace data. By default, the message trace data is preferentially sent to ApsaraMQ for RocketMQ brokers of the current cluster.

Fixed issue

The JDK 1.6 incompatibility issue is fixed.

ons-client-1.7.4.Final

1.7.2.Final

Release date

Description

Download link

2018-01-25

Added features

Encryption at the transport layer is supported for Enterprise Platinum Edition instances. You can encrypt data at the transport layer when you use the AccessKey ID and AccessKey secret to generate a signature. This feature helps improve data security.
SQL attribute filtering is supported for the consumers of Enterprise Platinum Edition instances. This improves the efficiency of message subscription.
The changes in a name server can be automatically detected by the client. This helps you perform O&M activities and switchovers to ensure the high availability of the client.
The version information of a client is reported to the broker in an exact manner when the client initiates a connection request to the broker.

ons-client-1.7.2.Final

1.7.1.Final

Release date

Description

Download link

2017-12-19

Added features

A custom callback thread pool can be configured when you call an API operation to send messages in an asynchronous manner.
The JVM -D parameter Dclient.callback.executor.thread.nums is added to the request parameters of the API operation that sends messages in an asynchronous manner. This parameter is used to manage the number of threads in the public thread pool. For example, you can set this parameter to 10.

Fixed issues

The cache count is not decreased when a message is sent back to the broker due to a consumption timeout.
The asynchronous semaphore of a client is released before the scheduled point in time.

ons-client-1.7.1.Final

1.7.0.Final

Release date

Description

Download link

2017-10-23

Added feature

The cache policy for messages on clients is modified based on the following dimensions: message count and cache size.

Optimized feature

The ProducerName parameter of the built-in tracing module is optimized for the client to allow users to use different values.

Fixed issues

A client trace thread prevents the client from exiting as expected.
The message trace ShutDownHook is created multiple times.

ons-client-1.7.0.Final

1.6.1.Final

Release date

Description

Download link

2017-08-31

Optimized features

Java documentation is provided for all client API operations.
The method that is used to obtain client addresses is optimized. This allows you to obtain client addresses without modifying the hostname configuration in /etc/hosts.

ons-client-1.6.1.Final

1.6.0.Final

Release date

Description

Download link

2017-07-31

Added features

The client is shaded in the source code to ensure correct debugging.
The BornHost and BornTimestamp message attributes can be viewed on the client.
The BatchConsumer operation is added. This operation allows you to consume multiple messages at a time.
The demo for calling the BatchConsumer method is added to consume multiple ordered messages at a time based on Spring settings.

Optimized features

The sharding key is stored in the message structure for partitionally ordered messages.
Integer values are supported for message attribute settings.

ons-client-1.6.0.Final

What to do next

Prepare the environment