物聯網場景中，各類裝置終端的種類繁雜，所使用的通訊協議各異，從而使得應用層的資料格式也各不相同。為了幫助使用者實現統一資料格式，**[EMQX Cloud](https://www.emqx.com/zh/cloud) 最近推出了自定義函式功能**：根據使用者自定義的指令碼對裝置上報的資料進行預處理，並將指令碼返回的任意符合使用者使用場景需求型別的資料流流轉至訊息訂閱方。

這一功能可用於多種裝置端上報資料預處理場景，如將指定範圍內的資料進行資料持久化，或是將非標準格式資料處理為符合應用標準的格式，以便應用層直接使用等。在[之前的文章](https://www.emqx.com/zh/blog/data-codec-using-custom-functions)中，我們以資料編解碼、格式處理與業務告警等場景為例，向大家介紹了自定義函式是如何在具體業務場景中發揮價值的。

在本篇文章中，我們將對這一功能的使用操作進行詳細講解，幫助大家更好地在實際專案中快速使用。

[![1](http://img.blog.itpub.net/blog/2022/12/22/85604029ca5b7061.png?x-oss-process=style/bb "1")](https://www.emqx.com/zh/blog/emqx-cloud-custom-functions "1")

## 開通自定義函式

自定義函式功能為 EMQX Cloud 增值服務，目前僅在專業版提供，且使用者需要建立在阿里雲（張家口之外的地區）的專業版部署開通該增值服務。

您可以透過以下兩個入口開通自定義函式。

**方式一**：登入 EMQX Cloud 控制檯，在頂部選單欄點選「增值服務」，找到自定義函式，點選「開通服務」，並在提示彈框中點選確認。

[![2](http://img.blog.itpub.net/blog/2022/12/22/04f81c362a9f997e.png?x-oss-process=style/bb "2")](https://www.emqx.com/zh/blog/emqx-cloud-custom-functions "2")

**方式二**：在部署詳情頁面的左側選單欄找到「自定義函式」並點選「開通服務」，並在提示彈框中點選確認。

[![3](http://img.blog.itpub.net/blog/2022/12/22/bb4a8f6ce9b216e6.png?x-oss-process=style/bb "3")](https://www.emqx.com/zh/blog/emqx-cloud-custom-functions "3")

選擇您需要開通自定義函式服務的部署（注：僅阿里雲專業版非張家港區域部署可開通）

[![4](http://img.blog.itpub.net/blog/2022/12/22/1c31184a4b95a3e9.png?x-oss-process=style/bb "4")](https://www.emqx.com/zh/blog/emqx-cloud-custom-functions "4")

在完成服務開通流程後， 等待約 2-3 分鐘即可開通配置成功。

[![5](http://img.blog.itpub.net/blog/2022/12/22/99b95ede733e6167.png?x-oss-process=style/bb "5")](https://www.emqx.com/zh/blog/emqx-cloud-custom-functions "5")

**計費說明**

自定義函式服務主要透過函式的呼叫次數來計算費用，計費規則如下：

1. **建立函式不收取任何費用**，一個部署下可以建立最多 **20** 個函式。
2. 成功建立的函式將在資料整合的規則當中被引用和呼叫，**每成功呼叫一次**計入一次呼叫次數。
3. 每一個建立了函式計算的部署，**每月**都將獲得 **5 萬次的免費呼叫次數**，免費呼叫次數將在**每月初更新**。
4. 當月的免費呼叫次數用完之後，將會以 **¥0.03 / 萬次**的價格在帳戶餘額中扣取，費用可以在滿 1 萬次的時間點小時賬單中檢視到。
5. 呼叫次數將會在每月底進行重置，不足 1 萬次以 1 萬次計價。

計費示例：

某使用者當月呼叫次數為 506,500 次，扣除免費的 5 萬次呼叫次數，付費呼叫次數為 456,500 次，前 450,000 次計費為 45 * ¥ 0.03 = ¥ 1.35 收費，最後的 6500 次由於不足 1 萬次，將在月底以 1 萬次的價格（0.03）進行結算，所以當月的總費用為 ¥ 1.38。

## 使用自定義函式

功能開通成功後，您可以透過下列流程配置使用自定義函式。

1、點選「新建」，建立函式，並設定自定義函式資料轉化規則。

[![6](http://img.blog.itpub.net/blog/2022/12/22/b220476a4c6b0c79.png?x-oss-process=style/bb "6")](https://www.emqx.com/zh/blog/emqx-cloud-custom-functions "6")

2、輸入函式名稱，該名稱將在之後建立的規則中被引用，一旦建立後，該名稱將不可修改。

[![7](http://img.blog.itpub.net/blog/2022/12/22/594a687728870464.png?x-oss-process=style/bb "7")](https://www.emqx.com/zh/blog/emqx-cloud-custom-functions "7")

3、在指令碼輸入框中輸入 JS 指令碼函式

- 指令碼函式的入口函式名稱為 codec，**入口函式名稱不能改變**；
- 輸入引數為 payload，在規則中呼叫函式時候輸入的引數；
- codec 函式中需要返回函式運算之後的值，無 return 值將無法透過測試；
- 指令碼執行時間**不能超過 3 秒**，否則將無法透過驗證，不建議在指令碼中編寫高耗時的操作；
- 自定義函式支援 ECMAScript 5.1 及部分 ECMAScript 6 的語法，請參考以下 ES6 方法箭頭函式
  - Promise
  - 解構符
  - Class
  - 模版符號

4、選擇 payload 輸入型別，目前自定義函式支援 3 種資料型別的輸入：Byte、JSON、字串。

[![8](http://img.blog.itpub.net/blog/2022/12/22/3b45d52c63e567e0.png?x-oss-process=style/bb "8")](https://www.emqx.com/zh/blog/emqx-cloud-custom-functions "8")

具體轉化示例請參考自定義函式幫助文件：[建立函式](https://docs.emqx.com/zh/cloud/latest/vas/codec.html#)

5、新建成功後，可按照函式名稱、狀態搜尋找到設定好的自定義函式，可進行修改、刪除操作。

[![9](http://img.blog.itpub.net/blog/2022/12/22/b7876bfb42807f88.png?x-oss-process=style/bb "9")](https://www.emqx.com/zh/blog/emqx-cloud-custom-functions "9")

6、呼叫函式

函式定義完成後，您可在資料整合的規則中進行呼叫。

如果需要快速驗證自定義函式指令碼是否成功配置，您可以透過新建空動作呼叫定義好的函式。

具體呼叫規範可檢視：[呼叫函式](https://docs.emqx.com/zh/cloud/latest/vas/codec.html#)

7、檢查錯誤日誌

您可以在日誌模組中篩選自定義函式相關的錯誤日誌進行檢視，根據錯誤日誌提示快速定位自定義函式配置的錯誤並解決問題。

[![10](http://img.blog.itpub.net/blog/2022/12/22/6431bd35c39bf592.png?x-oss-process=style/bb "10")](https://www.emqx.com/zh/blog/emqx-cloud-custom-functions "10")
關於更多可檢視：[自定義函式場景案例](https://docs.emqx.com/zh/cloud/latest/vas/codec_demo.html)

## 結語

透過本文，使用者可以使用自定義函式這一最新功能實現滿足自身需求的物聯網資料格式轉換，更加輕鬆地為上層應用提供資料支援。目前自定義函式功能已開放免費試用，我們期待您的反饋！

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

EMQX Cloud 自定義函式實現多種 IoT 資料形式的靈活轉化

相關文章