文档

附录:DataWorks开放平台示例代码库

更新时间:

为方便您更好的理解和使用开放平台的各项功能,如开放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

获取应用场景示例代码

您可从开放平台示例代码库获取如下场景的示例代码:

  • 本页导读 (1)