一套极简的MQTT使用接口EasyMqttClient

简介: 一套极简的MQTT使用接口EasyMqttClient

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

https://github.com/Yangyuanxin/EasyMqttClient

640.png

杰杰大佬的mqttclient项目:

https://github.com/jiejieTop/mqttclient

640.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,十分简单!分别是:

//MQTT初始化
EasyMqttClient_t *EasyMqttInit(EasyMqttAttr_t *Attr);
//MQTT反初始化
int EasyMqttUnInit(EasyMqttClient_t *Client);
//MQTT连接
int EasyMqttConnect(EasyMqttClient_t *Client);
//MQTT断开连接
int EasyMqttDisConnect(EasyMqttClient_t *Client);
//MQTT Topic订阅
int EasyMqttSubscribe(EasyMqttClient_t *Client, const char *Topic, enum EasyMqttQos_t Qos, 
                    void (*Cb)(const char *Topic,char* Data,unsigned short Len));
//MQTT 解除订阅
int EasyMqttUnsubscribe(EasyMqttClient_t *Client, const char *Topic);
//MQTT Topic发布
int EasyMqttPublish(EasyMqttClient_t *Client, const char *Topic, enum EasyMqttQos_t Qos, char *Data, unsigned short Len);

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

typedef struct EasyMqttAttr
{
    char *Url;
    char *Port;
    char *ClientId;
    char *Username;
    char *Password;
}EasyMqttAttr_t;
//......................
mqtt_set_host;
mqtt_set_port;
mqtt_set_client_id;
mqtt_set_user_name;
mqtt_set_password;
mqtt_set_clean_session;
//调用的时候很简单
//1.
//2.定义一个结构体变量
example: 
EasyMqttClient_t *Client = NULL;
EasyMqttAttr_t Attr = 
{
   .Url      = "192.168.4.248",
   .Port     = "30157",
   .ClientId = "EasyMqttMqtt",
   .Username = "EasyMqtt",
   .Password = "123456"
};
//3.调用EasyMqttInit函数
Client = EasyMqttInit(Client, &Attr);
//to do
//实现你的MQTT连接、订阅、分布等逻辑
//to do end

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

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

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

//Topic回调触发
static void TopicHandlerCallBack(void* client, message_data_t* Msg)
{
    (void)client;
    int Index = 0;
    char *Topic = Msg->topic_name;
    unsigned short Len = Msg->message->payloadlen;
    char *Data  = (char *)Msg->message->payload;
    //上锁
    pthread_mutex_lock(&Mutex);
    //当接收到不同的Topic时,根据Topic找到对应的回调函数并进行调用
    for(Index = 0; Index < sizeof(Table)/sizeof(Table[0]); Index++)
    {
        if(0 == strcmp(Msg->topic_name,Table[Index].Topic))
        {
            Table[Index].CallBack(Topic,Data,Len);
            break;
        }
    }
    //解锁
    pthread_mutex_unlock(&Mutex);
}
//EasyMqttSubscribe Topic订阅函数
int EasyMqttSubscribe(EasyMqttClient_t *Client, const char *Topic, enum EasyMqttQos_t Qos, 
                    void (*Cb)(const char *Topic, char* Data, unsigned short Len))
{
    if(Index > MAX_TOPIC-1)
    {
        printf("Exceeds the maximum number of topics set:%d!\n", Index);
        return -1;
    }
    Table[Index].Topic = Topic;
    Table[Index].CallBack = Cb;
    Index++;
    return mqtt_subscribe(Client, Topic, (mqtt_qos_t)Qos, TopicHandlerCallBack);
}

具体使用方法可参考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内核揭秘】,一定不要错过啦!

相关实践学习
RocketMQ一站式入门使用
从源码编译、部署broker、部署namesrv,使用java客户端首发消息等一站式入门RocketMQ。
消息队列 MNS 入门课程
1、消息队列MNS简介 本节课介绍消息队列的MNS的基础概念 2、消息队列MNS特性 本节课介绍消息队列的MNS的主要特性 3、MNS的最佳实践及场景应用 本节课介绍消息队列的MNS的最佳实践及场景应用案例 4、手把手系列:消息队列MNS实操讲 本节课介绍消息队列的MNS的实际操作演示 5、动手实验:基于MNS,0基础轻松构建 Web Client 本节课带您一起基于MNS,0基础轻松构建 Web Client
目录
相关文章
|
5天前
|
安全 物联网 测试技术
C++ 构建通用的MQTT接口:从理论到实践
C++ 构建通用的MQTT接口:从理论到实践
271 2
|
5天前
|
消息中间件 网络协议 JavaScript
MQTT常见问题之微消息队列mqtt支持ipv6失败如何解决
MQTT(Message Queuing Telemetry Transport)是一个轻量级的、基于发布/订阅模式的消息协议,广泛用于物联网(IoT)中设备间的通信。以下是MQTT使用过程中可能遇到的一些常见问题及其答案的汇总:
|
5天前
|
消息中间件 物联网 Java
MQTT常见问题之微消息队列配置失败如何解决
MQTT(Message Queuing Telemetry Transport)是一个轻量级的、基于发布/订阅模式的消息协议,广泛用于物联网(IoT)中设备间的通信。以下是MQTT使用过程中可能遇到的一些常见问题及其答案的汇总:
|
5天前
|
消息中间件 存储 监控
RabbitMQ:分布式系统中的高效消息队列
RabbitMQ:分布式系统中的高效消息队列
|
5天前
|
消息中间件 分布式计算 监控
Python面试:消息队列(RabbitMQ、Kafka)基础知识与应用
【4月更文挑战第18天】本文探讨了Python面试中RabbitMQ与Kafka的常见问题和易错点,包括两者的基础概念、特性对比、Python客户端使用、消息队列应用场景及消息可靠性保证。重点讲解了消息丢失与重复的避免策略,并提供了实战代码示例,帮助读者提升在分布式系统中使用消息队列的能力。
42 2
|
5天前
|
消息中间件 Java
springboot整合消息队列——RabbitMQ
springboot整合消息队列——RabbitMQ
82 0
|
5天前
|
消息中间件 存储 运维
为什么选择云消息队列 RocketMQ 版
为什么选择云消息队列 RocketMQ 版
11 1
|
5天前
|
消息中间件 存储 运维
深入理解MQ消息队列的高可用与可靠性策略
深入理解MQ消息队列的高可用与可靠性策略
718 3
|
5天前
|
消息中间件 大数据 Java
消息队列 MQ
消息队列 MQ
31 3
|
5天前
|
消息中间件 数据安全/隐私保护
MQTT微消息队列服务器连接报错:Error: Connection refused: Not authorized
使用MQTTX工具进行测试时,通过AccessKey创建了Client ID的用户名和密码。配置了公网接入点及端口1883,但尝试连接时出现错误。已附上工具截图:![](https://ucc.alicdn.com/pic/developer-ecology/3byii5uar64gg_36327474e991439da422f38c450ef153.png)。确认过用户名、密码和Client ID无误,问题仍未解决,期待回复!