Catalyst Maven Plugin

はじめに

catalystプラグインは、アーキタイプからBasic I/OまたはAdvanced I/O関数を初期化した後、Mavenプラグインの下に利用可能になります。このプラグインの下に、以下に示す個別のコマンドがあり、Catalyst関数およびMavenアーティファクトに対してさまざまな操作を実行できます。

serveおよびdeployコマンドの実行は、リクエストが認証された後に行われます。Catalystは現在、Catalyst CLI認証とは独立した、Mavenプラグイン用のプロプライエタリ認証を提供しています。これらのコマンドを実行すると、IDEが認証トークンの生成を求めるプロンプトを表示し、作成されたトークンはローカルシステムに保存されます。packageおよびhelpコマンドは認証が不要です。

パッケージ

CatalystのpackageコマンドはMavenプラグイン専用で、CLIでは利用できません。これにより、Java関数ディレクトリを実行可能なバンドルとしてパッケージ化できます。

Catalyst Mavenプラグインで関数をパッケージ化する

以下に説明する方法で、Java Basic I/OまたはAdvanced I/O関数をパッケージ化できます。この例では、VS Code IDEでこのコマンドを実行しています。

MavenツールのPlugins > catalystの下にある**package**コマンドをクリックします。

IDEのターミナルで実行の進行状況を追跡できます。関数はMavenのSNAPSHOTとしてJARファイル形式にコンパイルされます。Mavenプロジェクトディレクトリのtargetフォルダに、デプロイ可能なバンドル全体catalyst-archive.zipが追加されています。

targetディレクトリには、ビルドアーカイブとメイン関数のSNAPSHOT JARとともに、すべてのコンパイル済みファイル、ライブラリ、およびその他のMaven依存関係が含まれます。

catalyst-archiveには、Java SDK、コンパイル済みソースファイル、catalyst-config.json、およびpom.xmlを含むデプロイ可能なライブラリファイルが含まれます。

これで、関数をローカルでサーブするか、リモートプロジェクトにデプロイできます。

サーブ

Catalyst Mavenプラグインのserveコマンドは、CLIコマンドのcatalyst serveと同様です。リモートプロジェクトにデプロイする前に、システム内のlocalhostを通じて関数をサーブしてテストできます。Basic I/OおよびAdvanced I/O関数の両方をサーブし、テスト用のローカルエンドポイントを取得できます。

さらに、IDEのデバッガーを活用してライブサーブセッションにアタッチし、テスト体験を向上させることができます。Catalystは、サーブする関数のホットリロードも可能にします。これにより、関数のコードを変更し、再コンパイルや再サーブを行うことなく、更新がライブで反映されるのを確認できます。

Catalyst Mavenプラグインで関数をサーブする

以下に説明する方法で、Java Basic I/OまたはAdvanced I/O関数をサーブできます。この例では、VS Code IDEでこのコマンドを実行しています。

1. Mavenツールの**Plugins > catalyst**の下にあるserveコマンドをクリックします。

IDEのターミナルにサーブセッションの進行状況が表示されます。

2. 有効な認証トークンが検出されない場合、Catalystはサーブリクエストの認証を求めるプロンプトを表示します。ターミナルに表示されたURLをブラウザウィンドウで開きます。

3. ブラウザウィンドウでAcceptをクリックします。これにより、Catalystアカウントが認証され、Catalyst CLIに要求された権限が付与されます。

ウィンドウを閉じて、IDEに戻ることができます。

4. Catalystはデフォルトのポート3010でローカルサーバーを起動します。ターミナルからサーブされた関数のローカルURLにアクセスします。

ターミナルには実行されたアクションのライブログが表示されます。IDEによっては、コマンドの実行を終了してサーブセッションを終了できます。

デプロイ

Catalyst Mavenプラグインのdeployコマンドは、CLIコマンドのcatalyst deployと同様です。テストが完了した後、関数をリモートプロジェクトにデプロイできます。Basic I/OおよびAdvanced I/O関数の両方をデプロイし、デプロイされたURLエンドポイントを取得できます。

Catalyst Mavenプラグインで関数をデプロイする

以下に説明する方法で、Java Basic I/OまたはAdvanced I/O関数をデプロイできます。この例では、VS Code IDEでこのコマンドを実行しています。

1. Mavenツールの**Plugins > catalystの下にあるdeploy**コマンドをクリックします。

IDEのターミナルにコマンド実行の進行状況が表示されます。

2. 有効な認証トークンが検出されない場合、Catalystはデプロイリクエストの認証を求めるプロンプトを表示します。ターミナルに表示されたURLをブラウザウィンドウで開きます。

3. ブラウザウィンドウでAcceptをクリックします。これにより、Catalystアカウントが認証され、Catalyst CLIに要求された権限が付与されます。

ウィンドウを閉じて、IDEに戻ることができます。

4. ターミナルにアクセス可能な関数のデプロイ済みURLが表示されます。

これで、リモートコンソールのプロジェクト内の関数にアクセスできるようになります。

ヘルプ

Mavenプラグインは、実行するとプラグイン内のすべてのコマンドのヘルプ情報を表示するhelpコマンドを提供します。

IDEのターミナルで詳細を確認できます。