關於mqttclient軟件包

一個基於socket API之上的跨平臺MQTT客戶端

基於socket API的MQTT客戶端，擁有非常簡潔的API接口，以極少的資源實現QOS2的服務質量，並且無縫銜接了mbedtls加密庫。此倉庫是專門爲RT-Thread做的軟件包，原始倉庫位於：https://github.com/jiejieTop/mqttclient

優勢：

基於標準BSD socket之上開發，只要是兼容BSD socket的系統均可使用。
穩定：無論是掉線重連，丟包重發，都是嚴格遵循MQTT協議標準執行，除此之外對大數據量的測試無論是收是發，都是非常穩定（一次發送135K數據，3秒一次），高頻測試也是非常穩定（7個主題同時收發，每秒一次，也就是1秒14個mqtt報文，服務質量QoS0、QoS1、QoS2都有）。因爲作者以極少的資源設計了記錄機制，對採用QoS1服務質量的報文必須保證到達一次，對QoS2服務質量的報文有且只有收到一次（如果不相信它穩定性的同學可以自己去修改源碼，專門爲QoS2服務質量去測試，故意不回覆PUBREC，讓服務器重發QoS2報文，看看客戶端是否有且只有處理一次），而對於掉線重連的穩定性，則是基本操作了，沒啥好說的，因此在測試中穩定性極好。
輕量級：整個代碼工程極其簡單，不使用mbedtls情況下，佔用資源極少，作者曾使用esp8266模組與雲端通信，整個工程代碼消耗的RAM不足15k（包括系統佔用的開銷，對數據的處理開銷，而此次還是未優化的情況下，還依舊完美保留了掉線重連的穩定性，但是對應qos1 qos2服務質量的報文則未做測試，因爲STM32F103C8T6芯片資源實在是太少了，折騰不起）。
無縫銜接mbedtls加密傳輸，讓網絡傳輸更加安全。
擁有極簡的API接口，隨意配置，使用起來非常簡單。
有非常好的代碼風格與思想：整個代碼採用分層式設計，代碼實現採用異步處理的思想，降低耦合，提高性能。
MQTT協議支持主題通配符“#”、“+”。
訂閱的主題與消息處理完全分離，讓編程邏輯更加簡單易用，用戶無需理會錯綜複雜的邏輯關係。
不對外產生依賴。
mqttclient內部已實現保活處理機制，無需用戶過多關心理會，用戶只需專心處理應用功能即可。

整體框架

擁有非常明確的分層框架。

API

mqttclient擁有非常簡潔的api接口，並且api見名知其義，非常易於使用。

int mqtt_init(mqtt_client_t* c, client_init_params_t* init);
int mqtt_release(mqtt_client_t* c);
int mqtt_connect(mqtt_client_t* c);
int mqtt_disconnect(mqtt_client_t* c);
int mqtt_subscribe(mqtt_client_t* c, const char* topic_filter, mqtt_qos_t qos, message_handler_t msg_handler);
int mqtt_unsubscribe(mqtt_client_t* c, const char* topic_filter);
int mqtt_publish(mqtt_client_t* c, const char* topic_filter, mqtt_message_t* msg);

int mqtt_keep_alive(mqtt_client_t* c);
int mqtt_yield(mqtt_client_t* c, int timeout_ms);

核心

mqtt_client_t 是核心結構

typedef struct mqtt_client {
    unsigned short              packet_id;
    unsigned char               ping_outstanding;
    unsigned char               ack_handler_number;
    unsigned char               *read_buf;
    unsigned char               *write_buf;
    unsigned int                cmd_timeout;
    unsigned int                read_buf_size;
    unsigned int                write_buf_size;
    unsigned int                reconnect_try_duration;
    void                        *reconnect_date;
    reconnect_handler_t         reconnect_handler;
    client_state_t              client_state;
    platform_mutex_t            write_lock;
    platform_mutex_t            global_lock;
    list_t                      msg_handler_list;
    list_t                      ack_handler_list;
    network_t                   *network;
    platform_thread_t           *thread;
    platform_timer_t            reconnect_timer;
    platform_timer_t            last_sent;
    platform_timer_t            last_received;
    connect_params_t            *connect_params;
} mqtt_client_t;

該結構主要維護以下內容：

讀寫數據緩衝區read_buf、write_buf
命令超時時間cmd_timeout（主要是讀寫阻塞時間、等待響應的時間、重連等待時間）
維護ack鏈表ack_handler_list，這是異步實現的核心，所有等待響應的報文都會被掛載到這個鏈表上
維護消息處理列表msg_handler_list，這是mqtt協議必須實現的內容，所有來自服務器的publish報文都會被處理（前提是訂閱了對應的消息）
維護一個網卡接口network
維護一個內部線程thread，所有來自服務器的mqtt包都會在這裏被處理！
兩個定時器，分別是掉線重連定時器與保活定時器reconnect_timer、last_sent、last_received
一些連接的參數connect_params

初始化

主要是配置mqtt_client_t結構的相關信息，如果沒有指定初始化參數，則系統會提供默認的參數。
但連接部分的參數則必須指定：

    init_params.connect_params.network_params.addr = "[你的mqtt服務器IP地址或者是域名]";
    init_params.connect_params.network_params.port = "1883";	//端口號
    init_params.connect_params.user_name = "jiejietop";
    init_params.connect_params.password = "123456";
    init_params.connect_params.client_id = "clientid";
    
    mqtt_init(&client, &init_params);

連接服務器

	mqtt_connect(&client);

訂閱報文

參數只有 mqtt_client_t 類型的指針，字符串類型的主題（支持通配符"#" “+”），主題的服務質量，以及收到報文的處理函數，如不指定則有默認處理函數。

    mqtt_subscribe(&client, "testtopic0", QOS0, topic_test1_handler);
    mqtt_subscribe(&client, "testtopic1", QOS1, NULL);
    mqtt_subscribe(&client, "testtopic2", QOS2, NULL);

發佈報文

參數只有 mqtt_client_t 類型的指針，字符串類型的主題（支持通配符），要發佈的消息（包括服務質量、消息主體）。

    mqtt_message_t msg;
    
    msg.qos = 2;
    msg.payload = (void *) buf;
    
	mqtt_publish(&client, "testtopic1", &msg);

其他的API接口都是非常簡單的，在後文會提及到。

使用mqttclient軟件包

目前作者已經將mqttclient製作成RT-Thread的軟件包了，大家可以通過env工具或者 RT-Thread Studio 直接使用軟件包。

env工具

隨着 package 系統的不斷壯大，會有越來越多的軟件包加入進來，所以本地看到 menuconfig 中的軟件包列表可能會與服務器不同步。使用 pkgs --upgrade 命令即可解決該問題，這個命令不僅會對本地的包信息進行更新同步，還會對 env 的功能腳本進行升級，建議定期使用。

本次測試使用野火STM32F429挑戰者開發板

所以用 pkgs --upgrade 命令先同步一下軟件包。
menuconfig命令打開配置。
在以下路徑下選中mqttclient軟件包，除此之外還要打開lwip、以太網接口或者 SAL->套接字接口。

Location:   
    -> RT-Thread online packages
        -> IoT - internet of things
            -> mqttclient

然後就是隨意配置了。

mbedtls

默認不打開mbedtls。

salof

salof 全稱是：Synchronous Asynchronous Log Output Framework（同步異步日誌輸出框架），它是一個異步日誌輸出庫，在空閒時候輸出對應的日誌信息，並且該庫與mqttclient無縫銜接。

配置對應的日誌輸出級別：

#define BASE_LEVEL      (0)
#define ASSERT_LEVEL    (BASE_LEVEL + 1)            /* 日誌輸出級別：斷言級別（非常高優先級） */
#define ERR_LEVEL       (ASSERT_LEVEL + 1)          /* 日誌輸出級別：錯誤級別（高優先級） */
#define WARN_LEVEL      (ERR_LEVEL + 1)             /* 日誌輸出級別：警告級別（中優先級） */
#define INFO_LEVEL      (WARN_LEVEL + 1)            /* 日誌輸出級別：信息級別（低優先級） */
#define DEBUG_LEVEL     (INFO_LEVEL + 1)            /* 日誌輸出級別：調試級別（更低優先級） */

#define         LOG_LEVEL                   WARN_LEVEL      /* 日誌輸出級別 */

日誌其他選項：

終端帶顏色
時間戳
標籤

mqtt

配置mqtt等待應答列表的最大值，對於qos1 qos2服務質量有要求的可以將其設置大一點，當然也必須資源跟得上，它主要是保證qos1 qos2的mqtt報文能準確到達服務器。

#define     MQTT_ACK_HANDLER_NUM_MAX            64

選擇MQTT協議的版本，默認爲4，表示使用MQTT 3.1.1版本，而3則表示爲MQTT 3.1版本。

#define     MQTT_VERSION                        4           // 4 is mqtt 3.1.1

設置默認的保活時間，它主要是保證MQTT客戶端與服務器的保持活性連接，單位爲秒，比如MQTT客戶端與服務器100S沒有發送數據了，有沒有接收到數據，此時MQTT客戶端會發送一個ping包，確認一下這個會話是否存在，如果收到服務器的應答，那麼說明這個會話還是存在的，可以隨時收發數據，而如果不存在了，就清除會話。

#define     MQTT_KEEP_ALIVE_INTERVAL            100         // unit: second

默認的命令超時，它主要是用於socket讀寫超時，在MQTT初始化時可以指定:

#define     MQTT_DEFAULT_CMD_TIMEOUT            4000

默認主題的長度，主題是支持通配符的，如果主題太長則會被截斷：

#define     MQTT_TOPIC_LEN_MAX                  64

默認的算法數據緩衝區的大小，如果要發送大量數據則修改大一些，在MQTT初始化時可以指定：

#define     MQTT_DEFAULT_BUF_SIZE               1024

線程相關的配置，如線程棧，線程優先級，線程時間片等：
在linux環境下可以是不需要理會這些參數的，而在RTOS平臺則需要配置，如果不使用mbedtls，線程棧2048字節已足夠，而使用mbedtls加密後，需要配置4096字節以上。

#define     MQTT_THREAD_STACK_SIZE              2048    // 線程棧
#define     MQTT_THREAD_PRIO                    5       // 線程優先級
#define     MQTT_THREAD_TICK                    50      // 線程時間片

默認的重連時間間隔，當發生掉線時，會以這個時間間隔嘗試重連：

#define     MQTT_RECONNECT_DEFAULT_DURATION     1000

其他不需要怎麼配置的東西：

#define     MQTT_MAX_PACKET_ID                  (0xFFFF - 1)    // mqtt報文id
#define     MQTT_MAX_CMD_TIMEOUT                20000           //最大的命令超時參數
#define     MQTT_MIN_CMD_TIMEOUT                1000            //最小的命令超時參數

ps：以上參數基本不需要怎麼配置的，直接用即可~

最後通過scons --target=mdk5命令生成mdk工程，然後編譯下載到開發板後運行就行了（需要使用mqttclient測試代碼），目前作者提供服務器僅供測試。

RT-Thread Studio使用

通過RT-Thread Setting打開lwip、以太網接口然後選擇在線軟件包添加到工程中，然後保存配置就可以看到工程已經添加了mqttclient軟件包了。

注意：如果遇到添加軟件包失敗的話，很可能是因爲RT-Thread Studio中的軟件包還沒更新或者更新失敗，那麼可以到軟件安裝目錄RT-ThreadStudio\platform\env_released\env\packages\packages下手動更新軟件包，然後將master重置到最新的分支就行了：

mqttclient實現

以下是整個框架的實現方式，方便大家更容易理解mqttclient的代碼與設計思想，讓大家能夠修改源碼與使用，還可以提交pr或者issues，開源的世界期待各位大神的參與，感謝！

除此之外以下代碼的記錄機制與其超時處理機制是非常好的編程思想，大家有興趣一定要看源代碼！

連接服務器

int mqtt_connect(mqtt_client_t* c);

連接服務器則是使用非異步的方式設計，因爲必須等待連接上服務器才能進行下一步操作。
過程如下：

調用底層的連接函數連接上服務器：

c->network->connect(c->network);

序列化mqtt的CONNECT報文並且發送

MQTTSerialize_connect(c->write_buf, c->write_buf_size, &connect_data)
mqtt_send_packet(c, len, &connect_timer)

等待來自服務器的CONNACK報文

mqtt_wait_packet(c, CONNACK, &connect_timer)

連接成功後創建一個內部線程mqtt_yield_thread，並在合適的時候啓動它：

platform_thread_init("mqtt_yield_thread", mqtt_yield_thread, c, MQTT_THREAD_STACK_SIZE, MQTT_THREAD_PRIO, MQTT_THREAD_TICK)

if (NULL != c->thread) {
    mqtt_set_client_state(c, CLIENT_STATE_CONNECTED);
    platform_thread_startup(c->thread);
    platform_thread_start(c->thread);       /* start run mqtt thread */
}

而對於重連來說則不會重新創建線程，直接改變客戶端狀態爲連接狀態即可:

mqtt_set_client_state(c, CLIENT_STATE_CONNECTED);

訂閱報文

int mqtt_subscribe(mqtt_client_t* c, const char* topic_filter, mqtt_qos_t qos, message_handler_t handler)

訂閱報文使用異步設計來實現的：
過程如下：

序列化訂閱報文並且發送給服務器

MQTTSerialize_subscribe(c->write_buf, c->write_buf_size, 0, mqtt_get_next_packet_id(c), 1, &topic, (int*)&qos)
mqtt_send_packet(c, len, &timer)

創建對應的消息處理節點，這個消息節點在收到服務器的SUBACK訂閱應答報文後會掛載到消息處理列表msg_handler_list上

mqtt_msg_handler_create(topic_filter, qos, handler)

在發送了報文給服務器那就要等待服務器的響應了，先記錄這個等待SUBACK

mqtt_ack_list_record(c, SUBACK, mqtt_get_next_packet_id(c), len, msg_handler)

取消訂閱

與訂閱報文的邏輯基本差不多的~

序列化訂閱報文並且發送給服務器

MQTTSerialize_unsubscribe(c->write_buf, c->write_buf_size, 0, packet_id, 1, &topic)
mqtt_send_packet(c, len, &timer)

創建對應的消息處理節點，這個消息節點在收到服務器的UNSUBACK取消訂閱應答報文後將消息處理列表msg_handler_list上的已經訂閱的主題消息節點銷燬

mqtt_msg_handler_create((const char*)topic_filter, QOS0, NULL)

在發送了報文給服務器那就要等待服務器的響應了，先記錄這個等待UNSUBACK

mqtt_ack_list_record(c, UNSUBACK, packet_id, len, msg_handler)

發佈報文

int mqtt_publish(mqtt_client_t* c, const char* topic_filter, mqtt_message_t* msg)

核心思想都差不多，過程如下：

先序列化發佈報文，然後發送到服務器

MQTTSerialize_publish(c->write_buf, c->write_buf_size, 0, msg->qos, msg->retained, msg->id,
              topic, (unsigned char*)msg->payload, msg->payloadlen);
mqtt_send_packet(c, len, &timer)

對於QOS0的邏輯，不做任何處理，對於QOS1和QOS2的報文則需要記錄下來，在沒收到服務器應答的時候進行重發

    if (QOS1 == msg->qos) {
        rc = mqtt_ack_list_record(c, PUBACK, mqtt_get_next_packet_id(c), len, NULL);
    } else if (QOS2 == msg->qos) {
        rc = mqtt_ack_list_record(c, PUBREC, mqtt_get_next_packet_id(c), len, NULL);
    }

還有非常重要的一點，重發報文的MQTT報文頭部需要設置DUP標誌位，這是MQTT協議的標準，因此，在重發的時候作者直接操作了報文的DUP標誌位，因爲修改DUP標誌位的函數我沒有從MQTT庫中找到，所以我封裝了一個函數，這與LwIP中的交叉存取思想是一個道理，它假設我知道MQTT報文的所有操作，所以我可以操作它，這樣子可以提高很多效率：

mqtt_set_publish_dup(c,1);  /* may resend this data, set the udp flag in advance */

內部線程

static void mqtt_yield_thread(void *arg)

主要是對mqtt_yield函數的返回值做處理，比如在disconnect的時候銷燬這個線程。

核心的處理函數

數據包的處理mqtt_packet_handle

static int mqtt_packet_handle(mqtt_client_t* c, platform_timer_t* timer)

對不同的包使用不一樣的處理：

    switch (packet_type) {
        case 0: /* timed out reading packet */
            break;

        case CONNACK:
            break;

        case PUBACK:
        case PUBCOMP:
            rc = mqtt_puback_and_pubcomp_packet_handle(c, timer);
            break;

        case SUBACK:
            rc = mqtt_suback_packet_handle(c, timer);
            break;
            
        case UNSUBACK:
            rc = mqtt_unsuback_packet_handle(c, timer);
            break;

        case PUBLISH:
            rc = mqtt_publish_packet_handle(c, timer);
            break;

        case PUBREC:
        case PUBREL:
            rc = mqtt_pubrec_and_pubrel_packet_handle(c, timer);
            break;

        case PINGRESP:
            c->ping_outstanding = 0;
            break;

        default:
            goto exit;
    }

並且做保活的處理：

mqtt_keep_alive(c)

當發生超時後，

if (platform_timer_is_expired(&c->last_sent) || platform_timer_is_expired(&c->last_received))

序列號一個心跳包並且發送給服務器

MQTTSerialize_pingreq(c->write_buf, c->write_buf_size);
mqtt_send_packet(c, len, &timer);

當再次發生超時後，表示與服務器的連接已斷開，需要重連的操作，設置客戶端狀態爲斷開連接

mqtt_set_client_state(c, CLIENT_STATE_DISCONNECTED);

ack鏈表的掃描，當收到服務器的報文時，對ack列表進行掃描操作

mqtt_ack_list_scan(c);

當超時後就銷燬ack鏈表節點：

mqtt_ack_handler_destroy(ack_handler);

當然下面這幾種報文則需要重發操作：（PUBACK 、PUBREC、 PUBREL 、PUBCOMP，保證QOS1 QOS2的服務質量）

if ((ack_handler->type ==  PUBACK) || (ack_handler->type ==  PUBREC) || (ack_handler->type ==  PUBREL) || (ack_handler->type ==  PUBCOMP))
	mqtt_ack_handler_resend(c, ack_handler);

保持活性的時間過去了，可能掉線了，需要重連操作

mqtt_try_reconnect(c);

重連成功後嘗試重新訂閱報文，保證恢復原始狀態~

mqtt_try_resubscribe(c)

發佈應答與發佈完成報文的處理

static int mqtt_puback_and_pubcomp_packet_handle(mqtt_client_t *c, platform_timer_t *timer)

反序列化報文

MQTTDeserialize_ack(&packet_type, &dup, &packet_id, c->read_buf, c->read_buf_size)

取消對應的ack記錄

mqtt_ack_list_unrecord(c, packet_type, packet_id, NULL);

訂閱應答報文的處理

static int mqtt_suback_packet_handle(mqtt_client_t *c, platform_timer_t *timer)

反序列化報文

MQTTDeserialize_suback(&packet_id, 1, &count, (int*)&granted_qos, c->read_buf, c->read_buf_size)

取消對應的ack記錄

mqtt_ack_list_unrecord(c, packet_type, packet_id, NULL);

安裝對應的訂閱消息處理函數，如果是已存在的則不會安裝

mqtt_msg_handlers_install(c, msg_handler);

取消訂閱應答報文的處理

static int mqtt_unsuback_packet_handle(mqtt_client_t *c, platform_timer_t *timer)

反序列化報文

MQTTDeserialize_unsuback(&packet_id, c->read_buf, c->read_buf_size)

取消對應的ack記錄，並且獲取到已經訂閱的消息處理節點

mqtt_ack_list_unrecord(c, UNSUBACK, packet_id, &msg_handler)

銷燬對應的訂閱消息處理函數

mqtt_msg_handler_destory(msg_handler);

來自服務器的發佈報文的處理

static int mqtt_publish_packet_handle(mqtt_client_t *c, platform_timer_t *timer)

反序列化報文

MQTTDeserialize_publish(&msg.dup, &qos, &msg.retained, &msg.id, &topic_name,
        (unsigned char**)&msg.payload, (int*)&msg.payloadlen, c->read_buf, c->read_buf_size)

對於QOS0、QOS1的報文，直接去處理消息

mqtt_deliver_message(c, &topic_name, &msg);

對於QOS1的報文，還需要發送一個PUBACK應答報文給服務器

MQTTSerialize_ack(c->write_buf, c->write_buf_size, PUBACK, 0, msg.id);

而對於QOS2的報文則需要發送PUBREC報文給服務器，除此之外還需要記錄PUBREL到ack鏈表上，等待服務器的發佈釋放報文，最後再去處理這個消息

MQTTSerialize_ack(c->write_buf, c->write_buf_size, PUBREC, 0, msg.id);
mqtt_ack_list_record(c, PUBREL, msg.id + 1, len, NULL)
mqtt_deliver_message(c, &topic_name, &msg);

說明：一旦註冊到ack列表上的報文，當具有重複的報文是不會重新被註冊的，它會通過mqtt_ack_list_node_is_exist函數判斷這個節點是否存在，主要是依賴等待響應的消息類型與msgid。

發佈收到與發佈釋放報文的處理

static int mqtt_pubrec_and_pubrel_packet_handle(mqtt_client_t *c, platform_timer_t *timer)

反序列化報文

MQTTDeserialize_ack(&packet_type, &dup, &packet_id, c->read_buf, c->read_buf_size)

產生一個對應的應答報文

mqtt_publish_ack_packet(c, packet_id, packet_type);

取消對應的ack記錄

mqtt_ack_list_unrecord(c, UNSUBACK, packet_id, &msg_handler)

RT-Thread之mqttclient軟件包

關於mqttclient軟件包

優勢：

整體框架

API

核心

初始化

連接服務器

訂閱報文

發佈報文

使用mqttclient軟件包

env工具

mbedtls

salof

mqtt

RT-Thread Studio使用

mqttclient實現

連接服務器

訂閱報文

取消訂閱

發佈報文

內部線程

核心的處理函數

發佈應答與發佈完成報文的處理

訂閱應答報文的處理

取消訂閱應答報文的處理

來自服務器的發佈報文的處理

發佈收到與發佈釋放報文的處理

vue綁定對象，綁定的值不改變的問題

Spring Cloud 部署時如何使用 Kubernetes 作爲註冊中心和配置中心

KubeKey 部署 K8s v1.28.8 實戰

記一些CISP-PTE題目解析

select、poll、epoll的原理區別

深入瞭解C++多態的原理及實現方式

MQTT移植到stm32開發板——使用TencentOS tiny操作系統

MQTT移植到stm32開發板——使用FreeRTOS操作系統

MQTT移植到stm32開發板——使用RT-Thread操作系統

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結