使用擴充程式功能來實現訊息訂閱 - DataWorks

DataWorks通過OpenEvent能力為您提供訊息發送訂閱能力，同時您可以將服務程式註冊為DataWorks的擴充程式，通過擴充程式來卡點並響應訂閱的事件訊息，以此實現通過擴充程式對特定事件進行訊息通知與流程管控。本文為您介紹通過OpenEvent和擴充程式，實現訊息通知與流程管控的功能概述與操作流程。

許可權說明

開放平台管理員和租用戶系統管理員擁有開發人員後台的讀寫權限，其他租戶級角色、空間級角色僅擁有開發人員背景唯讀許可權。詳情請參見全域級模組許可權控制。
僅支援阿里雲主帳號或者擁有AliyunDataWorksFullAccess許可權的RAM使用者進行介面相關配置，許可權詳情請參見產品及控制台許可權控制詳情：RAM Policy。

使用限制

目前僅面向DataWorks企業版使用者公測，華北2（北京）、華東1（杭州）、華東2（上海）、華北3（張家口）、華南1（深圳）、西南1（成都）、美國（矽谷）、美國（維吉尼亞）、德國（法蘭克福）、日本（東京）、中國（香港）、新加坡地區支援該功能。

注意事項

當DataWorks企業版到期、擴充程式被下線或禁用時，擴充程式便會失效，其控制的相關流程檢查與阻塞將不生效，相關流程系統將直接通過。
擴充程式處於測試中、已上線狀態時，不會直接生效，需工作空間管理員在管理中心、擴充程式設定頁面啟用後才會生效。
- 處於測試中狀態，僅測試工作空間可啟用。
- 處於已上線狀態，當前地區的所有工作空間均可啟用。
擴充程式在上線前需提交至DataWorks平台審核，審核通過後，方可操作上線。
說明
通常，審核將在T+3工作日內完成，請耐心等待。
擴充點事件分為租戶級和空間級，註冊擴充程式時，僅支援選擇某一類型的擴充點事件。DataWorks支援的擴充點事件所屬的類型，詳情請參見支援的擴充點事件列表。
通過Function Compute方式部署的擴充程式目前僅支援處理資料下載前置事件。

產品能力

DataWorks作為阿里雲一站式巨量資料開發與治理平台，在各項能力支援上預設了很多拓展點，例如，在標準模式下，簡略來看，節點建立後完成代碼開發後，需先提交到開發環境中進行驗證，完成後再正式發布到生產環境中，後續每天根據調度配置定時運行，如果節點不再需要，可刪除節點。產品能力

該流程中DataWorks預置了幾個擴充點，您可基於擴充點增加自訂管控流程。例如下列情境：

增加程式碼檢閱流程。
當使用者單擊提交節點時，流程進入自訂程式碼檢閱流程中，不直接提交到開發環境中進行驗證。自訂評審流程通過後再提交至開發環境。
增加發布前審核流程。
當使用者單鍵發行節點時，流程進入自訂發布前審核流程中，不直接發布到生產環境。自訂審核流程通過後，再發布至生產環境。

上述情境中的流程管控，是通過DataWorks提交檔案擴充點和發布檔案擴充點實現流程卡點，並通過您註冊在DataWorks上的擴充程式實現自訂流程管控。

在DataWorks中，您可通過如下兩種方式將自己開發的應用註冊並部署為一個擴充程式，實現自訂流程管控。

方式

描述

自建服務

通過自建服務開發部署擴充程式，並通過OpenEvent和OpenAPI進行擴充程式與DataWorks的通訊，實現自訂流程式控制制。該方式：

操作繁瑣，涉及準備機器、部署應用、網路問題營運等操作。
支援處理多種擴充點事件，詳情請參見支援的擴充點事件列表。

Function Compute

通過Function Compute開發部署擴充程式，特定事件訊息後續將直接下發至該服務。該方式：

操作簡單，僅需一個函數即可完成擴充程式的部署操作。
會產生相應Function Compute費用，詳情請參見計費概述。
部署的擴充程式目前僅支援處理資料下載前置事件。

操作流程

實現自訂管控流程的操作步驟如下：

開發部署擴充程式。
- 自建服務方式：開發部署擴充程式：自建服務方式。
- Function Compute方式：開發部署擴充程式：Function Compute方式。
同時，擴充程式為您提供的參數配置和選項配置，便於您靈活高效地使用擴充程式，應用詳情請參見進階應用程式：擴充程式參數配置、進階應用程式：擴充程式選項配置。
測試應用擴充程式。
擴充程式開發部署完成後，您即可在DataWorks的測試工作空間中測試擴充程式是否符合預期，完成測試後上線擴充程式，由管理員在使用的工作空間中啟用擴充程式。詳情請參見測試應用擴充程式。

支援的擴充點事件列表

當前支援通過擴充程式處理的擴充點事件分類及事件詳情如下表。

說明

開發部署擴充程式時，需使用以下各擴充點事件的事件編碼資訊，各事件的事件編碼詳情請參見開發參考：擴充事件編碼。
通過Function Compute部署的擴充程式目前僅支援處理資料下載前置事件。

應用範圍	系統模組	擴充點事件	回調校正結果的OpenAPI
空間級	資料開發	檔案提交前置事件檔案刪除前置事件檔案發布前置事件代碼運行前置事件表提交到開發前置事件表提交到生產前置事件說明僅標準模式工作空間支援發布相關擴充點。	您可通過UpdateIDEEventResult介面將事件處理結果回調至DataWorks。
	營運中心	節點凍結前置事件節點解凍前置事件節點下線前置事件補資料前置事件	您可通過UpdateWorkbenchEventResult介面將事件處理結果回調至DataWorks。
	資訊安全中心	建立許可權申請單前置事件	您可通過CallbackExtension介面將事件處理結果回調至DataWorks。
	資料資產	資產上架前置事件資產下架前置事件
租戶級	管理主控台	刪除專案空間前置事件
租戶級	下載中心	資料下載前置事件

以DataStudio中節點提交事件為例，流程如下圖所示。檔案提交更多擴充點的觸發應用樣本可參見應用樣本：資料開發過程觸發事件檢查、應用樣本：營運中心觸發事件檢查。