使用python实现MQTT通信

MQTT 是一种基于发布/订阅模式的 轻量级物联网消息传输协议，由IBM在1999年发布。MQTT最大优点在于，可以以极少的代码和有限的带宽，为连接远程设备提供实时可靠的消息服务。作为一种低开销、低带宽占用的即时通讯协议，使其在物联网、小型设备、移动应用等方面有较广泛的应用。

MQTT特点

1． 使用发布/订阅消息模式，提供一对多的消息发布，解除应用程序耦合。该协议需要客户端和服务端，而协议中主要有三种身份：发布者（Publisher）、代理（Broker，服务器）、订阅者（Subscriber）。其中，消息的发布者和订阅者都是客户端，消息代理是服务器，而消息发布者可以同时是订阅者，实现了生产者与消费者的脱耦；
2． 对负载内容屏蔽的消息传输；
3． 使用 TCP/IP 提供网络连接；
4． 有三种消息发布服务质量：
a) “至多一次”，消息发布完全依赖底层 TCP/IP 网络。会发生消息丢失或重复。这一级别可用于如下情况，环境传感器数据，丢失一次读记录无所谓，因为不久后还会有第二次发送。
b) “至少一次”，确保消息到达，但消息重复可能会发生。
c) “只有一次”，确保消息到达一次。这一级别可用于如下情况，在计费系统中，消息重复或丢失会导致不正确的结果。
5． 小型传输，开销很小（固定长度的头部是 2 字节），协议交换最小化，以降低网络流量；
6． 使用 Last Will 和 Testament 特性通知有关各方客户端异常中断的机制。

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

MQTT传输的消息分为：主题（Topic）和负载（payload）两部分：
（1）Topic，可以理解为消息的类型，订阅者订阅（Subscribe）后，就会收到该主题的消息内容（payload）；
（2）payload，可以理解为消息的内容，是指订阅者具体要使用的内容。

MQTT广泛应用于物联网、移动互联网、智能硬件、车联网、电力能源等行业。下面我们在Python 项目中使用 paho-mqtt 客户端库 ，实现客户端与 MQTT 服务器的连接、订阅、收发消息等功能，
由于目前没有物联网设备，就在linux虚拟机中获取服务器cpu，磁盘，内存等信息来模拟获取物联网设备信息的消息发布与订阅功能。

搭建开发环境 创建/root/mymqtt 为项目根目录

首先搭建MQTT代理服务器，我们使用EMQX来做MQTT代理服务器。

1. 下载 emqx-centos7-4.2.7-x86_64.zip 文件到mymqtt目录中
   wget https://www.emqx.cn/downloads/broker/v4.2.7/emqx-centos7-4.2.7-x86_64.zip
2. 安装
   unzip emqx-centos7-4.2.7-x86_64.zip
3. 启动MQTT代理服务器
   ./emqx/bin/emqx start

4. 验证代理服务器是否正常运行
   

   ps aux | grep emqx
   image.png
   可以看到EMQX已经在运行了，MQTT代理服务器搭建成功。

搭建python环境，在mymqtt目录下创建mypy目录为python项目根目录

image.png

1. 使用pyenv 搭建python虚拟环境，并安装依赖包psutil和paho-mqtt
   image.png
2. 消息发布代码

文件名：mypub.py


#!/usr/bin/env python
#coding:utf-8

import time
import json
import psutil
import random
from paho.mqtt import client as mqtt_client

broker = '127.0.0.1'  # mqtt代理服务器地址
port = 1883
keepalive = 60     # 与代理通信之间允许的最长时间段（以秒为单位）              
topic = "/python/mqtt"  # 消息主题
client_id = f'python-mqtt-pub-{random.randint(0, 1000)}'  # 客户端id不能重复

def to_M(n):
    '''将B转换为M'''
    u = 1024 * 1024
    m = round(n / u, 2)
    return m

def get_info():
    '''获取系统硬件信息：cpu利用率，cpu个数，系统负载，内存信息等'''
    cpu_percent = psutil.cpu_percent(interval=1)
    cpu_count = psutil.cpu_count()
    sys_loadavg = [round(x / psutil.cpu_count() * 100, 2) for x in psutil.getloadavg()]
    mem = psutil.virtual_memory()
    mem_total, men_free = to_M(mem.total), to_M(mem.free)
    mem_percent = mem.percent
    info = {
        'cpu_percent': cpu_percent,
        'cpu_count' : cpu_count,
        'sys_loadavg': sys_loadavg,
        'mem_total': mem_total,
        'mem_percent': mem_percent,
        'men_free': men_free
    }
    # mqtt只能传输字符串数据
    return json.dumps(info)

def connect_mqtt():
    '''连接mqtt代理服务器'''
    def on_connect(client, userdata, flags, rc):
        '''连接回调函数'''
        # 响应状态码为0表示连接成功
        if rc == 0:
            print("Connected to MQTT OK!")
        else:
            print("Failed to connect, return code %d\n", rc)
    # 连接mqtt代理服务器，并获取连接引用
    client = mqtt_client.Client(client_id)
    client.on_connect = on_connect
    client.connect(broker, port, keepalive)
    return client

def publish(client):
    '''发布消息'''
    while True:
        '''每隔4秒发布一次服务器信息'''
        time.sleep(4)
        msg = get_info()
        result = client.publish(topic, msg)
        status = result[0]
        if status == 0:
            print(f"Send `{msg}` to topic `{topic}`")
        else:
            print(f"Failed to send message to topic {topic}")

def run():
    '''运行发布者'''
    client = connect_mqtt()
    # 运行一个线程来自动调用loop()处理网络事件, 非阻塞
    client.loop_start()
    publish(client)

if __name__ == '__main__':
    run()

3. 消息订阅代码

文件名：mysub.py


#!/usr/bin/env python
#coding:utf-8

import random
from paho.mqtt import client as mqtt_client


broker = '127.0.0.1'  # mqtt代理服务器地址
port = 1883
keepalive = 60     # 与代理通信之间允许的最长时间段（以秒为单位）              
topic = "/python/mqtt"  # 消息主题
client_id = f'python-mqtt-sub-{random.randint(0, 1000)}'  # 客户端id不能重复

def connect_mqtt():
    '''连接mqtt代理服务器'''
    def on_connect(client, userdata, flags, rc):
        '''连接回调函数'''
        # 响应状态码为0表示连接成功
        if rc == 0:
            print("Connected to MQTT OK!")
        else:
            print("Failed to connect, return code %d\n", rc)

    client = mqtt_client.Client(client_id)
    client.on_connect = on_connect
    client.connect(broker, port, keepalive )
    return client

def subscribe(client: mqtt_client):
    '''订阅主题并接收消息'''
    def on_message(client, userdata, msg):
        '''订阅消息回调函数'''
        print(f"Received `{msg.payload.decode()}` from `{msg.topic}` topic")
    # 订阅指定消息主题
    client.subscribe(topic)
    client.on_message = on_message


def run():
    # 运行订阅者
    client = connect_mqtt()
    subscribe(client)
    #  运行一个线程来自动调用loop()处理网络事件, 阻塞模式
    client.loop_forever()


if __name__ == '__main__':
    run()

4. 命令行进入python虚拟环境，启动发布者
   image.png

   可以看到发布者启动并运行成功

5. 打开第二个命令行窗口，进入虚拟环境，启动订阅者
   image.png

   可以看到订阅者启动成功，并接受到了发布者发布的消息。

至此，我们完成了使用 paho-mqtt 客户端连接到 本地MQTT 服务器并实现了测试客户端与 MQTT 服务器的连接、消息发布和订阅。