[Node.js](https://nodejs.org/zh-cn/) 是一個基於 [Chrome V8 引擎](https://v8.dev/) 的 JavaScript 執行時環境。在 Node.js 出現之前，JavaScript 通常作為客戶端程式設計語言使用，以 JavaScript 寫出的程式常在使用者的瀏覽器上執行。Node.js 的出現使 JavaScript 也能用於服務端程式設計。

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

本文主要介紹如何在 Node.js 專案中使用 MQTT 實現客戶端與 MQTT 伺服器的連線、訂閱、取消訂閱、收發訊息等功能。

## MQTT 客戶端庫選擇

[MQTT.js](https://github.com/mqttjs/MQTT.js) 是一個 MQTT 協議的客戶端庫，使用 JavaScript 編寫，用於 Node.js 和 瀏覽器環境中。是 JavaScript 生態中目前使用最為廣泛的 [MQTT 客戶端庫](https://www.emqx.com/zh/blog/introduction-to-the-commonly-used-mqtt-client-library)。

## 專案初始化

### 確認 Node.js 版本

本專案使用 Node.js v14.14.0 進行開發和測試，讀者可用如下命令確認 Node.js 的版本

```shell
node --version

v14.14.0
```

### 使用 npm 安裝 MQTT.js 客戶端庫

```shell
# 新建專案
npm init -y

# 安裝依賴
npm install mqtt --save
```

完成後我們在當前目錄下新建一個 index.js 檔案作為專案的入口檔案，在該檔案中來實現 MQTT 連線測試的完整邏輯。

## Node.js MQTT 使用

### 連線 MQTT 伺服器

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

- Broker: **broker.emqx.io**（國內可以使用 broker-cn.emqx.io）
- TCP Port: **1883**
- SSL/TLS Port: **8883**

引入 MQTT.js 客戶端庫

> 注意：在 Node.js 環境中，匯入依賴模組請使用 commonjs 規範

```javascript
const mqtt = require('mqtt')
```

### 設定 MQTT Broker 的連線引數

設定 MQTT Broker 連線地址，埠以及 topic，這裡我們使用 JavaScript 中的生成隨機數的函式來生成客戶端 ID。

```javascript
const host = 'broker.emqx.io'
const port = '1883'
const clientId = `mqtt_${Math.random().toString(16).slice(3)}`
```

### 編寫 MQTT 連線函式

我們使用剛才設定的連線引數來進行連線，連線的 URL 透過上面定義的 host、port 埠來進行拼接。然後呼叫 mqtt 模組內建的 connect 函式，連線成功後返回一個 Client 例項。

```javascript
const connectUrl = `mqtt://${host}:${port}`

const client = mqtt.connect(connectUrl, {
  clientId,
  clean: true,
  connectTimeout: 4000,
  username: 'emqx',
  password: 'public',
  reconnectPeriod: 1000,
})
```

### 訂閱主題

使用返回的 Client 例項的 on 方法來監聽連線成功狀態，並在連線成功後的回撥函式中訂閱 topic。此時我們連線成功後呼叫 Client 例項的 subscribe 方法訂閱 `/nodejs/mqtt` 主題。

```javascript
const topic = '/nodejs/mqtt'
client.on('connect', () => {
  console.log('Connected')
  client.subscribe([topic], () => {
    console.log(`Subscribe to topic '${topic}'`)
  })
})
```

訂閱主題成功後，我們再使用 on 方法來監聽接收訊息的方法，當接受到訊息時，我們可以在該方法的回撥函式中獲取到 topic 和 message 訊息。

> 注意：回撥函式中的 message 是 Buffer 型別，需要使用 toString 方法將其轉化為字串

```javascript
client.on('message', (topic, payload) => {
  console.log('Received Message:', topic, payload.toString())
})
```

### 訊息釋出

完成上述的訂閱主題和訊息監聽後，我們再來編寫一個釋出訊息的方法。

> 注意：訊息釋出需要在 MQTT 連線成功以後，因此這裡我們寫到 Connect 成功的回撥函式里

```java
client.on('connect', () => {
  client.publish(topic, 'nodejs mqtt test', { qos: 0, retain: false }, (error) => {
    if (error) {
      console.error(error)
    }
  })
})
```

## 完整程式碼

伺服器連線、主題訂閱、訊息釋出與接收的程式碼。

```javascript
const mqtt = require('mqtt')

const host = 'broker.emqx.io'
const port = '1883'
const clientId = `mqtt_${Math.random().toString(16).slice(3)}`

const connectUrl = `mqtt://${host}:${port}`
const client = mqtt.connect(connectUrl, {
  clientId,
  clean: true,
  connectTimeout: 4000,
  username: 'emqx',
  password: 'public',
  reconnectPeriod: 1000,
})

const topic = '/nodejs/mqtt'
client.on('connect', () => {
  console.log('Connected')
  client.subscribe([topic], () => {
    console.log(`Subscribe to topic '${topic}'`)
  })
  client.publish(topic, 'nodejs mqtt test', { qos: 0, retain: false }, (error) => {
    if (error) {
      console.error(error)
    }
  })
})
client.on('message', (topic, payload) => {
  console.log('Received Message:', topic, payload.toString())
})
```

專案完整程式碼請見：[https://github.com/emqx/MQTT-Client-Examples/tree/master/mqtt-client-Node.js](https://github.com/emqx/MQTT-Client-Examples/tree/master/mqtt-client-Node.js)

## 測試

我們在 package.json 檔案中的指令碼欄位中新增一行啟動指令碼。

```json
"scripts": {
  "start": "node index.js"
}
```

然後就可以簡單使用 `npm start` 來執行專案。

```shell
npm start
```

執行後我們可以看到控制的輸出資訊如下：

![NodeJS MQTT 啟動](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/a9c720b0af774db6adb00e71d2418500~tplv-k3u1fbpfcp-zoom-1.image)

我們看到了客戶端已經成功連線到 [MQTT 伺服器](https://www.emqx.io/zh)並且訂閱主題、接收和釋出訊息成功。此時我們再使用 [MQTT 5.0 客戶端工具 - MQTT X](https://mqttx.app/zh) 作為另一個客戶端進行訊息收發測試。

![MQTT 5.0 客戶端工具 - MQTT X](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/09c2adaf30624eec9c3811c150c3aa15~tplv-k3u1fbpfcp-zoom-1.image)

可以看到控制檯內列印出了 MQTT X 傳送過來的訊息。

![控制檯接收到 MQTT X 傳送的訊息](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/96b5d48aea3149169d9520c51a59116d~tplv-k3u1fbpfcp-zoom-1.image)

至此，我們完成了使用 Node.js 來作為 MQTT 客戶端連線到[公共 MQTT 伺服器](https://www.emqx.com/zh/mqtt/public-mqtt5-broker)，並實現了測試客戶端與 MQTT 伺服器的連線、訊息釋出和訂閱。

> 版權宣告： 本文為 EMQ 原創，轉載請註明出處。
>
> 原文連結：<https:>
>
> 技術支援：如對本文或 EMQ 相關產品有疑問，可訪問 EMQ 問答社群 <https:> 提問，我們將會及時回覆支援。
>
> 更多技術乾貨，歡迎關注我們公眾號【EMQ 中文社群】。</https:></https:>

如何在 Node.js 專案中使用 MQTT

相關文章