Add Inbound Channel Adapter for MQTT based on hivemq by mjd507 · Pull Request #10989 · spring-projects/spring-integration

mjd507 · 2026-05-06T03:59:08Z

Related to: #3102

To avoid constructor explosion, only MqttClientBuilder or MqttClientManager are designed as input params for building the adapters.

The MqttClientManager requires a MqttClientBuilder as well.

When build the underlying MqttClient, the config from the input MqttClientBuilder will be cloned to avoid global side effect.

mjd507 · 2026-05-12T08:17:14Z

here is the PR in my own repo for outbound v3/v5 adapters (mjd507#1).
I will modify and raise it once the inbound review completed.

artembilan · 2026-08-12T15:15:36Z

@cppwfs ,

this is no rush: for the next milestone or so.
Not for just planned release next week.

Thanks

Related to: spring-projects#3102 To avoid constructor explosion, only `MqttClientBuilder` or `MqttClientManager` are designed as input params for building the adapters. The `MqttClientManager` requires a `MqttClientBuilder` as well. When build the underlying `MqttClient`, the config from the input `MqttClientBuilder` will be cloned to avoid global side effect. Signed-off-by: Jiandong Ma <jiandong.ma.cn@gmail.com>

Signed-off-by: Jiandong Ma <jiandong.ma.cn@gmail.com>

…into hivemq-mqtt

Signed-off-by: Jiandong Ma <jiandong.ma.cn@gmail.com>

cppwfs

Thank you so much for this great contribution! We look forward to your updates for the requested changes!

…into hivemq-mqtt Signed-off-by: Jiandong Ma <jiandong.ma.cn@gmail.com> # Conflicts: # gradle/libs.versions.toml

… the mqttClient. - catch a RuntimeException around `sendMessage`, in case failure happens on Netty I/O thread. - change root package from `org` to `com` - use `Mosquitto` for faster startup time. - add `this` prefix for member fields usage - docs and tests improvement Signed-off-by: Jiandong Ma <jiandong.ma.cn@gmail.com>

- remove try-catch around `sendMessage` Signed-off-by: Jiandong Ma <jiandong.ma.cn@gmail.com>

cppwfs

This is great. Just a couple more changes.

Thank you for your work on this!

…into hivemq-mqtt

…ient - rename HiveMQ related classes, variables to MQTT. Signed-off-by: Jiandong Ma <jiandong.ma.cn@gmail.com>

cppwfs

Wow great work. A couple of things I noticed. Please verify and or resolve. Thank you!

cppwfs · 2026-09-16T11:44:29Z

+
+	@Override
+	public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
+		Assert.notNull(applicationEventPublisher, "'applicationEventPublisher' cannot be null");


We don't need to check for null. Nullify handles this for us.

cppwfs · 2026-09-16T13:39:28Z

+				.useMqttVersion3()
+				.willPublish(mqttClientConfig.getWillPublish().orElse(null))
+				.simpleAuth(mqttClientConfig.getSimpleAuth().orElse(null))
 				.addConnectedListener(Mqtt3ClientManager.this)


We can use just this. instead of Mqtt3clientManager.this

cppwfs · 2026-09-16T13:41:25Z

+				// so have to skip appending this in the new built disconnectedListener list
+				.automaticReconnect(inputConfig.getAutomaticReconnect().orElse(null));
+
+		if (!CollectionUtils.isEmpty(inputConfig.getConnectedListeners())) {


This check is redundant.

cppwfs · 2026-09-16T13:41:42Z

+				builder = builder.addConnectedListener(connectedListener);
+			}
+		}
+		if (!CollectionUtils.isEmpty(inputConfig.getDisconnectedListeners())) {


This check is redundant.

cppwfs · 2026-09-16T13:43:27Z

-			.withExposedPorts(HIVEMQ_PORT)
+			.withExposedPorts(MQTT_PORT)
 			.withNetwork(ToxiproxyContainerTest.NETWORK)
 			.withNetworkAliases("hivemq-broker");


Oops missed this one , we can use mqtt-broker.

cppwfs · 2026-09-16T14:08:37Z

-	protected AbstractMqttClientManager(B mqttClientBuilder) {
-		this.mqttClientBuilder = mqttClientBuilder;
+	@SuppressWarnings("this-escape")
+	protected AbstractMqttClientManager(C mqttClientConfig) {


AbstractMqttClientManager.java:69-78 — the constructor calls the overridable buildClient(...), and both implementations pass this as a MqttClientConnectedListener (Mqtt3ClientManager.java:51, Mqtt5ClientManager.java:216). This publishes a partially constructed object: this is registered as a live callback and subclass fields are still uninitialized.

A potential fix is to have each leaf construct the client and pass it up via super(config, client) so no overridable call happens during construction.

renechoi

Built the branch locally (Mosquitto 2.1.2).

No doStop(). After adapter.stop() (isRunning() false) a publish still reached the output channel: the HiveMQ callback stays subscribed. Both Paho adapters stop delivery (MqttPahoMessageDrivenChannelAdapter:220, Mqttv5PahoMessageDrivenChannelAdapter:319) and manage a resubscribe flag; isSubscribed needs the same.
The four com.hivemq.client.internal imports have public equivalents on 1.4.0: Mqtt3Connect/Mqtt5Connect/Mqtt5Disconnect.builder().build() equal the internal DEFAULTs, and Mqtt5Subscription.DEFAULT_* match.

mjd507 force-pushed the hivemq-mqtt branch from cf036ff to 6a9b475 Compare May 6, 2026 07:46

mjd507 commented May 6, 2026

View reviewed changes

Comment thread ...n-mqtt-client/src/test/java/com/springframework/integration/mqtt/client/HiveMQContainer.java Outdated

mjd507 force-pushed the hivemq-mqtt branch 2 times, most recently from 8ed760f to 6d981ef Compare May 8, 2026 01:09

artembilan requested changes May 19, 2026

View reviewed changes

Comment thread build.gradle Outdated

mjd507 marked this pull request as draft August 7, 2026 01:13

artembilan requested a review from cppwfs August 12, 2026 15:14

mjd507 force-pushed the hivemq-mqtt branch from 6d981ef to a7c81c3 Compare August 15, 2026 22:26

mjd507 marked this pull request as ready for review August 15, 2026 22:39

mjd507 force-pushed the hivemq-mqtt branch from a7c81c3 to 2ce7398 Compare August 16, 2026 09:03

mjd507 added 4 commits August 18, 2026 16:37

include toxiproxy for auto reconnect testing.

d193eaa

Signed-off-by: Jiandong Ma <jiandong.ma.cn@gmail.com>

Suppress this-escape warning

ff98b7c

Signed-off-by: Jiandong Ma <jiandong.ma.cn@gmail.com>

Merge branch 'main' of github.com:spring-projects/spring-integration …

4d4f4b0

…into hivemq-mqtt

Add Tests for ClientManager

ecc6952

Signed-off-by: Jiandong Ma <jiandong.ma.cn@gmail.com>

cppwfs requested changes Sep 11, 2026

View reviewed changes

mjd507 added 3 commits September 14, 2026 11:19

Merge branch 'main' of github.com:spring-projects/spring-integration …

9d9f75e

…into hivemq-mqtt Signed-off-by: Jiandong Ma <jiandong.ma.cn@gmail.com> # Conflicts: # gradle/libs.versions.toml

- remove MqttClientConnectedListener and its callback in adapters.

0105279

- remove try-catch around `sendMessage` Signed-off-by: Jiandong Ma <jiandong.ma.cn@gmail.com>

mjd507 requested review from artembilan and cppwfs September 15, 2026 05:06

cppwfs requested changes Sep 15, 2026

View reviewed changes

mjd507 added 2 commits September 16, 2026 09:13

Merge branch 'main' of github.com:spring-projects/spring-integration …

c1e065d

…into hivemq-mqtt

- the ClientManager now uses MqttClientConfig to build the mqttCl…

c499d9d

…ient - rename HiveMQ related classes, variables to MQTT. Signed-off-by: Jiandong Ma <jiandong.ma.cn@gmail.com>

mjd507 requested a review from cppwfs September 16, 2026 09:12

cppwfs requested changes Sep 16, 2026

View reviewed changes

renechoi reviewed Sep 16, 2026

View reviewed changes

Uh oh!

Conversation

mjd507 commented May 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

mjd507 commented May 12, 2026

Uh oh!

Uh oh!

artembilan commented Aug 12, 2026

Uh oh!

cppwfs left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cppwfs left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cppwfs left a comment

Choose a reason for hiding this comment

Uh oh!

cppwfs Sep 16, 2026

Choose a reason for hiding this comment

Uh oh!

cppwfs Sep 16, 2026

Choose a reason for hiding this comment

Uh oh!

cppwfs Sep 16, 2026

Choose a reason for hiding this comment

Uh oh!

cppwfs Sep 16, 2026

Choose a reason for hiding this comment

Uh oh!

cppwfs Sep 16, 2026

Choose a reason for hiding this comment

Uh oh!

cppwfs Sep 16, 2026

Choose a reason for hiding this comment

Uh oh!

renechoi left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mjd507 commented May 6, 2026 •

edited

Loading