[Flask](https://flask.palletsprojects.com/en/2.1.x/) 是一個使用 Python 編寫的輕量級 Web 應用框架，其被稱為 “微框架”，因為它使用簡單的核心，用擴充套件增加其他功能，例如：ORM、窗體驗證工具、檔案上傳、各種開放式身份驗證技術等。

[MQTT](https://www.emqx.com/zh/mqtt) 是一種基於釋出/訂閱模式的 輕量級物聯網訊息傳輸協議 ，可以用極少的程式碼和頻寬為聯網裝置提供實時可靠的訊息服務，它廣泛應用於物聯網、移動網際網路、智慧硬體、車聯網、電力能源等行業。

本文主要介紹如何在 Flask 專案中實現 [MQTT 客戶端](https://www.emqx.com/zh/blog/introduction-to-the-commonly-used-mqtt-client-library)與 [MQTT 伺服器](https://www.emqx.io/zh)的連線、訂閱、取消訂閱、收發訊息等功能。

我們將使用到 [Flask-MQTT](https://flask-mqtt.readthedocs.io/en/latest/index.html) 客戶端庫 ，它是一個 Flask 擴充套件，可以看作一個 [paho-mqtt](https://www.eclipse.org/paho/clients/python/) 的裝飾器，用於簡化 Flask 應用程式中的 MQTT 整合。

## 專案初始化

本專案使用 Python 3.8 進行開發測試，讀者可用如下命令確認 Python 的版本。

```vim
$ python3 --version
Python 3.8.2
```

使用 Pip 安裝 Flask-MQTT 庫

```cmake
pip3 install flask-mqtt
```

## Flask-MQTT 使用

本文將使用 EMQ 提供的[免費公共 MQTT 伺服器](https://www.emqx.com/zh/mqtt/public-mqtt5-broker)，該服務基於 [MQTT 雲服務 - EMQX Cloud](https://www.emqx.com/en/cloud) 建立。伺服器接入資訊如下：

- Broker: `broker.emqx.io`
- TCP Port: `1883`
- Websocket Port: `8083`

### 匯入 Flask-MQTT

匯入 Flask 庫以及 Flask-MQTT 擴充套件，並建立 Flask 應用

```angelscript
from flask import Flask, request, jsonify
from flask_mqtt import Mqtt

app = Flask(__name__)
```

### 配置 Flask-MQTT 擴充套件

```clean
app.config['MQTT_BROKER_URL'] = 'broker.emqx.io'
app.config['MQTT_BROKER_PORT'] = 1883
app.config['MQTT_USERNAME'] = ''  # 當你需要驗證使用者名稱和密碼時，請設定該項
app.config['MQTT_PASSWORD'] = ''  # 當你需要驗證使用者名稱和密碼時，請設定該項
app.config['MQTT_KEEPALIVE'] = 5  # 設定心跳時間，單位為秒
app.config['MQTT_TLS_ENABLED'] = False  # 如果你的伺服器支援 TLS，請設定為 True
topic = '/flask/mqtt'

mqtt_client = Mqtt(app)
```

完整的配置項可以參考 [Flask-MQTT 配置文件](https://flask-mqtt.readthedocs.io/en/latest/configuration.html)。

### 編寫連線回撥函式

可以在該回撥函式中對 MQTT 連線成功或失敗的情況進行處理，本示例將在連線成功後訂閱 `/flask/mqtt` 主題。

```python
@mqtt_client.on_connect()
def handle_connect(client, userdata, flags, rc):
   if rc == 0:
       print('Connected successfully')
       mqtt_client.subscribe(topic) # 訂閱主題
   else:
       print('Bad connection. Code:', rc)
```

### 編寫訊息回撥函式

該函式將列印 `/flask/mqtt` 主題接收到的訊息。

```routeros
@mqtt_client.on_message()
def handle_mqtt_message(client, userdata, message):
   data = dict(
       topic=message.topic,
       payload=message.payload.decode()
  )
   print('Received message on topic: {topic} with payload: {payload}'.format(**data))
```

### 建立釋出訊息介面

我們建立一個簡單的 POST 介面實現 MQTT 訊息釋出。

> 在實際應用中該介面可能需要進行一些更復雜的業務邏輯處理。

```ruby
@app.route('/publish', methods=['POST'])
def publish_message():
   request_data = request.get_json()
   publish_result = mqtt_client.publish(request_data['topic'], request_data['msg'])
   return jsonify({'code': publish_result[0]})
```

### 執行 Flask 應用

```routeros
if __name__ == '__main__':
   app.run(host='127.0.0.1', port=5000)
```

當 Flask 應用啟動後，MQTT 客戶端將會連線到伺服器，並且訂閱主題 `/flask/mqtt`。

## 測試

接下來我們使用 [MQTT 客戶端 - MQTT X](https://mqttx.app/zh) 進行連線、訂閱、釋出測試。

### 測試訊息接收

1. 在 MQTT X 中建立連結並連線到伺服器。

[![MQTT X 中建立連結](http://img.blog.itpub.net/blog/2022/05/17/bd7fe7c5650a0221.png?x-oss-process=style/bb "MQTT X 中建立連結")](https://www.emqx.com/zh/blog/how-to-use-mqtt-in-flask "MQTT X 中建立連結")

2. 在 MQTT X 中向 `/flask/mqtt` 主題釋出訊息 `Hello from MQTT X`。

[![MQTT X 訊息釋出](http://img.blog.itpub.net/blog/2022/05/17/4946b56462b48899.png?x-oss-process=style/bb "MQTT X 訊息釋出")](https://www.emqx.com/zh/blog/how-to-use-mqtt-in-flask "MQTT X 訊息釋出")

3. 在 Flask 執行視窗中將能看到 MQTT X 傳送的訊息。

[![Flask 接收 MQTT 訊息](http://img.blog.itpub.net/blog/2022/05/17/64473591df8b2c1f.png?x-oss-process=style/bb "Flask 接收 MQTT 訊息")](https://www.emqx.com/zh/blog/how-to-use-mqtt-in-flask "Flask 接收 MQTT 訊息")

### 測試訊息釋出介面

1. 在 MQTT X 中訂閱 `/flask/mqtt` 主題。

[![MQTT X 訂閱主題](http://img.blog.itpub.net/blog/2022/05/17/223454574794f5e4.png?x-oss-process=style/bb "MQTT X 訂閱主題")](https://www.emqx.com/zh/blog/how-to-use-mqtt-in-flask "MQTT X 訂閱主題")

2. 使用 Postman 呼叫 `/publish` 介面：傳送訊息 `Hello from Flask` 至 `/flask/mqtt` 主題。

[![Postman 呼叫釋出介面](http://img.blog.itpub.net/blog/2022/05/17/6b9d993e09ca65be.png?x-oss-process=style/bb "Postman 呼叫釋出介面")](https://www.emqx.com/zh/blog/how-to-use-mqtt-in-flask "Postman 呼叫釋出介面")

3. 在 MQTT X 中將能看到 Flask 傳送過來的訊息。

[![Flask 釋出 MQTT 訊息](http://img.blog.itpub.net/blog/2022/05/17/24727d0d9180e0bf.png?x-oss-process=style/bb "Flask 釋出 MQTT 訊息")](https://www.emqx.com/zh/blog/how-to-use-mqtt-in-flask "Flask 釋出 MQTT 訊息")

### 完整程式碼

```python
from flask import Flask, request, jsonify
from flask_mqtt import Mqtt

app = Flask(__name__)

app.config['MQTT_BROKER_URL'] = 'broker.emqx.io'
app.config['MQTT_BROKER_PORT'] = 1883
app.config['MQTT_USERNAME'] = ''  # 當你需要驗證使用者名稱和密碼時，請設定該項
app.config['MQTT_PASSWORD'] = ''  # 當你需要驗證使用者名稱和密碼時，請設定該項
app.config['MQTT_KEEPALIVE'] = 5  # 設定心跳時間，單位為秒
app.config['MQTT_TLS_ENABLED'] = False  # 如果你的伺服器支援 TLS，請設定為 True
topic = '/flask/mqtt'

mqtt_client = Mqtt(app)

@mqtt_client.on_connect()
def handle_connect(client, userdata, flags, rc):
   if rc == 0:
       print('Connected successfully')
       mqtt_client.subscribe(topic)
   else:
       print('Bad connection. Code:', rc)

@mqtt_client.on_message()
def handle_mqtt_message(client, userdata, message):
   data = dict(
       topic=message.topic,
       payload=message.payload.decode()
  )
   print('Received message on topic: {topic} with payload: {payload}'.format(**data))

@app.route('/publish', methods=['POST'])
def publish_message():
   request_data = request.get_json()
   publish_result = mqtt_client.publish(request_data['topic'], request_data['msg'])
   return jsonify({'code': publish_result[0]})

if __name__ == '__main__':
   app.run(host='127.0.0.1', port=5000)
```

## 注意事項

Flask-MQTT 目前不適合使用多個工作例項，如果您需要使用 *gevent* 或 *gunicorn* 這樣的 WSGI 伺服器，請確保只有一個工作例項。

## 總結

至此，我們使用 Flask-MQTT 完成了簡單的 MQTT 客戶端，並且可以在 Flask 應用中訂閱、釋出訊息。

>版權宣告： 本文為 EMQ 原創，轉載請註明出處。
>
>原文連結：[https://www.emqx.com/zh/blog/how-to-use-mqtt-in-flask](https://www.emqx.com/zh/blog/how-to-use-mqtt-in-flask)

如何在 Flask 專案中使用 MQTT

相關文章