• 一套极简的MQTT使用接口EasyMqttClient


    点击上方“嵌入式应用研究院”,选择“置顶/星标公众号

    干货福利,第一时间送达!

    来源 | 嵌入式应用研究院

    整理&排版 | 嵌入式应用研究院

    在物联网相关的应用开发中或多或少都会用到MQTT,以下这个开源项目是我基于杰杰大佬的mqttclient项目进行二次封装的接口:

    https://github.com/Yangyuanxin/EasyMqttClient

    75c4af371cc36194e3c6ed64f9b453d1.png

    杰杰大佬的mqttclient项目:

    https://github.com/jiejieTop/mqttclient

    456fbf8a9ef4ad6fbd858e7a44fe7373.png

    在封装之前,通过内存泄露工具定位排查得知调用mqtt_releaseSALOF_LOG存在一些问题,好在mqtt_release的场景其实基本上不会用到,但还是有必要拿出来说说:

    • Bug1(platform_thread内存泄露)

    mqttclient/platform/linux/platform_thread.c文件中的platform_thread_destroy函数并没有对线程封装函数中的thread所申请的内存进行释放,这样的后果是会在mqttclient调用mqtt_release函数的时候造成内存泄露。

    • Bug2(实际待解决-可通过屏蔽宏定义解决)

    mqttclient/common/log模块存在内存泄露,可通过关闭mqtt_config.h文件中的MQTT_LOG_IS_SALOF解决。

    • Bug3(待解决-可暂时忽略)

    在执行mqtt_release时,有机率出现core dump,但是mqtt_release场景在一般产品开发中并不常见,除非有特殊的需要。具体详见我提出的Issues:

    https://github.com/jiejieTop/mqttclient/issues/60

    除此之外,mqttclient用起来还是很爽的,不少开源项目和实际产品上都用了这套接口,非常稳定。

    以下是我封装以后的接口就只有7个API,十分简单!分别是:

    1. //MQTT初始化
    2. EasyMqttClient_t *EasyMqttInit(EasyMqttAttr_t *Attr);
    3. //MQTT反初始化
    4. int EasyMqttUnInit(EasyMqttClient_t *Client);
    5. //MQTT连接
    6. int EasyMqttConnect(EasyMqttClient_t *Client);
    7. //MQTT断开连接
    8. int EasyMqttDisConnect(EasyMqttClient_t *Client);
    9. //MQTT Topic订阅
    10. int EasyMqttSubscribe(EasyMqttClient_t *Client, const char *Topic, enum EasyMqttQos_t Qos, 
    11.                     void (*Cb)(const char *Topic,char* Data,unsigned short Len));
    12. //MQTT 解除订阅
    13. int EasyMqttUnsubscribe(EasyMqttClient_t *Client, const char *Topic);
    14. //MQTT Topic发布
    15. int EasyMqttPublish(EasyMqttClient_t *Client, const char *Topic, enum EasyMqttQos_t Qos, char *Data, unsigned short Len);

    其中EasyMqttInit函数将以下这些琐碎的过程,例如设置URL、设置端口号等过程用结构体EasyMqttAttr封装到了一起:

    1. typedef struct EasyMqttAttr
    2. {
    3.     char *Url;
    4.     char *Port;
    5.     char *ClientId;
    6.     char *Username;
    7.     char *Password;
    8. }EasyMqttAttr_t;
    9. //......................
    10. mqtt_set_host;
    11. mqtt_set_port;
    12. mqtt_set_client_id;
    13. mqtt_set_user_name;
    14. mqtt_set_password;
    15. mqtt_set_clean_session;
    16. //调用的时候很简单
    17. //1.
    18. //2.定义一个结构体变量
    19. example: 
    20. EasyMqttClient_t *Client = NULL;
    21. EasyMqttAttr_t Attr = 
    22. {
    23.    .Url      = "192.168.4.248",
    24.    .Port     = "30157",
    25.    .ClientId = "EasyMqttMqtt",
    26.    .Username = "EasyMqtt",
    27.    .Password = "123456"
    28. };
    29. //3.调用EasyMqttInit函数
    30. Client = EasyMqttInit(Client, &Attr);
    31. //to do
    32. //实现你的MQTT连接、订阅、分布等逻辑
    33. //to do end

    另外,它还实现了对不同订阅Topic的回调函数进行分开处理,让开发的逻辑更加清晰,也易于调试和解决问题,这个实现的机制是基于一个结构体数组来实现的,如下所示:

    1. struct TopicHandler_t
    2. {
    3.     //Topic
    4.     const char *Topic;
    5.     //Topic对应的回调函数
    6.     void (*CallBack)(const char *Topic,char* Data,unsigned short Len);
    7. };
    8. //结构体数组表,最大支持处理Topic的个数为MAX_TOPIC,该值默认为64
    9. struct TopicHandler_t Table[MAX_TOPIC];

    当调用EasyMqttSubscribe Topic订阅函数订阅一个Topic时,就会将这个Topic和它的回调添加到这个表里。当mqttclient接收到不同的Topic时,则会查表调用不同Topic所对应的回调函数,具体逻辑如下所示:

    1. //Topic回调触发
    2. static void TopicHandlerCallBack(void* client, message_data_t* Msg)
    3. {
    4.     (void)client;
    5.     int Index = 0;
    6.     char *Topic = Msg->topic_name;
    7.     unsigned short Len = Msg->message->payloadlen;
    8.     char *Data  = (char *)Msg->message->payload;
    9.     //上锁
    10.     pthread_mutex_lock(&Mutex);
    11.     //当接收到不同的Topic时,根据Topic找到对应的回调函数并进行调用
    12.     for(Index = 0; Index < sizeof(Table)/sizeof(Table[0]); Index++)
    13.     {
    14.         if(0 == strcmp(Msg->topic_name,Table[Index].Topic))
    15.         {
    16.             Table[Index].CallBack(Topic,Data,Len);
    17.             break;
    18.         }
    19.     }
    20.     //解锁
    21.     pthread_mutex_unlock(&Mutex);
    22. }
    23. //EasyMqttSubscribe Topic订阅函数
    24. int EasyMqttSubscribe(EasyMqttClient_t *Client, const char *Topic, enum EasyMqttQos_t Qos, 
    25.                     void (*Cb)(const char *Topic, char* Data, unsigned short Len))
    26. {
    27.     if(Index > MAX_TOPIC-1)
    28.     {
    29.         printf("Exceeds the maximum number of topics set:%d!\n", Index);
    30.         return -1;
    31.     }
    32.     Table[Index].Topic = Topic;
    33.     Table[Index].CallBack = Cb;
    34.     Index++;
    35.     return mqtt_subscribe(Client, Topic, (mqtt_qos_t)Qos, TopicHandlerCallBack);
    36. }

    具体使用方法可参考EasyMqtt.c中的EasyMqttTest函数。目前该项目仅在Linux项目上测试通过,后续将在不同的RTOS环境下进行测试。欢迎持续关注,也欢迎提Pr,共同让嵌入式MQTT应用开发变得更简单。

    在Linux环境下使用本项目:

    • 1、克隆本项目

    git clone https://github.com/Yangyuanxin/EasyMqttClient.git
    • 2、修改交叉编译工具链(默认为gcc)

    如果你希望在嵌入式平台运行,则需要修改Makefile里的:

    CROSS_COMPILE =

    否则默认以gcc环境编译。

    • 3、编译

    make
    • 4、执行

    ./a.out

    其它环境:待测试。

    往期精彩

    基于HarmonyOS项目的手把手开源教程

    分享GitHub上一些嵌入式相关的高星开源项目

    开源:AliOS_Things_Developer_Kit开发板复活计划

    一个超棒的开源解读项目【Linux内核揭秘】,一定不要错过啦!

    觉得本次分享的文章对您有帮助,随手点[在看]并转发分享,也是对我的支持。

  • 相关阅读:
    nowcoder----kafka极速入门体验
    Linux | 可重入函数 | volatile | SIGCHLD信号
    MongoDB故障转移案例详细操作
    【JS】复习和学习几个好用的js小知识
    数据结构––kmp算法(串)
    一月内骗子连续“杀猪”,两人被骗258万,竟还有211女硕士
    华为手机安卓扫描安装包apk在哪
    10个最流行的向量数据库【AI】
    当贝投影4K激光投影X3 Pro获得一致好评:万元投影仪首选
    基于SSM的健身房管理系统
  • 原文地址:https://blog.csdn.net/morixinguan/article/details/126113245