MQTT 支援

Spring Integration 提供了入站和出站通道介面卡來支援訊息佇列遙測傳輸 (MQTT) 協議。

您需要將此依賴項包含到您的專案中

Maven
Gradle

<dependency>
    <groupId>org.springframework.integration</groupId>
    <artifactId>spring-integration-mqtt</artifactId>
    <version>6.4.4</version>
</dependency>

compile "org.springframework.integration:spring-integration-mqtt:6.4.4"

當前實現使用了 Eclipse Paho MQTT 客戶端庫。

XML 配置和本章的大部分內容都關於 MQTT v3.1 協議支援和相應的 Paho 客戶端。有關相應的協議支援，請參閱 MQTT v5 支援段落。

兩個介面卡的配置都是透過使用 DefaultMqttPahoClientFactory 來實現的。有關配置選項的更多資訊，請參閱 Paho 文件。

我們建議配置一個 MqttConnectOptions 物件並將其注入到工廠中，而不是在工廠本身上設定（已棄用的）選項。

入站（訊息驅動）通道介面卡

入站通道介面卡由 MqttPahoMessageDrivenChannelAdapter 實現。為了方便起見，您可以使用名稱空間對其進行配置。一個最小配置可能如下所示

<bean id="clientFactory"
        class="org.springframework.integration.mqtt.core.DefaultMqttPahoClientFactory">
    <property name="connectionOptions">
        <bean class="org.eclipse.paho.client.mqttv3.MqttConnectOptions">
            <property name="userName" value="${mqtt.username}"/>
            <property name="password" value="${mqtt.password}"/>
        </bean>
    </property>
</bean>

<int-mqtt:message-driven-channel-adapter id="mqttInbound"
    client-id="${mqtt.default.client.id}.src"
    url="${mqtt.url}"
    topics="sometopic"
    client-factory="clientFactory"
    channel="output"/>

以下列表顯示了可用屬性

<int-mqtt:message-driven-channel-adapter id="oneTopicAdapter"
    client-id="foo"  (1)
    url="tcp://:1883"  (2)
    topics="bar,baz"  (3)
    qos="1,2"  (4)
    converter="myConverter"  (5)
    client-factory="clientFactory"  (6)
    send-timeout="123"  (7)
    error-channel="errors"  (8)
    recovery-interval="10000"  (9)
    manual-acks="false" (10)
    channel="out" />

1	客戶端 ID。
2	代理 URL。
3	此介面卡接收訊息的主題列表，以逗號分隔。
4	QoS 值列表，以逗號分隔。它可以是應用於所有主題的單個值，也可以是每個主題的值（在這種情況下，列表長度必須相同）。
5	一個可選的 `MqttMessageConverter`。預設情況下，預設的 `DefaultPahoMessageConverter` 生成的訊息其 payload 為 `String`，並帶有以下訊息頭： `mqtt_topic`：接收訊息的主題 `mqtt_duplicate`：如果訊息是重複的，則為 `true` `mqtt_qos`：服務質量。您可以透過將其宣告為 `<bean/>` 並將 `payloadAsBytes` 屬性設定為 `true` 來配置 `DefaultPahoMessageConverter`，使其在 payload 中返回原始的 `byte[]`。
6	客戶端工廠。
7	`send()` 超時時間。僅當通道可能阻塞時（例如當前已滿的有界 `QueueChannel`）才適用。
8	錯誤通道。如果提供了錯誤通道，下游異常將以 `ErrorMessage` 的形式傳送到此通道。Payload 是一個 `MessagingException`，其中包含失敗的訊息和原因。
9	恢復間隔。它控制介面卡在失敗後嘗試重新連線的間隔。預設為 `10000ms`（十秒）。
10	確認模式；設定為 true 表示手動確認。

從 4.1 版本開始，您可以省略 URL。相反，您可以在 DefaultMqttPahoClientFactory 的 serverURIs 屬性中提供伺服器 URI。例如，這樣做可以連線到高可用 (HA) 叢集。

從 4.2.2 版本開始，當介面卡成功訂閱主題時，會發布 MqttSubscribedEvent。當連線或訂閱失敗時，會發布 MqttConnectionFailedEvent 事件。實現 ApplicationListener 的 bean 可以接收這些事件。

此外，一個新的屬性 recoveryInterval 控制介面卡在失敗後嘗試重新連線的間隔。預設為 10000ms（十秒）。

在 4.2.3 版本之前，介面卡停止時客戶端總是取消訂閱。這是不正確的，因為如果客戶端的 QOS 大於 0，我們需要保持訂閱活動狀態，以便介面卡停止時到達的訊息在下次啟動時能夠送達。這還需要將客戶端工廠的 cleanSession 屬性設定為 false。它預設為 true。

從 4.2.3 版本開始，如果 cleanSession 屬性為 false，介面卡預設不會取消訂閱。

可以透過設定工廠的 consumerCloseAction 屬性來覆蓋此行為。它可以有以下值：UNSUBSCRIBE_ALWAYS（總是取消訂閱）、UNSUBSCRIBE_NEVER（從不取消訂閱）和 UNSUBSCRIBE_CLEAN。後者（預設值）僅當 cleanSession 屬性為 true 時才取消訂閱。

要恢復到 4.2.3 版本之前的行為，請使用 UNSUBSCRIBE_ALWAYS。

從 5.0 版本開始，topic、qos 和 retained 屬性被對映到 .RECEIVED_… 訊息頭（MqttHeaders.RECEIVED_TOPIC、MqttHeaders.RECEIVED_QOS 和 MqttHeaders.RECEIVED_RETAINED），以避免意外傳播到預設使用 MqttHeaders.TOPIC、MqttHeaders.QOS 和 MqttHeaders.RETAINED 訊息頭的出站訊息。

執行時新增和移除主題

從 4.1 版本開始，您可以透過程式設計方式更改介面卡訂閱的主題。Spring Integration 提供了 addTopic() 和 removeTopic() 方法。新增主題時，您可以選擇指定 QoS（預設值：1）。您還可以透過向 <control-bus/> 傳送適當的訊息以及適當的 payload 來修改主題——例如："myMqttAdapter.addTopic('foo', 1)"。

停止和啟動介面卡對主題列表沒有影響（它不會恢復到配置中的原始設定）。這些更改不會在應用程式上下文的生命週期結束後保留。新的應用程式上下文會恢復到配置的設定。

在介面卡停止（或與代理斷開連線）期間更改主題，將在下次建立連線時生效。

手動確認 (Acks)

從 5.3 版本開始，您可以將 manualAcks 屬性設定為 true。這通常用於非同步確認送達。設定為 true 時，訊息頭（IntegrationMessageHeaderAccessor.ACKNOWLEDGMENT_CALLBACK）會新增到訊息中，其值為一個 SimpleAcknowledgment。您必須呼叫 acknowledge() 方法來完成送達。有關更多資訊，請參閱 IMqttClient 的 setManualAcks() 和 messageArrivedComplete() 的 Javadocs。為方便起見，提供了訊息頭訪問器。

StaticMessageHeaderAccessor.acknowledgment(someMessage).acknowledge();

從 5.2.11 版本開始，當訊息轉換器丟擲異常或從 MqttMessage 轉換返回 null 時，MqttPahoMessageDrivenChannelAdapter（如果提供了錯誤通道）會將 ErrorMessage 傳送到 errorChannel。否則，它會將此轉換錯誤重新丟擲到 MQTT 客戶端回撥中。

使用 Java 配置進行配置

以下 Spring Boot 應用程式展示瞭如何使用 Java 配置配置入站介面卡示例：

@SpringBootApplication
public class MqttJavaApplication {

    public static void main(String[] args) {
        new SpringApplicationBuilder(MqttJavaApplication.class)
                .web(false)
                .run(args);
    }

    @Bean
    public MessageChannel mqttInputChannel() {
        return new DirectChannel();
    }

    @Bean
    public MessageProducer inbound() {
        MqttPahoMessageDrivenChannelAdapter adapter =
                new MqttPahoMessageDrivenChannelAdapter("tcp://:1883", "testClient",
                                                 "topic1", "topic2");
        adapter.setCompletionTimeout(5000);
        adapter.setConverter(new DefaultPahoMessageConverter());
        adapter.setQos(1);
        adapter.setOutputChannel(mqttInputChannel());
        return adapter;
    }

    @Bean
    @ServiceActivator(inputChannel = "mqttInputChannel")
    public MessageHandler handler() {
        return new MessageHandler() {

            @Override
            public void handleMessage(Message<?> message) throws MessagingException {
                System.out.println(message.getPayload());
            }

        };
    }

}

使用 Java DSL 進行配置

以下 Spring Boot 應用程式提供了使用 Java DSL 配置入站介面卡的示例：

@SpringBootApplication
public class MqttJavaApplication {

    public static void main(String[] args) {
        new SpringApplicationBuilder(MqttJavaApplication.class)
            .web(false)
            .run(args);
    }

    @Bean
    public IntegrationFlow mqttInbound() {
        return IntegrationFlow.from(
                         new MqttPahoMessageDrivenChannelAdapter("tcp://:1883",
                                        "testClient", "topic1", "topic2"))
                .handle(m -> System.out.println(m.getPayload()))
                .get();
    }

}

出站通道介面卡

出站通道介面卡由 MqttPahoMessageHandler 實現，它被包裝在一個 ConsumerEndpoint 中。為了方便起見，您可以使用名稱空間進行配置。

從 4.1 版本開始，介面卡支援非同步傳送操作，避免阻塞直到確認送達。您可以發出應用程式事件，以便應用程式在需要時確認送達。

以下列表顯示了出站通道介面卡的可用屬性：

<int-mqtt:outbound-channel-adapter id="withConverter"
    client-id="foo"  (1)
    url="tcp://:1883"  (2)
    converter="myConverter"  (3)
    client-factory="clientFactory"  (4)
    default-qos="1"  (5)
    qos-expression="" (6)
    default-retained="true"  (7)
    retained-expression="" (8)
    default-topic="bar"  (9)
    topic-expression="" (10)
    async="false"  (11)
    async-events="false"  (12)
    channel="target" />

1	客戶端 ID。
2	代理 URL。
3	一個可選的 `MqttMessageConverter`。預設的 `DefaultPahoMessageConverter` 識別以下訊息頭： `mqtt_topic`：訊息將傳送到的主題 `mqtt_retained`：如果訊息需要保留，則為 `true` `mqtt_qos`：服務質量
4	客戶端工廠。
5	預設的服務質量。如果在 `mqtt_qos` 訊息頭中未找到，或 `qos-expression` 返回 `null` 時使用。如果您提供了自定義的 `converter` 則不使用。
6	用於評估確定 qos 的表示式。預設值為 `headers[mqtt_qos]`。
7	retained 標誌的預設值。如果在 `mqtt_retained` 訊息頭中未找到時使用。如果您提供了自定義的 `converter` 則不使用。
8	用於評估確定 retained 布林值的表示式。預設值為 `headers[mqtt_retained]`。
9	訊息傳送的預設主題（如果在 `mqtt_topic` 訊息頭中未找到時使用）。
10	用於評估確定目標主題的表示式。預設值為 `headers['mqtt_topic']`。
11	當設定為 `true` 時，呼叫者不會阻塞。相反，它會在傳送訊息時等待送達確認。預設值為 `false`（傳送會阻塞直到確認送達）。
12	當 `async` 和 `async-events` 都為 `true` 時，會發出 `MqttMessageSentEvent`（參見事件）。它包含訊息、主題、客戶端庫生成的 `messageId`、`clientId` 以及 `clientInstance`（每次客戶端連線時遞增）。當客戶端庫確認送達時，會發出 `MqttMessageDeliveredEvent`。它包含 `messageId`、`clientId` 和 `clientInstance`，以便將送達與 `send()` 關聯起來。任何 `ApplicationListener` 或事件入站通道介面卡都可以接收這些事件。請注意，`MqttMessageDeliveredEvent` 可能在 `MqttMessageSentEvent` 之前收到。預設值為 `false`。

從 4.1 版本開始，可以省略 URL。相反，可以在 DefaultMqttPahoClientFactory 的 serverURIs 屬性中提供伺服器 URI。例如，這使得連線到高可用 (HA) 叢集成為可能。

使用 Java 配置進行配置

以下 Spring Boot 應用程式展示瞭如何使用 Java 配置配置出站介面卡示例：

@SpringBootApplication
@IntegrationComponentScan
public class MqttJavaApplication {

    public static void main(String[] args) {
        ConfigurableApplicationContext context =
                new SpringApplicationBuilder(MqttJavaApplication.class)
                        .web(false)
                        .run(args);
        MyGateway gateway = context.getBean(MyGateway.class);
        gateway.sendToMqtt("foo");
    }

    @Bean
    public MqttPahoClientFactory mqttClientFactory() {
        DefaultMqttPahoClientFactory factory = new DefaultMqttPahoClientFactory();
        MqttConnectOptions options = new MqttConnectOptions();
        options.setServerURIs(new String[] { "tcp://host1:1883", "tcp://host2:1883" });
        options.setUserName("username");
        options.setPassword("password".toCharArray());
        factory.setConnectionOptions(options);
        return factory;
    }

    @Bean
    @ServiceActivator(inputChannel = "mqttOutboundChannel")
    public MessageHandler mqttOutbound() {
        MqttPahoMessageHandler messageHandler =
                       new MqttPahoMessageHandler("testClient", mqttClientFactory());
        messageHandler.setAsync(true);
        messageHandler.setDefaultTopic("testTopic");
        return messageHandler;
    }

    @Bean
    public MessageChannel mqttOutboundChannel() {
        return new DirectChannel();
    }

    @MessagingGateway(defaultRequestChannel = "mqttOutboundChannel")
    public interface MyGateway {

        void sendToMqtt(String data);

    }

}

使用 Java DSL 進行配置

以下 Spring Boot 應用程式提供了使用 Java DSL 配置出站介面卡的示例：

@SpringBootApplication
public class MqttJavaApplication {

    public static void main(String[] args) {
        new SpringApplicationBuilder(MqttJavaApplication.class)
            .web(false)
            .run(args);
    }

       @Bean
       public IntegrationFlow mqttOutboundFlow() {
           return f -> f.handle(new MqttPahoMessageHandler("tcp://host1:1883", "someMqttClient"));
    }

}

事件

介面卡會發布某些應用程式事件。

MqttConnectionFailedEvent - 如果連線失敗或隨後連線斷開，由兩個介面卡釋出。對於 MQTT v5 Paho 客戶端，當伺服器執行正常斷開連線時也會發出此事件，此時連線斷開的 cause 為 null。
MqttMessageSentEvent - 在非同步模式下執行時，當訊息已傳送時由出站介面卡釋出。
MqttMessageDeliveredEvent - 在非同步模式下執行時，當客戶端指示訊息已送達時由出站介面卡釋出。
MqttMessageNotDeliveredEvent - 在非同步模式下執行時，當客戶端指示訊息未送達時由出站介面卡釋出。
MqttSubscribedEvent - 入站介面卡訂閱主題後釋出。

這些事件可以由 ApplicationListener<MqttIntegrationEvent> 或使用 `@EventListener` 方法接收。

要確定事件的來源，請使用以下方法；您可以檢查 bean 名稱和/或連線選項（以訪問伺服器 URI 等）。

MqttPahoComponent source = event.getSourceAsType();
String beanName = source.getBeanName();
MqttConnectOptions options = source.getConnectionInfo();

MQTT v5 支援

從 5.5.5 版本開始，spring-integration-mqtt 模組提供了針對 MQTT v5 協議的通道介面卡實現。org.eclipse.paho:org.eclipse.paho.mqttv5.client 是一個可選的依賴項，因此必須在目標專案中明確包含它。

由於 MQTT v5 協議支援 MQTT 訊息中的額外任意屬性，因此引入了 MqttHeaderMapper 實現，用於在釋出和接收操作中將訊息頭對映到/從訊息頭對映。預設情況下，（透過 * 模式）它對映所有接收到的 PUBLISH 幀屬性（包括使用者屬性）。在出站側，它為 PUBLISH 幀映射了這些訊息頭子集：contentType、mqtt_messageExpiryInterval、mqtt_responseTopic、mqtt_correlationData。

MQTT v5 協議的出站通道介面卡是 Mqttv5PahoMessageHandler。它需要 clientId 和 MQTT 代理 URL 或 MqttConnectionOptions 引用。它支援 MqttClientPersistence 選項，可以是 async 的，並且在這種情況下可以發出 MqttIntegrationEvent 物件（參見 asyncEvents 選項）。如果請求訊息的 payload 是一個 org.eclipse.paho.mqttv5.common.MqttMessage，它將透過內部的 IMqttAsyncClient 原樣釋出。如果 payload 是 byte[]，它將原樣用於目標 MqttMessage 的 payload 進行釋出。如果 payload 是 String，它將被轉換為 byte[] 進行釋出。其餘的使用場景被委託給提供的 MessageConverter，它是來自應用程式上下文的 IntegrationContextUtils.ARGUMENT_RESOLVER_MESSAGE_CONVERTER_BEAN_NAME ConfigurableCompositeMessageConverter bean。注意：當請求的訊息 payload 已經是 MqttMessage 時，提供的 HeaderMapper<MqttProperties> 不會被使用。以下 Java DSL 配置示例演示瞭如何在整合流中使用此通道介面卡：

@Bean
public IntegrationFlow mqttOutFlow() {
    Mqttv5PahoMessageHandler messageHandler = new Mqttv5PahoMessageHandler(MQTT_URL, "mqttv5SIout");
    MqttHeaderMapper mqttHeaderMapper = new MqttHeaderMapper();
    mqttHeaderMapper.setOutboundHeaderNames("some_user_header", MessageHeaders.CONTENT_TYPE);
    messageHandler.setHeaderMapper(mqttHeaderMapper);
    messageHandler.setAsync(true);
    messageHandler.setAsyncEvents(true);
    messageHandler.setConverter(mqttStringToBytesConverter());

    return f -> f.handle(messageHandler);
}

org.springframework.integration.mqtt.support.MqttMessageConverter 不能與 Mqttv5PahoMessageHandler 一起使用，因為它的契約僅針對 MQTT v3 協議。

如果連線在啟動時或執行時失敗，Mqttv5PahoMessageHandler 會在傳送到此 handler 的下一條訊息時嘗試重新連線。如果此手動重新連線失敗，則連線異常會被拋回給呼叫者。在這種情況下，會應用標準的 Spring Integration 錯誤處理過程，包括請求 handler advices，例如 retry 或 circuit breaker。

有關更多資訊，請參閱 Mqttv5PahoMessageHandler 的 javadocs 及其父類。

MQTT v5 協議的入站通道介面卡是 Mqttv5PahoMessageDrivenChannelAdapter。它需要 clientId 和 MQTT 代理 URL 或 MqttConnectionOptions 引用，以及要訂閱和消費的主題。它支援 MqttClientPersistence 選項，該選項預設是記憶體中的。可以配置預期的 payloadType（預設為 byte[]），它會被傳遞給提供的 SmartMessageConverter，用於從收到的 MqttMessage 的 byte[] 進行轉換。如果設定了 manualAck 選項，則會在訊息中新增 IntegrationMessageHeaderAccessor.ACKNOWLEDGMENT_CALLBACK 訊息頭，其值是 SimpleAcknowledgment 的一個例項。HeaderMapper<MqttProperties> 用於將 PUBLISH 幀屬性（包括使用者屬性）對映到目標訊息頭中。標準的 MqttMessage 屬性，如 qos、id、dup、retained，以及收到的主題，總是被對映到訊息頭中。有關更多資訊，請參見 MqttHeaders。

從 6.3 版本開始，Mqttv5PahoMessageDrivenChannelAdapter 提供了基於 MqttSubscription 的建構函式，用於細粒度配置，而不是簡單的通用主題名稱。當提供了這些訂閱時，通道介面卡的 qos 選項將無法使用，因為這種 qos 模式是 MqttSubscription API 的一部分。

以下 Java DSL 配置示例演示瞭如何在整合流中使用此通道介面卡：

@Bean
public IntegrationFlow mqttInFlow() {
    Mqttv5PahoMessageDrivenChannelAdapter messageProducer =
        new Mqttv5PahoMessageDrivenChannelAdapter(MQTT_URL, "mqttv5SIin", "siTest");
    messageProducer.setPayloadType(String.class);
    messageProducer.setMessageConverter(mqttStringToBytesConverter());
    messageProducer.setManualAcks(true);

    return IntegrationFlow.from(messageProducer)
            .channel(c -> c.queue("fromMqttChannel"))
            .get();
}

org.springframework.integration.mqtt.support.MqttMessageConverter 不能與 Mqttv5PahoMessageDrivenChannelAdapter 一起使用，因為它的契約僅針對 MQTT v3 協議。

有關更多資訊，請參閱 Mqttv5PahoMessageDrivenChannelAdapter 的 javadocs 及其父類。

建議將 MqttConnectionOptions#setAutomaticReconnect(boolean) 設定為 true，以讓內部的 IMqttAsyncClient 例項處理重新連線。否則，只有手動重新啟動 Mqttv5PahoMessageDrivenChannelAdapter 才能處理重新連線，例如透過 MqttConnectionFailedEvent 處理斷開連線。

共享 MQTT 客戶端支援

如果多個整合需要使用單個 MQTT ClientID，則不能使用多個 MQTT 客戶端例項，因為 MQTT 代理可能對每個 ClientID 的連線數量有限制（通常只允許一個連線）。為了讓單個客戶端被不同的通道介面卡重用，可以使用 org.springframework.integration.mqtt.core.ClientManager 元件並將其傳遞給所需的任何通道介面卡。它將管理 MQTT 連線生命週期並在需要時進行自動重新連線。此外，還可以為客戶端管理器提供自定義連線選項和 MqttClientPersistence，就像當前可以為通道介面卡元件所做的那樣。

注意，同時支援 MQTT v5 和 v3 通道介面卡。

以下 Java DSL 配置示例演示瞭如何在整合流中使用此客戶端管理器：

@Bean
public ClientManager<IMqttAsyncClient, MqttConnectionOptions> clientManager() {
    MqttConnectionOptions connectionOptions = new MqttConnectionOptions();
    connectionOptions.setServerURIs(new String[]{ "tcp://:1883" });
    connectionOptions.setConnectionTimeout(30000);
    connectionOptions.setMaxReconnectDelay(1000);
    connectionOptions.setAutomaticReconnect(true);
    Mqttv5ClientManager clientManager = new Mqttv5ClientManager(connectionOptions, "client-manager-client-id-v5");
    clientManager.setPersistence(new MqttDefaultFilePersistence());
    return clientManager;
}

@Bean
public IntegrationFlow mqttInFlowTopic1(
        ClientManager<IMqttAsyncClient, MqttConnectionOptions> clientManager) {

    Mqttv5PahoMessageDrivenChannelAdapter messageProducer =
        new Mqttv5PahoMessageDrivenChannelAdapter(clientManager, "topic1");
    return IntegrationFlow.from(messageProducer)
            .channel(c -> c.queue("fromMqttChannel"))
            .get();
}

@Bean
public IntegrationFlow mqttInFlowTopic2(
        ClientManager<IMqttAsyncClient, MqttConnectionOptions> clientManager) {

    Mqttv5PahoMessageDrivenChannelAdapter messageProducer =
        new Mqttv5PahoMessageDrivenChannelAdapter(clientManager, "topic2");
    return IntegrationFlow.from(messageProducer)
            .channel(c -> c.queue("fromMqttChannel"))
            .get();
}

@Bean
public IntegrationFlow mqttOutFlow(
        ClientManager<IMqttAsyncClient, MqttConnectionOptions> clientManager) {

    return f -> f.handle(new Mqttv5PahoMessageHandler(clientManager));
}

從 6.4 版本開始，現在可以透過對應的 ClientManager 和 IntegrationFlowContext 在執行時新增 MqttPahoMessageDrivenChannelAdapter 和 Mqttv5PahoMessageDrivenChannelAdapter 的多個例項。

private void addAddRuntimeAdapter(IntegrationFlowContext flowContext, Mqttv5ClientManager clientManager,
                                  String topic, MessageChannel channel) {
    flowContext
        .registration(
            IntegrationFlow
                .from(new Mqttv5PahoMessageDrivenChannelAdapter(clientManager, topic))
                .channel(channel)
                .get())
        .register();
}