如何在 Django 项目中使用 MQTT

MQTT 是一种基于发布/订阅模式的轻量级物联网消息传输协议,可以用极少的代码和带宽为联网设备提供实时可靠的消息服务,它广泛应用于物联网、移动互联网、智能硬件、车联网、电力能源等行业。

Django 是一个开源的 Web 框架,是目前较为流行的 Python Web 框架之一。本文主要介绍如何在 Django 项目中实现 MQTT 客户端与 MQTT 服务器的连接、订阅、取消订阅、收发消息等功能。

本文将使用 paho-mqtt 客户端库编写一个简单 MQTT 客户端,paho-mqtt 是目前 Python 中使用较为广泛的 MQTT 客户端库,它在 Python 2.7 及 3.x 上为客户端提供了对 MQTT v5.0、v3.1.1 和 v3.1 的支持。

项目初始化

本项目使用 Python 3.8 进行开发测试,读者可用如下命令确认 Python 的版本。

$ python3 --version
Python 3.8.2

使用 Pip 安装 Django 和 paho-mqtt。

pip3 install django
pip3 install paho-mqtt

创建 Django 项目。

django-admin startproject mqtt-test

创建完成后目录结构如下。

├── manage.py
└── mqtt_test
    ├── __init__.py
    ├── asgi.py
    ├── settings.py
    ├── urls.py
    ├── views.py
    └── wsgi.py

paho-mqtt 使用

本文将使用 EMQ 提供的免费公共 MQTT 服务器,该服务基于 MQTT 云服务 - EMQX Cloud 创建。服务器接入信息如下:

  • Broker: broker.emqx.io
  • TCP Port: 1883
  • Websocket Port: 8083

导入 paho-mqtt

import paho.mqtt.client as mqtt

编写连接回调函数

可以在该回调函数中对 MQTT 连接成功或失败的情况进行处理,本示例将在连接成功后订阅 django/mqtt 主题。

def on_connect(mqtt_client, userdata, flags, rc):
    if rc == 0:
        print('Connected successfully')
        mqtt_client.subscribe('django/mqtt')  # 订阅主题
    else:
        print('Bad connection. Code:', rc)

编写消息回调函数

该函数将打印 django/mqtt 主题接收到的消息。

def on_message(mqtt_client, userdata, msg):
    print(f'Received message on topic: {msg.topic} with payload: {msg.payload}')

增加 Django 配置项

settings.py 中增加 MQTT 服务器的配置项。读者如果对如下配置项及本文中提到的 MQTT 相关概念有疑问,可查看博客 MQTT 协议快速体验

本示例使用匿名认证,所以用户名与密码设置为空。
MQTT_SERVER = 'broker.emqx.io'
MQTT_PORT = 1883
MQTT_KEEPALIVE = 60
MQTT_USER = ''
MQTT_PASSWORD = ''

配置 MQTT 客户端

client = mqtt.Client()
client.on_connect = on_connect
client.on_message = on_message
client.username_pw_set(settings.MQTT_USER, settings.MQTT_PASSWORD)
client.connect(
    host=settings.MQTT_SERVER,
    port=settings.MQTT_PORT,
    keepalive=settings.MQTT_KEEPALIVE
)

创建发布消息接口

我们创建一个简单的 POST 接口实现 MQTT 消息发布。

在实际应用中该接口可能需要进行一些更复杂的业务逻辑处理。

views.py 中增加如下代码。

import json
from django.http import JsonResponse
from mqtt_test.mqtt import client as mqtt_client


def publish_message(request):
    request_data = json.loads(request.body)
    rc, mid = mqtt_client.publish(request_data['topic'], request_data['msg'])
    return JsonResponse({'code': rc})

urls.py 中增加如下代码。

from django.urls import path
from . import views

urlpatterns = [
    path('publish', views.publish_message, name='publish'),
]

启动 MQTT 客户端

__init__.py 中增加如下代码。

from . import mqtt
mqtt.client.loop_start()

至此我们已完成了所有代码的编写,查看完整代码

最后,执行如下命令运行 Django 项目。

python3 manage.py runserver

当 Django 应用启动后,MQTT 客户端将会连接到 MQTT 服务器,并且订阅主题 django/mqtt

测试

接下来我们使用开源的跨平台 MQTT 客户端 - MQTT X 进行连接、订阅、发布测试。

测试消息接收

  1. 在 MQTT X 中创建 MQTT 连接,输入连接名称,其他参数保持默认,并点击右上角的 Connect 按钮连接至服务器。
    1
  2. 在 MQTT X 底部的消息发布框里向 django/mqtt 主题发布消息 Hello from MQTT X
    2
  3. 在 Django 运行窗口中将能看到 MQTT X 发送的消息。
    3

测试消息发布接口

  1. 在 MQTT X 中订阅 django/mqtt 主题。

4

  1. 使用 Postman 调用 /publish 接口:发送消息 Hello from Djangodjango/mqtt 主题。

5

  1. 在 MQTT X 中将能看到 Django 发送过来的消息。
    6

    总结

至此,我们使用 paho-mqtt 完成了 MQTT 客户端的开发,实现了在 Django 应用中使用 MQTT 进行通信。在实际应用中,我们可以根据业务需求对 MQTT 客户端进行扩展,实现更复杂的业务逻辑。接下来,读者可查看 EMQ 提供的 MQTT 入门与进阶系列文章了解 MQTT 协议特性,探索 MQTT 的更多高级应用,开始 MQTT 应用及服务开发。

版权声明: 本文为 EMQ 原创,转载请注明出处。

原文链接:[https://www.emqx.com/zh/blog/...](

EMQ(杭州映云科技有限公司)是一家开源物联网数据基础设施软件供应商,交付全球领先的开源 MQTT 消息服...

305 声望
429 粉丝
0 条评论
推荐阅读
EMQX 在 Kubernetes 中如何进行优雅升级
为了降低 EMQX 在 Kubernetes 上的部署、运维成本,我们将一些日常运维能力进行总结、抽象并整合到代码中,以 EMQX Kubernetes Operator 的方式帮助用户实现 EMQX 的自动化部署和运维。

EMQX阅读 362

什么是MircoPython?
摘要:互联网玩家为了让Python这样的容易学,简单易学、社区API丰富的语言可以在嵌入式领域用上,逐渐开始了一轮Python上嵌入式的迁移,这样就有了今天的主角——MircoPython。

华为云开发者联盟1阅读 1.3k

二、Django
Django 提示:本文根据b站黑马python课整理链接指引 => 黑马程序员python企业级开发项目-手把手从0到1开发《美多商城》MVT图解项目准备1.创建项目 {代码...} 2.创建应用 {代码...} 3.更换python解释器 {代码.....

玲小叮当阅读 951

Mysql到TiDB迁移,双写数据库兜底方案
TiDB 作为开源 NewSQL 数据库的典型代表之一,同样支持 SQL,支持事务 ACID 特性。在通讯协议上,TiDB 选择与 MySQL 完全兼容,并尽可能兼容 MySQL 的语法。因此,基于 MySQL 数据库开发的系统,大多数可以平滑迁...

京东云开发者阅读 849

封面图
三、djanjo
Django 提示:本文根据b站黑马python课整理链接指引 => 黑马程序员python企业级开发项目-手把手从0到1开发《美多商城》视图介绍和项目准备视图介绍视图就是应用中views.py文件中的函数视图的第一个参数必须为H...

玲小叮当阅读 778

Django 简介
Django简介Django 是 Python 语言的 Web 框架,开源且免费,可以用于满足快速开发网站的需求。Django 接管了 Web 开发过程中的方方面面,所以开发者可以专注于编写应用程序,而不需要重新造轮子。Django 的特点:...

Risejl阅读 749

一、Django
Django 提示:本文根据b站黑马python课整理链接指引 => 黑马程序员python企业级开发项目-手把手从0到1开发《美多商城》一、Django介绍1.1 MVT模式M全拼为Model,与MVC中的M功能相同,负责和数据库交互,进行数...

玲小叮当阅读 682

EMQ(杭州映云科技有限公司)是一家开源物联网数据基础设施软件供应商,交付全球领先的开源 MQTT 消息服...

305 声望
429 粉丝
宣传栏