MQTT v5 帶來了很多新的特性，我們會盡量以通俗易懂的方式展示這些特性，並探討這些特性對開發者的影響。到目前為止，我們已經探討過這些 [MQTT v5 新特性](https://www.emqx.com/zh/mqtt/mqtt5)，今天我們將繼續討論： **使用者屬性**。

## 什麼是使用者屬性

使用者屬性（User Properties）其實是一種自定義屬性，允許使用者向 MQTT 訊息新增自己的後設資料，傳輸額外的自定義資訊以擴充更多應用場景。

它由一個使用者自定義的 UTF-8 的鍵/值對陣列組成，並在訊息屬性欄位中配置，只要不超過最大的訊息大小，可以使用無限數量的使用者屬性來向 MQTT 訊息新增後設資料，並在釋出者、MQTT 伺服器和訂閱者之間傳遞資訊。

如果你熟悉 HTTP 協議的話，該功能與 HTTP 的 Header 的概念非常類似。使用者屬性有效地允許使用者擴充套件 MQTT 協議，並且可以出現在所有訊息和響應中。因為使用者屬性是由使用者定義的，它們只對該使用者的實現有意義。

## 為什麼需要使用使用者屬性

MQTT 3 的協議擴充套件效能力較差，使用者屬性其實就是為了解決這個問題，它支援在訊息中傳遞任何資訊，確保了使用者可擴充套件標準協議的功能。

對於選擇和配置不同的訊息型別，使用者屬性可以在客戶端與 MQTT  伺服器之間，或者客戶端和客戶端之間傳送。在連線客戶端中配置使用者屬性時，只能在 MQTT  伺服器上接收，無法在客戶端中接收。如果在傳送訊息的時候配置使用者屬性，則可以在其它客戶端中接收。常用的有以下兩種使用者屬性配置。

### 連線客戶端的使用者屬性

當客戶端與 MQTT 伺服器發起連線時，伺服器可以預先定義好一些需要並且可以使用到的後設資料資訊，即使用者屬性，當連線成功後，MQTT 服務可以拿到連線傳送過來的相關資訊進行使用，因此連線客戶端的使用者屬性依賴於 MQTT 伺服器。

### 訊息釋出的使用者屬性

訊息釋出時的使用者屬性可能是較為常用的，因為它們可以在客戶端與客戶端之間進行後設資料資訊傳遞。比如可以在釋出時新增一些常見的資訊：訊息編號，時間戳，檔案，客戶端資訊和路由資訊等屬性。

除上述較為常用的使用者屬性設定外，還可以在訂閱 Topic 時，取消訂閱時，斷開連線時配置使用者屬性。

## 使用者屬性的使用

### 檔案傳輸

MQTT 5 的使用者屬性，可擴充套件為使用其進行檔案傳輸，而不是像之前的 MQTT 3 中將資料放到訊息體的 Payload 中，使用者屬性使用鍵值對的方式。這也意味著檔案可以保持為二進位制，因為檔案的後設資料在使用者屬性中。例如：

```json
{
  "filename": "test.txt",
  "content": "xxxx"
}
```

### 資源解析

當客戶端連線到 MQTT  伺服器後，不同的客戶端、供應商平臺或系統存在著不同的方式傳遞訊息資料，訊息資料的格式可能都存在著一些結構差異。還有一些客戶端是分佈在不同的地域下。比如：地域 A 的裝置傳送的訊息格式是 JSON 的，地域 B 的裝置傳送的是 XML  的，此時伺服器接收到訊息後可能需要一一進行判斷和對比，找到合適的解析器來進行資料解析。

此時為了提高效率和減少計算負載，我們可以利用使用者屬性功能來新增資料格式資訊和地域資訊，當伺服器接收到訊息後，可以使用使用者屬性中提供的後設資料來進行資料解析操作。並且當區域 A 的客戶端訂閱接收到來自區域 B 的客戶端訊息時，也能快速的清楚特定的訊息的來自於哪個區域等，從而使的訊息具有了可追溯性。

```json
{
  "region": "A",
  "type": "JSON"
}
```

![MQTT 資源解析](http://img.blog.itpub.net/blog/2021/11/30/6852b951ddd66a31.png?x-oss-process=style/bb "MQTT 資源解析")

### 訊息路由

我們還可以使用使用者屬性來做應用層級別的路由。如上所述，存在著不同的系統和平臺，每個區域存在著不同的裝置，多個系統可能收到同一個裝置的訊息，有些系統需要將資料進行實時的展示，另一個系統可能將這些資料進行時序儲存。因此 MQTT 伺服器可以透過上報訊息中配置的使用者屬性來確定將訊息分發到儲存訊息的系統還是展示資料的系統。

```json
{
  "type": "real-time",
  "timestamp": 1636620444
}
```

![MQTT 訊息路由](http://img.blog.itpub.net/blog/2021/11/30/7c99d4640bfa5de8.png?x-oss-process=style/bb "MQTT 訊息路由")

## 在客戶端中配置使用者屬性

我們以 JavaScript 環境為例，使用 [MQTT.js](https://github.com/mqttjs/MQTT.js) 客戶端來進行程式設計。

> 注意：在連線客戶端時需指定 MQTT 的版本 `protocolVersion`  為 5。

### 連線

我們在連線時的 options 中設定 properties 的 User Properties 屬性，新增 type 和 region 屬性。連線成功後，MQTT 伺服器將收到這個使用者自定義的資訊。

```pgsql
// connect options
const OPTIONS = {
  clientId: 'mqtt_test',
  clean: true,
  connectTimeout: 4000,
  username: 'emqx',
  password: 'public',
  reconnectPeriod: 1000,
  protocolVersion: 5,
  properties: {
    userProperties: {
      region: 'A',
      type: 'JSON',
    },
  },
}
const client = mqtt.connect('mqtt://broker.emqx.io', OPTIONS)
```

### 釋出訊息

連線成功後釋出訊息，釋出訊息的配置中設定使用者屬性，並且監聽訊息接收。在 publish 函式中，我們配置 user properties 屬性，並在接收訊息的函式中列印 packet。

```moonscript
client.publish(topic, 'nodejs mqtt test', {
  qos: 0,
  retain: false,
  properties: {
    userProperties: {
      region: 'A',
      type: 'JSON',
    },
  },
}, (error) => {
  if (error) {
    console.error(error)
  }
})
client.on('message', (topic, payload, packet) => {
  console.log('packet:', packet)
  console.log('Received Message:', topic, payload.toString())
})
```

此時我們看到控制檯中已經列印並輸出了剛才傳送時所配置的使用者屬性。

![MQTT 訊息接收](http://img.blog.itpub.net/blog/2021/11/30/29815f19d418c942.png?x-oss-process=style/bb "MQTT 訊息接收")

對於其它客戶端，我們將在[跨平臺 MQTT 5.0 桌面客戶端工具 - MQTT X](https://mqttx.app/zh) 的後續版本中支援使用者屬性的自定義配置，方便使用者快速測試 MQTT 5.0 的一些新特性，敬請期待！

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

使用者屬性 - MQTT 5.0 新特性

相關文章