MQTT的应用场景和OpenHarmony实现

一、MQTT简介

MQTT 是当前最主流的物联网通信协议，需要物联网云平台，例如华为云、阿里云、移动OneNET都支持mqtt。

MQTT 全称为 Message Queuing Telemetry Transport（消息队列遥测传输）是一种基于发布/订阅范式的二进制“轻量级”消息协议，由IB公司发布。针对于网络受限和嵌入式设备而设计的一种数据传输协议。MQTT最大优点在于，可以以极少的代码和有限的带宽，为连接远程设备提供实时可靠的消息服务。作为一种低开销、低带宽占用的即时通讯协议，使其在物联网、小型设备、移动应用等方面有较广泛的应用。MQTT模型如图所示。

MQTT是一个基于客户端-服务器的消息发布/订阅传输协议。MQTT协议是轻量、简单、开放和易于实现的，这些特点使它适用范围非常广泛。在很多情况下，包括受限的环境中，如：机器与机器（M2M）通信和物联网（IoT）。其在，通过卫星链路通信传感器、偶尔拨号的医疗设备、智能家居、及一些小型化设备中已广泛使用。

二、设计规范

由于物联网的环境是非常特别的，所以MQTT遵循以下设计原则：

（1）精简，不添加可有可无的功能；

（2）发布/订阅（Pub/Sub）模式，方便消息在传感器之间传递；

（3）允许用户动态创建主题，零运维成本；

（4）把传输量降到最低以提高传输效率；

（5）把低带宽、高延迟、不稳定的网络等因素考虑在内；

（6）支持连续的会话控制；

（7）理解客户端计算能力可能很低；

（8）提供服务质量管理；

（9）假设数据不可知，不强求传输数据的类型与格式，保持灵活性。

三、MQTT协议原理

3.1 通信过程

在通讯过程中，MQTT协议中有三种身份：发布者（Publish）、代理（Broker）（服务器）、订阅者（Subscribe）。其中，消息的发布者和订阅者都是客户端，消息代理是服务器，消息发布者可以同时是订阅者。

OpenHarmony轻量系统开发【11】移植MQTT-开源基础软件社区

 

 

MQTT传输的消息分为：主题（Topic）和负载（payload）两部分：

（1）Topic，可以理解为消息的类型，订阅者订阅（Subscribe）后，就会收到该主题的消息内容（payload）；

（2）payload，可以理解为消息的内容，是指订阅者具体要使用的内容。

3.2 MQTT客户端

一个使用MQTT协议的应用程序或者设备，它总是建立到服务器的网络连接。客户端可以：

（1）发布其他客户端可能会订阅的信息；

（2）订阅其它客户端发布的消息；

（3）退订或删除应用程序的消息；

（4）断开与服务器连接。

3.3 MQTT服务器

MQTT服务器以称为"消息代理"（Broker），可以是一个应用程序或一台设备。它是位于消息发布者和订阅者之间，它可以：

（1）接受来自客户的网络连接；

（2）接受客户发布的应用信息；

（3）处理来自客户端的订阅和退订请求；

（4）向订阅的客户转发应用程序消息。

3.4 MQTT协议中的订阅、主题、会话

（1）订阅（Subscription）

订阅包含主题筛选器（Topic Filter）和最大服务质量（QoS）。订阅会与一个会话（Session）关联。一个会话可以包含多个订阅。每一个会话中的每个订阅都有一个不同的主题筛选器。

（2）会话（Session）

每个客户端与服务器建立连接后就是一个会话，客户端和服务器之间有状态交互。会话存在于一个网络之间，也可能在客户端和服务器之间跨越多个连续的网络连接。

（3）主题名（Topic Name）

连接到一个应用程序消息的标签，该标签与服务器的订阅相匹配。服务器会将消息发送给订阅所匹配标签的每个客户端。

（4）主题筛选器（Topic Filter）

一个对主题名通配符筛选器，在订阅表达式中使用，表示订阅所匹配到的多个主题。

（5）负载（Payload）

消息订阅者所具体接收的内容。

4.6 MQTT协议中的方法

MQTT协议中定义了一些方法（也被称为动作），来于表示对确定资源所进行操作。这个资源可以代表预先存在的数据或动态生成数据，这取决于服务器的实现。通常来说，资源指服务器上的文件或输出。主要方法有：

（1）Connect。等待与服务器建立连接。

（2）Disconnect。等待MQTT客户端完成所做的工作，并与服务器断开TCP/IP会话。

（3）Subscribe。等待完成订阅。

（4）UnSubscribe。等待服务器取消客户端的一个或多个topics订阅。

（5）Publish。MQTT客户端发送消息请求，发送完成后返回应用程序线程。

 

四、两种MQTT实现

OpenHarmony的MQTT有2个版本，一个C语言版本，主要用于轻量系统，一个是ets版本的接口，用于标准系统。开发者可以根据自己的设备平台选择对应的MQTT版本。

4.1 轻量系统MQTT

轻量系统的MQTT代码可以参考：https://gitee.com/lianzhian/OpenHarmony_mqtt

该代码是基于paho mqtt修改，可以支持LiteOS-M内核和Linux内核。

相关API接口可以参考文件：MQTTClient-C/src/MQTTClient.h

测试代码比较好写。主要是3个文件，内容我都贴出来了：

（1）BUILD.gn文件内容：

static_library("mqtt_test") {
    sources = [
        "mqtt_test.c",
        "mqtt_entry.c"
    ]
​
    include_dirs = [
        "//utils/native/lite/include",
        "//kernel/liteos_m/components/cmsis/2.0",
        "//base/iot_hardware/interfaces/kits/wifiiot_lite",
        "//vendor/hisi/hi3861/hi3861/third_party/lwip_sack/include",
        "//foundation/communication/interfaces/kits/wifi_lite/wifiservice",
        "//third_party/pahomqtt/MQTTPacket/src",
        "//third_party/pahomqtt/MQTTClient-C/src",
        "//third_party/pahomqtt/MQTTClient-C/src/liteOS",
    ]
#表示需要a_myparty 软件包
    deps = [
        "//third_party/pahomqtt:pahomqtt_static",
    ]
}

 

（2）mqtt_entry.c文件

主要是进行热点连接，因为我们要使用MQTT需要用到网络。热点连接的代码之前在第9章已经讲说，这里就不完全贴了，代码仓库也有，主要的代码部分：

void wifi_sta_task(void *arg)
{
    arg = arg;
    
    //连接热点
    hi_wifi_start_sta();
​
    while(wifi_ok_flg == 0)
    {
        usleep(30000);
    }
    
    
    usleep(2000000);
​
    //开始进入MQTT测试
    mqtt_test();
}
​

 

（3）mqtt_test.c 文件则是编写了一个简单的MQTT测试代码

其中测试用的mqtt服务器是我自己的服务器：5.196.95.208 大家也可以改成自己的。

#include <stdio.h>
#include <unistd.h>
#include "ohos_init.h"
#include "cmsis_os2.h"
​
#include "hi_wifi_api.h"
#include "lwip/ip_addr.h"
#include "lwip/netifapi.h"
#include "lwip/sockets.h"
​
#include "MQTTClient.h"
​
​
static MQTTClient mq_client;
​
 unsigned char *onenet_mqtt_buf;
 unsigned char *onenet_mqtt_readbuf;
 int buf_size;
​
Network n;
MQTTPacket_connectData data = MQTTPacket_connectData_initializer;  
​
//消息回调函数
void mqtt_callback(MessageData *msg_data)
{
    size_t res_len = 0;
    uint8_t *response_buf = NULL;
    char topicname[45] = { "$crsp/" };
​
    LOS_ASSERT(msg_data);
​
    printf("topic %.*s receive a message\r\n", msg_data->topicName->lenstring.len, msg_data->topicName->lenstring.data);
​
    printf("message is %.*s\r\n", msg_data->message->payloadlen, msg_data->message->payload);
​
}
​
int mqtt_connect(void)
{
    int rc = 0;
    
    NetworkInit(&n);
    NetworkConnect(&n, "5.196.95.208", 1883);
​
    buf_size  = 2048;
    onenet_mqtt_buf = (unsigned char *) malloc(buf_size);
    onenet_mqtt_readbuf = (unsigned char *) malloc(buf_size);
    if (!(onenet_mqtt_buf && onenet_mqtt_readbuf))
    {
        printf("No memory for MQTT client buffer!");
        return -2;
    }
​
    MQTTClientInit(&mq_client, &n, 1000, onenet_mqtt_buf, buf_size, onenet_mqtt_readbuf, buf_size);
    
    MQTTStartTask(&mq_client);
​
​
    data.keepAliveInterval = 30;
    data.cleansession = 1;
    data.clientID.cstring = "ohos_hi3861";
    data.username.cstring = "123456";
    data.password.cstring = "222222";
​
    data.keepAliveInterval = 10;
    data.cleansession = 1;
    
    mq_client.defaultMessageHandler = mqtt_callback;
​
    //连接服务器
    rc = MQTTConnect(&mq_client, &data);
​
    //订阅消息，并设置回调函数
    MQTTSubscribe(&mq_client, "ohossub", 0, mqtt_callback);
​
    while(1)
    {
        MQTTMessage message;
​
        message.qos = QOS1;
        message.retained = 0;
        message.payload = (void *)"openharmony";
        message.payloadlen = strlen("openharmony");
​
        //发送消息
        if (MQTTPublish(&mq_client, "ohospub", &message) < 0)
        {
            return -1;
        }
    }
​
    return 0;
}
​
​
void mqtt_test(void)
{
    mqtt_connect();
}

五、标准系统的MQTT实现

标准系统的MQTT代码可以参考：https://gitee.com/openharmony-tpc/ohos_mqtt

下载安装

ohpm install @ohos/mqtt

使用说明

    import { MqttAsync } from '@ohos/mqtt';

接口说明

createMqtt

createMqtt(options: MqttAsyncClientOptions): MqttAsyncClient

创建mqtt客户端。

参数：

参数名 类型 必填 说明
options MqttAsyncClientOptions 是 客户端参数

返回值：

类型 说明
MqttAsyncClient mqtt客户端，里面包括connect,publish等方法

示例：

    this.mqttAsyncClient = MqttAsync.createMqtt({
        url: "ip:port",
        clientId: "e5fatos4jh3l79lndb0bs",
        persistenceType: 1,
    })

connect

connect(options: MqttConnectOptions, callback: AsyncCallback<MqttResponse>): void

连接mqtt服务器。

参数：

参数名 类型 必填 说明
options MqttConnectOptions 是 参考MqttConnectOptions
callback AsyncCallback< MqttResponse > 是 回调函数

示例：

​
    let options = {
        //set userName and password
        userName: "",
        password: "",
        connectTimeout: 30,
        version: 0,
    };
    this.mqttAsyncClient.connect(options, (err, data) => {
        // to do Something
    });

connect

connect(options: MqttConnectOptions): Promise<MqttResponse>

连接mqtt服务器。

参数：

参数名 类型 必填 说明
options MqttConnectOptions 是 参考MqttConnectOptions

返回值：

类型 说明
Promise<MqttResponse> 以Promise形式返回发起连接的结果。

示例：

​
    let options = {
        //set userName and password
        userName: "",
        password: "",
        connectTimeout: 30,
        version: 0,
    };
    this.mqttAsyncClient.connect(options).then((data) => {
        console.log("mqtt connect success "+ JSON.stringify(data));
    }).catch((err) => {
        console.log("mqtt connect fail"+JSON.stringify(err))
    })
​
    try{
        let result = await this.mqttAsyncClient.connect(options)
        console.log("mqtt connect success "+ JSON.stringify(result));
    }catch(err){
        console.log("mqtt connect fail "+ JSON.stringify(err));
    }

publish

publish(options: MqttPublishOptions, callback: AsyncCallback<MqttResponse>): void

发布消息。

参数：

参数名 类型 必填 说明
options MqttPublishOptions 是 参考MqttPublishOptions
callback AsyncCallback< MqttResponse > 是 回调函数

示例：

    let publishOption = {
        topic: "domotopic",
        qos: 1,
        payload: "haishangdebing",
    }
    this.mqttAsyncClient.publish(publishOption, (err, data) => {
        // to do Something
    });

publish

publish(options: MqttPublishOptions): Promise<MqttResponse>

发布消息。

参数：

参数名 类型 必填 说明
options MqttPublishOptions 是 参考MqttPublishOptions

返回值：

类型 说明
Promise<MqttResponse> 以Promise形式返回发布的结果。

示例：

    let publishOption = {
        topic: "domotopic",
        qos: 1,
        payload: "haishangdebing",
    }
    this.mqttAsyncClient.publish(publishOption, (err, data) => {
        console.log("mqtt publish success "+ JSON.stringify(data));
    }).catch((err) => {
        console.log("mqtt publish fail "+ JSON.stringify(err));
    })
​
    try{
        let result = await this.mqttAsyncClient.publish(publishOption)
        console.log("mqtt publish success "+ JSON.stringify(result));
    }catch(err){
        console.log("mqtt publish fail "+ JSON.stringify(err));
    }

subscribe

subscribe(options: MqttSubscribeOptions, callback: AsyncCallback<MqttResponse>): void

订阅主题。

参数：

参数名 类型 必填 说明
options MqttSubscribeOptions 是 参考MqttSubscribeOptions
callback AsyncCallback< MqttResponse > 是 回调函数

示例：

    let subscribeOption = {
        topic: "domotopic",
        qos: 2
    }
    this.mqttAsyncClient.subscribe(subscribeOption, (err, data) => {
        // to do Something
    });

subscribe

subscribe(options: MqttSubscribeOptions): Promise<MqttResponse>

订阅主题。

参数：

参数名 类型 必填 说明
options MqttSubscribeOptions 是 参考MqttSubscribeOptions

返回值：

类型 说明
Promise<MqttResponse> 以Promise形式返回订阅的结果。

示例：

    let subscribeOption = {
        topic: "domotopic",
        qos: 2
    }
    this.mqttAsyncClient.subscribe(subscribeOption).then((data) => {
        console.log("mqtt subscribe success "+ JSON.stringify(result));
    }).catch((err) => {
        console.log("mqtt subscribe fail "+ JSON.stringify(err));
    })
​
    try{
        let result = await this.mqttAsyncClient.subscribe(subscribeOption)
        console.log("mqtt subscribe success "+ JSON.stringify(result));
    }catch(err){
        console.log("mqtt subscribe fail "+ JSON.stringify(err));
    }

unsubscribe

unsubscribe(options: MqttSubscribeOptions, callback: AsyncCallback<MqttResponse>): void

取消订阅。

参数：

参数名 类型 必填 说明
options MqttSubscribeOptions 是 参考MqttSubscribeOptions
callback AsyncCallback< MqttResponse > 是 回调函数

示例：

    let subscribeOption = {
        topic: "domotopic",
        qos: 2
    }
    this.mqttAsyncClient.unsubscribe(subscribeOption, (err, data) => {
         // to do Something
    });

unsubscribe

unsubscribe(options: MqttSubscribeOptions): Promise<MqttResponse>

取消订阅。

参数：

参数名 类型 必填 说明
options MqttSubscribeOptions 是 参考MqttSubscribeOptions

返回值：

类型 说明
Promise<MqttResponse> 以Promise形式返回取消订阅的结果。

示例：

    let subscribeOption = {
        topic: "domotopic",
        qos: 2
    }
    this.mqttAsyncClient.unsubscribe(subscribeOption).then((data) => {
        console.log("mqtt unsubscribe success "+ JSON.stringify(result));
    }).catch((err) => {
        console.log("mqtt unsubscribe fail "+ JSON.stringify(err));
    })
​
    try{
        let result = await this.mqttAsyncClient.unsubscribe(subscribeOption)
        console.log("mqtt unsubscribe success "+ JSON.stringify(result));
    }catch(err){
        console.log("mqtt unsubscribe fail "+ JSON.stringify(err));
    }

messageArrived

messageArrived(callback: AsyncCallback<MqttMessage>): void

接收消息，使用此接口后，当订阅的主题有消息发布时，会自动接收到消息。

参数：

参数名 类型 必填 说明
callback AsyncCallback< MqttMessage > 是 回调函数

示例：

    this.mqttAsyncClient.messageArrived((err, data) => {
        // to do Something
    });

disconnect

disconnect(callback: AsyncCallback<MqttResponse>): void

断开连接。

参数：

参数名 类型 必填 说明
callback AsyncCallback< MqttResponse > 是 回调函数

示例：

    this.mqttAsyncClient.disconnect((err, data) => {
        // to do Something
    });

disconnect

disconnect(): Promise<MqttResponse>

断开连接。

返回值：

类型 说明
Promise<MqttResponse> 以Promise形式返回断开连接的结果。

示例：

    this.mqttAsyncClient.disconnect().then((data) => {
        console.log("mqtt disconnect success "+ JSON.stringify(result));;
    }).catch((err) => {
        console.log("mqtt disconnect fail "+ JSON.stringify(err));
    })
​
    try{
        let result = await this.mqttAsyncClient.disconnect()
        console.log("mqtt disconnect success "+ JSON.stringify(result));
    }catch(err){
        console.log("mqtt disconnect fail "+ JSON.stringify(err));
    }

connectLost

connectLost(callback: AsyncCallback<MqttResponse>): void

当被动的断开连接后的回调（比如断网），可以在回调中尝试重新连接。

参数：

参数名 类型 必填 说明
callback AsyncCallback< MqttResponse > 是 回调函数

示例：

    this.mqttAsyncClient.connectLost((err, data) => {
        // to do Something
    });

isConnected

isConnected(): Promise<boolean>

是否已连接。

返回值：

类型 说明
Promise<boolean> 以Promise形式返回判断是否连接的结果。

示例：

    this.mqttAsyncClient.isConnected().then((data) => {
        console.log("result: "+data)
    });
​
    let result = await this.mqttAsyncClient.isConnected() //true or false

reconnect

reconnect(): Promise<boolean>

重新连接（必须之前连接过）。

返回值：

类型 说明
Promise<boolean> 以Promise形式返回重连的的结果。

示例：

    this.mqttAsyncClient.reconnect().then((data) => {
        console.log('result: ' + data)
    });
​
    let result = await this.mqttAsyncClient.reconnect() //true or false

destroy

destroy(): Promise<boolean>

销毁客户端。

返回值：

类型 说明
Promise<boolean> 以Promise形式返回销毁的结果。

示例：

    this.mqttAsyncClient.destroy().then((data) => {
        console.log('result: ' + data)
    });
​
    let result = await this.mqttAsyncClient.destroy() //true or false
Logo
欢迎加入Laval社区

社区规范：仅讨论OpenHarmony相关问题。

更多推荐

@Builder 与 @Component 的区别与使用误区

概述 在 HarmonyOS ArkUI 开发中， @Builder 和 @Component 都用于封装可复用的 UI 片段，但它们的定位和使用方式有本质区别。开发者经常混淆两者，导致代码冗余或渲染异常。 说明 - @Builder ：用于封装可复用的 UI 片段，是方法级别的复用，不能独立渲染 - @Component ：用于定义独立的组件，可以独立渲染和管理自己的状态 最佳实践 @Build

avatar Laval社区

应用开发中常见的异步操作防抖

概述 在日常开发中，异步操作的时序问题是非常常见的坑。特别是在处理用户输入、网络请求等场景时，如果不加以控制，很容易出现竞态条件（Race Condition），导致数据错乱或界面异常。本文总结了该问题的现象、原因及解决方案。 说明 竞态条件是指多个异步操作的执行顺序不确定，导致最终结果不符合预期。典型场景包括： - 用户快速连续点击按钮触发多次请求 - 搜索框输入时频繁触发搜索请求 - 多个异步

avatar Laval社区
cover

轻智能预览器Previewer工作流程

avatar Laval社区