為方便您更好的理解和使用開放平臺的各項功能,如開放API(OpenAPI)、開放事件(OpenEvent)、擴展程序(Extensions),DataWorks開放平臺將您提供了相關應用場景的示例代碼。本文將為您介紹如何在本地運行從GitHub獲取的示例代碼,以此來展示DataWorks集成在各類業務場景中的開放能力。
背景信息
DataWorks開放平臺是DataWorks對外提供數據和能力的開放通道。開放平臺提供了開放API(OpenAPI)、開放事件(OpenEvent)、擴展程序(Extensions)等能力,幫助您快速實現各類應用系統對接DataWorks,以便進行數據流程管控、數據治理和數據運維,并及時響應各類應用系統的業務狀態變化。更多開放平臺的介紹,請參見開放平臺概覽。
工程初始化
步驟一:準備開發環境
安裝Java JDK。
安裝Java JDK(Java開發工具包),您可在Oracle官方網站,下載與您操作系統兼容的Java JDK版本。
說明本示例中使用的JDK需是Java 1.8或以上版本。安裝成功后,打開命令提示符或終端,執行
java -version
命令查看Java語言版本。安裝Maven。
Maven是Java的運行環境工具。您可在Maven官方網站,下載與您操作系統兼容的Maven下載包。下載完成后,可以參考安裝 Apache Maven來解壓并安裝Maven。
安裝Node。
本示例涉及前端頁面的演示,因此需要您在客戶端安裝Node環境來執行JavaScript代碼。下載Node,您可在Node官方網站下載并安裝Node環境。
說明本示例中使用的Node版本需在14以上版本。安裝成功后,打開命令提示符或終端,執行
node --version
命令查看Node.js版本。安裝pnpm。
pnpm是用于JavaScript項目的包管理工具。本示例庫使用了工作空間模式(避免一些公用組件發包到npm上),所以需要您安裝此工具。您可點擊安裝pnpm教程安裝pnpm工具,若您已經安裝了Node,可以直接執行以下命令完成工具安裝:
npm install -g pnpm
檢查開發環境。
完成上述步驟,您可執行以下命令來檢查本示例中所需的環境是否安裝成功。
java -version //若Java JDK安裝成功,此命令將顯示Java JDK的版本號,否則會報command not found錯誤。 mvn -v //若Maven安裝成功,此命令將顯示Maven的版本號,否則會報command not found錯誤。 npm -v //若Node安裝成功,此命令將顯示Node.js的版本號,否則會報command not found錯誤。 pnpm -v //若pnpm安裝成功,此命令將顯示pnpm的版本號,否則會報command not found錯誤。
步驟二:執行示例代碼
安裝依賴。
準備好開發環境后,您可以下載本示例工程到本地,然后執行下面代碼安裝依賴。
pnpm install
輸入您的Access Key和Secret Key。
安裝成功后,您需要在根目錄中找到application.properties配置文件。在此文件中您需要填寫Access Key (AK)、Secret Key (SK)、Region-id、endpoint等關鍵信息。這些信息將會在工程啟動時被讀取并同步到每個應用示例中。
說明工程運行過程時,將利用您在配置文件中輸入的關鍵信息,以此連接您訪問DataWorks的開放能力。
## 調用子賬號的AccessKey Id api.access-key-id={access-key} ## 調用賬號的AccessKey Secret api.access-key-secret={secret-key} ## dataworks服務所在的reigonId cn-shanghai/cn-hangzhou # api.region-id=cn-hangzhou api.region-id={regionId} ## dataworks openapi的product 默認是dataworks-public api.product=dataworks-public ## dataworks openapi的endpoint地址 ## 默認公網訪問dataworks.${regionId}.aliyuncs.com ## VPC訪問dataworks-vpc.${regionId}.aliyuncs.com # api.endpoint=dataworks.cn-hangzhou.aliyuncs.com api.endpoint={endpoint} ## 指定網絡環境,公網訪問設置為false,vpc則為true api.vpc-env=false
運行示例。
完成上述配置后,您可以通過以下命令行來啟動示例。
npm run example:workbench-screen // 運行運維中心示例 npm run example:meta-api // 運行元數據示例 npm run example:event-instance-status // 運行訂閱示例狀態變更消息的示例 npm run example:extension-maxpt // 運行禁止使用MAX_PT函數的示例 npm run example:extension-deploy-control // 運行任務發布封網管控的示例
查看運行結果。
完成運行后,您可以在網頁瀏覽器中檢查結果。
對于帶有交互式前端頁面的示例,您可以使用以下URL訪問:
https://localhost:8080
對于只有后端的示例,您可以使用以下URL訪問:
http://localhost:8008
獲取應用場景示例代碼
您可從開放平臺示例代碼庫獲取如下場景的示例代碼: