マイクロサービストランザクションをサポートするサンプルアプリケーションを作成する
このページは英語版のページが機械翻訳されたものです。英語版との間に矛盾または不一致がある場合は、英語版を正としてください。
このチュートリアルでは、ScalarDB でマイクロサービストランザクションをサポートするサンプルアプリケーションを作成する方法について説明します。
概要
このチュートリアルでは、ScalarDB の2フェーズコミットインターフェースを使用したトランザクションを通じてアイテムを注文 し、信用枠で支払いを行うことができるサンプル電子商取引アプリケーションを作成するプロセスを示します。
サンプルアプリケーションには、database-per-service pattern に基づく Customer Service と Order Service という2つのマイクロサービスがあります。
- Customer Service は、信用枠情報、信用限度額、信用合計などの顧客情報を管理します。
- Order Service は、注文の確定や注文履歴の取得などの注文操作を担当します。
各サービスには gRPC エンドポイントがあります。クライアントはエンドポイントを呼び出し、サービスも各エンドポイントを呼び出します。
サンプルアプリケーションで使用するデータベースは Cassandra と MySQL です。 Customer Service と Order Service は、それぞれ ScalarDB を介して Cassandra と MySQL を使用します。
図に示されているように、両方のサービスは、Consensus Commit プロトコルに使用される小さな Coordinator データベースにアクセスします。データベースはサービスに依存せず、Consensus Commit のトランザクションメタデータを高可用性の方法で管理するために存在します。
サンプルアプリケーションでは、セットアップと説明を簡単にするために、Coordinator データベースを Order Service の同じ Cassandra インスタンスに共存させています。または、Coordinator データベースを別のデータベースとして管理することもで きます。
サンプルアプリケーションは ScalarDB の使用方法を示すことに重点を置いているため、アプリケーション固有のエラー処理、認証処理、および同様の機能はサンプルアプリケーションに含まれていません。ScalarDB での例外処理の詳細については、例外の処理方法を参照してください。
さらに、サンプルアプリケーションの目的上、各サービスには1つのコンテナがあるため、サービス間のリクエストルーティングは不要です。ただし、実稼働環境では、スケーラビリティと可用性のために各サービスに複数のサーバーまたはホストがあるため、2フェーズコミットインターフェイスを使用したトランザクションでは、サービス間のリクエストルーティングを検討する必要があります。要求ルーティングの詳細については、2フェーズコミットインターフェイスを使用したトランザクションでのリクエストルーティング を参照してください。
サービスエンドポイント
サービスで定義されているエンドポイントは次のとおりです。
-
Customer Service
getCustomerInfo
payment
prepare
validate
commit
rollback
repayment
-
Order Service
placeOrder
getOrder
getOrders
このサンプルアプリケーションで実行できること
サンプルアプリケーションは、次の種類のトランザクションをサポートしています。
- Customer Service の
getCustomerInfo
エンドポイントを介して顧客情報を取得します。 - Order Service の
placeOrder
エンドポイントと、Customer Service のpayment
、prepare
、validate
、commit
、rollback
エンドポイントを介して、信用枠を使用して注文を行います。- 注文のコストが顧客の信用限度額を下回っているかどうかを確認します。
- チェックに合格した場合、注文履歴を記録し、顧客が支払った金額を更新します。
- Order Service の
getOrder
エンドポイントと、Customer Service のgetCustomerInfo
、prepare
、validate
、commit
、rollback
エンドポイントを介して、注文 ID で注文情報を取得します。 - Order Service の
getOrders
エンドポイントと、Customer Service のgetCustomerInfo
、prepare
、validate
、commit
、rollback
エンドポイントを介して、顧客 ID で注文情報を取得します。 - Customer Service の
repayment
エンドポイントを介して支払いを行います。- 顧客が支払った金額を減らします。
getCustomerInfo
エンドポイントは、コーディネーターからトランザクション ID を受信するときに、参加者サービスエンドポイントとして機能します。
このサンプルアプリケーションの前提条件
- Eclipse Temurin の OpenJDK LTS バージョン (8、11、17、または 21)
- Docker 20.10以降 (Docker Compose V2以降)
このサンプルアプリケーショ ンは、Eclipse Temurin の OpenJDK でテストされています。ただし、ScalarDB 自体は、さまざまなベンダーの JDK ディストリビューションでテストされています。互換性のある JDK ディストリビューションを含む ScalarDB の要件の詳細については、要件を参照してください。
ScalarDB のセットアップ
次のセクションでは、ScalarDB でマイクロサービストランザクションをサポートするサンプルアプリケーションをセットアップする方法について説明します。
ScalarDB サンプルリポジトリをクローンする
ターミナル を開き、次のコマンドを実行して ScalarDB サンプルリポジトリをクローンします。
git clone https://github.com/scalar-labs/scalardb-samples
次に、次のコマンドを実行して、サンプルアプリケーションが含まれているディレクトリに移動します。
cd scalardb-samples/microservice-transaction-sample
CassandraとMySQLを起動する
Cassandra と MySQL は、それぞれ database-cassandra.properties
と database-mysql.properties
に示されているように、サンプルアプリケーション用にすでに設定されています。ScalarDB でのマルチストレージトランザクション機能の設定の詳細については、マルチストレージトランザクションをサポートするように ScalarDB を設定する方法を参照してください。
サンプルアプリケーションの Docker コンテナに含まれている Cassandra と MySQL を起動するには、次のコマンドを実行します。
docker-compose up -d mysql cassandra