全部產品
Search
文件中心

DataWorks:附錄:DataWorks開放平台範例程式碼庫

更新時間:Jun 19, 2024

為方便您更好的理解和使用開放平台的各項功能,如開放API(OpenAPI)、開放事件(OpenEvent)、擴充程式(Extensions),DataWorks開放平台將您提供了相關應用情境的範例程式碼。本文將為您介紹如何在本地運行從GitHub擷取的範例程式碼,以此來展示DataWorks整合在各類業務情境中的開放能力。

背景資訊

DataWorks開放平台是DataWorks對外提供資料和能力的開放通道。開放平台提供了開放API(OpenAPI)、開放事件(OpenEvent)、擴充程式(Extensions)等能力,協助您快速實現各類應用系統對接DataWorks,以便進行資料流程管控、資料治理和資料營運,並及時響應各類應用系統的業務狀態變化。更多開放平台的介紹,請參見開放平台概覽

工程初始化

步驟一:準備開發環境

  1. 安裝Java JDK。

    安裝Java JDK(Java開發套件),您可在Oracle官方網站,下載與您作業系統相容的Java JDK版本。

    說明

    本樣本中使用的JDK需是Java 1.8或以上版本。安裝成功後,開啟命令提示字元或終端,執行java -version命令查看Java語言版本。

  2. 安裝Maven。

    Maven是Java的運行環境工具。您可在Maven官方網站,下載與您作業系統相容的Maven下載包。下載完成後,可以參考安裝 Apache Maven來解壓並安裝Maven。

  3. 安裝Node。

    本樣本涉及前端頁面的示範,因此需要您在用戶端安裝Node環境來執行JavaScript代碼。下載Node,您可在Node官方網站下載並安裝Node環境。

    說明

    本樣本中使用的Node版本需在14以上版本。安裝成功後,開啟命令提示字元或終端,執行node --version命令查看Node.js版本。

  4. 安裝pnpm。

    pnpm是用於JavaScript專案的包管理工具。本樣本庫使用了工作空間模式(避免一些公用群組件發包到npm上),所以需要您安裝此工具。您可點擊安裝pnpm教程安裝pnpm工具,若您已經安裝了Node,可以直接執行以下命令完成工具安裝:

    npm install -g pnpm
  5. 檢查開發環境。

    完成上述步驟,您可執行以下命令來檢查本樣本中所需的環境是否安裝成功。

    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錯誤。

步驟二:執行範例程式碼

  1. 安裝依賴。

    準備好開發環境後,您可以下載本樣本工程到本地,然後執行下面代碼安裝依賴。

    pnpm install
  2. 輸入您的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
  3. 運行樣本。

    完成上述配置後,您可以通過以下命令列來啟動樣本。

    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 // 運行任務發布封網管控的樣本
  4. 查看運行結果。

    完成運行後,您可以在網頁瀏覽器中檢查結果。

    • 對於帶有互動式前端頁面的樣本,您可以使用以下URL訪問:

      https://localhost:8080
    • 對於只有後端的樣本,您可以使用以下URL訪問:

      http://localhost:8008

擷取應用情境範例程式碼

您可從開放平台範例程式碼庫擷取如下情境的範例程式碼: