DataWorksオープン プラットフォームは、OpenAPI、OpenEvent、Extensionsなど、オープン プラットフォームのさまざまな機能をより深く理解し、活用できるように、関連アプリケーション シナリオのサンプル コードを提供しています。このトピックでは、GitHubから取得したサンプル コードをオンプレミス マシンで実行して、さまざまなビジネス シナリオにおけるDataWorksのオープン性を示す方法について説明します。
背景情報
DataWorksオープン プラットフォームは、OpenAPI、OpenEvent、Extensionsモジュールを提供しています。これらのモジュールを使用して、DataWorksをアプリケーションと統合し、イベント メッセージをサブスクライブできます。これらのモジュールを使用すると、さまざまなアプリケーション システムをDataWorksと相互接続して、データ プロセス制御、データ ガバナンス、データ運用保守を行うことができます。また、これらのモジュールを使用すると、さまざまなアプリケーション システムのビジネス ステータスの変化にできるだけ早く対応できます。オープン プラットフォームの詳細については、オープン プラットフォームをご参照ください。
プロジェクトの初期化
ステップ 1: 開発環境を準備する
Java Development Kit(JDK)をインストールします。
JDKをインストールするには、Oracleの公式 Webサイトにアクセスし、お使いのオペレーティング システムと互換性のあるバージョンのJDKをダウンロードします。
説明この例では、JDKバージョンは Java 1.8以降である必要があります。インストールが完了したら、コマンド プロンプトまたはターミナルを起動し、
java -version
コマンドを実行してJavaバージョンを確認します。Mavenをインストールします。
MavenはJavaランタイム環境ツールです。Mavenの公式 Webサイトにアクセスし、お使いのオペレーティング システムと互換性のあるMavenパッケージをダウンロードできます。ダウンロードが完了したら、Apache Mavenのインストールを参照して、パッケージを解凍し、Mavenをインストールします。
Node.jsをインストールします。
この例では、フロントエンド ページが使用されています。そのため、JavaScriptコードを実行するには、クライアントにNode.js環境をインストールする必要があります。Node.js環境をインストールするには、Node.jsの公式 Webサイトにアクセスし、Node.js環境をダウンロードします。
説明この例では、Node.jsのバージョンは 14以降である必要があります。インストールが完了したら、コマンド プロンプトまたはターミナルを起動し、
node --version
コマンドを実行してNode.jsバージョンを確認します。pnpmをインストールします。
pnpmは、JavaScriptプロジェクトのパッケージ管理ツールです。この例では、サンプル コード ライブラリは ワークスペース モードを使用して、共通コンポーネントがnpmに送信されないようにしています。そのため、pnpmをインストールする必要があります。インストールをクリックして、pnpmツールをインストールします。Node.jsをすでにインストールしている場合は、次のコマンドを実行してpnpmをインストールできます。
npm install -g pnpm
開発環境を確認します。
上記の手順を完了したら、次のコマンドを実行して、この例で必要な環境がインストールされているかどうかを確認できます。
java -version // JDKがインストールされている場合、コマンド出力にJDKバージョンが表示されます。そうでない場合は、「command not found」エラーが報告されます。 mvn -v // Mavenがインストールされている場合、コマンド出力にMavenバージョンが表示されます。そうでない場合は、「command not found」エラーが報告されます。 npm -v // Node.jsがインストールされている場合、コマンド出力にNode.jsバージョンが表示されます。そうでない場合は、「command not found」エラーが報告されます。 pnpm -v // pnpmがインストールされている場合、コマンド出力にpnpmバージョンが表示されます。そうでない場合は、「command not found」エラーが報告されます。
ステップ 2: サンプル コードを実行する
依存関係をインストールします。
開発環境を準備したら、サンプル プロジェクトをオンプレミス マシンにダウンロードし、次のコードを実行して依存関係をインストールできます。
pnpm install
AccessKey IDとAccessKeyシークレットを入力します。
インストールが完了したら、ルート ディレクトリにある application.properties 設定ファイルを探します。設定ファイルで、アクセス キー(AK)、シークレット キー(SK)、リージョンID、エンドポイントなどの主要な情報を指定します。プロジェクトの起動時に、上記の情報が読み取られ、各サンプル アプリケーションに同期されます。
説明プロジェクトを実行すると、設定ファイルで指定した主要な情報を使用して、DataWorksオープン プラットフォームのモジュールに接続します。
## RAMユーザーのAccessKey ID。 api.access-key-id={access-key} ## RAMユーザーのAccessKeyシークレット。 api.access-key-secret={secret-key} ## DataWorksサービスがデプロイされているリージョンのID。サンプル値: cn-shanghai、cn-hangzhou。 # api.region-id=cn-hangzhou api.region-id={regionId} ## DataWorks API操作のサービス。デフォルト値はdataworks-publicです。 api.product=dataworks-public ## DataWorks OpenAPIのエンドポイント。 ## DataWorks OpenAPIにインターネット経由でアクセスする場合、エンドポイントはdataworks.${regionId}.aliyuncs.comの形式です。デフォルトでは、DataWorks OpenAPIにはインターネット経由でアクセスします。 ## DataWorks OpenAPIに仮想プライベート クラウド(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 // DataWorksオープン プラットフォームの設定を構成してロックダウンを実行するためのサンプル コードを実行します。
実行結果を表示します。
コードが実行されたら、Webブラウザで結果を表示できます。
インタラクティブなフロントエンド ページを持つ例では、次のURLを使用してページにアクセスできます。
https://localhost:8080
バックエンドのみの例では、次のURLを使用してバックエンドにアクセスできます。
http://localhost:8008
アプリケーション シナリオのサンプル コードを取得する
オープン プラットフォーム サンプル コード ライブラリから、次のシナリオのサンプル コードを取得できます。