Java SDK - 概要

Catalyst向けJava SDKは、Javaプログラミング要素を使用してマイクロサービスやインタラクティブなWebおよびモバイルアプリケーションを作成し、それらをCatalystコンポーネントと連携させるための基盤を提供します。SDKはCatalyst APIに簡単にアクセスするために必要な構造を提供します。REST APIのラッパーとして機能し、Catalystサービスを効果的に利用するのに役立ちます。

Catalystは現在、以下のJavaバージョンをサポートしています：

• Java 8
• Java 11
• Java 17

プロジェクトの初期化

Catalystプロジェクトを初期化するには、ビジネスロジックを記述する前に、Javaソースコードの最初のステートメントとして以下のコードスニペットを追加してください。

ZCProject.initProject();

特定のSDKスコープでCatalystプロジェクトを初期化する

Catalystでは、以下のスコープを使用してプロジェクトを初期化できます：

• Admin: すべてのコンポーネントとそれぞれの機能に無制限にアクセスできます。たとえば、Data Storeに完全にアクセスし、読み取り、書き込み、削除などのすべての操作を実行できます。

• User: コンポーネントや特定の機能へのアクセスを制限できます。たとえば、Data Storeに読み取りアクセスのみを提供できます。

以下のSDKスニペットを使用すると、AdminまたはUserスコープでプロジェクトを初期化し、Data StoreでSELECTクエリを実行できます：

• Adminスコープでのプロジェクト初期化

ZCProject adminProject = ZCProject.initProject("admin", ZCUserScope.ADMIN);
ZCQL.getInstance(adminProject).executeQuery("select * from test");

• Userスコープでのプロジェクト初期化

ZCProject userProject = ZCProject.initProject("user", ZCUserScope.USER);
ZCQL.getInstance().executeQuery("select * from test");

クラス階層

すべてのCatalystコンポーネントは、メンバーとメソッドでコンポーネントの動作を定義するJavaクラスとしてモデル化されています。

• ZCProjectはSDKパッケージの基本ベースクラスです。Catalystプロジェクトの設定を初期化し、プロジェクトのコンポーネントを関連付けるメソッドを持っています。
• SDKのクラス関係と階層は、Catalystのプロジェクト階層に従います。
• 各クラスには、そのプロパティを取得する関数と、API呼び出しを通じて直接の子エンティティのデータを取得する関数があります。たとえば、Catalyst Data StoreクラスのZCDataStoreには、テーブルにアクセスするメンバー関数があり、テーブル名やIDなどを設定するために直接の子クラスZCTableの関数を使用できます。

Catalystの各コンポーネントのクラス階層は以下のように表されます：

インスタンスオブジェクト

下位レベルのコンポーネントのデータを取得するために、クラス階層を最上位からすべてたどることは、各レベルでAPI呼び出しが必要になるため、常に効率的ではありません。これを回避するために、すべてのコンポーネントクラスにはダミーオブジェクトを取得するためのgetInstance()メソッドと、子エンティティのダミーオブジェクトを取得するメソッドがあります。

Catalystコンポーネントのプロパティを取得するには、コンポーネントのオブジェクトをgetInstance()メソッドで呼び出し、その同じオブジェクトを使用してコンポーネントが定義する他のメソッドを呼び出します。これにより、不要なAPI呼び出しを回避できます。

例外処理

予期しない不正な動作は例外と呼ばれます。すべてのエラーと例外は、Java SDKで定義されたZCExceptionというクラスによって処理されます。クライアントコードとサーバーコードによってスローされる特定の例外をキャッチするために、ZCServerExceptionクラスとZCClientExceptionクラスがあります。