Linux で初めての Java Service Fabric Reliable Actors アプリケーションを作成する

[アーティクル]
06/01/2023

このクイックスタートでは、Linux 開発環境で初めての Azure Service Fabric Java アプリケーションをほんの数分で作成できます。作業が終了すると、単純な Java 単一サービスアプリケーションがローカル開発クラスターで実行された状態になります。

前提条件

作業を開始する前に、Linux 開発環境に Service Fabric SDK と Service Fabric CLI、Yeoman をインストールし、Java 開発環境をセットアップし、開発クラスターをセットアップします。 Mac OS X を使用している場合は、Docker を使用して Mac に開発環境をセットアップすることができます。

さらに、Service Fabric CLI もインストールします。

Java のジェネレーターのインストールとセットアップ

Service Fabric には、ターミナルから Yeoman テンプレートジェネレーターを使って Service Fabric Java アプリケーションを作成できるスキャフォールディングツールが用意されています。 Yeoman がまだインストールされていない場合は、Linux による Service Fabric の概要に関するページを参照し、Yeoman をセットアップする手順を確認してください。 Java 用 Service Fabric Yeoman テンプレートジェネレーターをインストールするには次のコマンドを実行します。

npm install -g generator-azuresfjava

基本的な概念

いくつかの基本的な概念さえ理解すれば、Reliable Actors の使用を開始できます。

アクターサービス。 Reliable Actors は、Service Fabric インフラストラクチャにデプロイできる Reliable Services にパッケージ化されます。 Actor インスタンスは、名前付きのサービスインスタンス内でアクティブ化されます。
アクター登録。 Reliable Services と同様に、Reliable Actor サービスは Service Fabric ランタイムに登録する必要があります。さらに、アクターの型を Actor ランタイムに登録する必要があります。
アクターインターフェイス。アクターインターフェイスは、アクターの厳密に型指定されたパブリックインターフェイスを定義するために使用されます。 Reliable Actor モデルの用語では、アクターインターフェイスに、アクターが理解し、処理できるメッセージの種類が定義されています。アクターインターフェイスは、他のアクターとクライアントアプリケーションがメッセージをアクターに (非同期に) "送信" するために使用されます。 Reliable Actors は複数のインターフェイスを実装できます。
ActorProxy クラス。 ActorProxy クラスは、アクターインターフェイスを介して公開されるメソッドを呼び出すためにクライアントアプリケーションで使用されます。 ActorProxy クラスは、次の 2 つの重要な機能を提供します。
- 名前解決: クラスター内のアクターを特定できます (ホストされているクラスターのノードを検索できます)。
- エラー処理: たとえば、アクターをクラスター内の別のノードに再配置することが必要な障害の後、メソッドの呼び出しを再試行し、アクターの場所を再解決できます。

アクターインターフェイスに関する次の規則に注意する必要があります。

アクターインターフェイスメソッドはオーバーロードできません。
アクターインターフェイスメソッドには、out、ref、optional パラメーターを使用できません。
ジェネリックインターフェイスはサポートされません。

アプリケーションを作成する

Service Fabric アプリケーションには、アプリケーションの機能を提供する際にそれぞれ特定の役割を果たすサービスが 1 つ以上含まれます。直前のセクションでインストールしたジェネレーターを使用すると、初めてサービスを作成したり、後で追加したりする作業が簡単になります。 Eclipse 用のプラグインを使用して、Service Fabric Java アプリケーションを作成、ビルド、およびデプロイすることもできます。 Eclipse を使用した初めての Java アプリケーションの作成とデプロイに関するページを参照してください。このクイックスタートでは、Yeoman を使用して、カウンター値の格納と取得という単一のサービスを行うアプリケーションを作成します。

ターミナルで、「yo azuresfjava」と入力します。
アプリケーションに名前を付けます。
最初のサービスの種類を選択し、名前を付けます。このチュートリアルでは、[Reliable Actor サービス] を選択します。他の種類のサービスの詳細については、「Service Fabric プログラミングモデルの概要」を参照してください。

アプリケーションに "HelloWorldActorApplication"、アクターに "HelloWorldActor" という名前をそれぞれ付けた場合には、以下のスキャフォールディングが作成されます。

HelloWorldActorApplication/
├── build.gradle
├── HelloWorldActor
│   ├── build.gradle
│   ├── settings.gradle
│   └── src
│       └── reliableactor
│           ├── HelloWorldActorHost.java
│           └── HelloWorldActorImpl.java
├── HelloWorldActorApplication
│   ├── ApplicationManifest.xml
│   └── HelloWorldActorPkg
│       ├── Code
│       │   ├── entryPoint.sh
│       │   └── _readme.txt
│       ├── Config
│       │   ├── _readme.txt
│       │   └── Settings.xml
│       ├── Data
│       │   └── _readme.txt
│       └── ServiceManifest.xml
├── HelloWorldActorInterface
│   ├── build.gradle
│   └── src
│       └── reliableactor
│           └── HelloWorldActor.java
├── HelloWorldActorTestClient
│   ├── build.gradle
│   ├── settings.gradle
│   ├── src
│   │   └── reliableactor
│   │       └── test
│   │           └── HelloWorldActorTestClient.java
│   └── testclient.sh
├── install.sh
├── settings.gradle
└── uninstall.sh

Reliable Actors の基本的な構成要素

前に説明した基本的な概念は、信頼性の高いアクターサービスの基本的な構築ブロックになります。

アクターインターフェイス

アクターのインターフェイス定義が含まれています。このインターフェイスは、アクター実装とアクターを呼び出すクライアントが共有するアクターコントラクトを定義するため、通常は、他の複数のプロジェクトで共有できる、アクター実装とは別の場所で定義します。

HelloWorldActorInterface/src/reliableactor/HelloWorldActor.java:

public interface HelloWorldActor extends Actor {
    @Readonly   
    CompletableFuture<Integer> getCountAsync();

    CompletableFuture<?> setCountAsync(int count);
}

アクターサービス

これには、アクターの実装とアクター登録コードが含まれます。アクターのクラスでは、アクターインターフェイスを実装します。アクターは、ここで処理を実行します。

HelloWorldActor/src/reliableactor/HelloWorldActorImpl:

@ActorServiceAttribute(name = "HelloWorldActorService")
@StatePersistenceAttribute(statePersistence = StatePersistence.Persisted)
public class HelloWorldActorImpl extends FabricActor implements HelloWorldActor {
    private Logger logger = Logger.getLogger(this.getClass().getName());

    public HelloWorldActorImpl(FabricActorService actorService, ActorId actorId){
        super(actorService, actorId);
    }

    @Override
    protected CompletableFuture<?> onActivateAsync() {
        logger.log(Level.INFO, "onActivateAsync");

        return this.stateManager().tryAddStateAsync("count", 0);
    }

    @Override
    public CompletableFuture<Integer> getCountAsync() {
        logger.log(Level.INFO, "Getting current count value");
        return this.stateManager().getStateAsync("count");
    }

    @Override
    public CompletableFuture<?> setCountAsync(int count) {
        logger.log(Level.INFO, "Setting current count value {0}", count);
        return this.stateManager().addOrUpdateStateAsync("count", count, (key, value) -> count > value ? count : value);
    }
}

アクター登録

アクターサービスは、Service Fabric ランタイムのサービスの種類に登録する必要があります。アクターサービスでアクターインスタンスを実行するには、アクター型もアクターサービスに登録する必要があります。 ActorRuntime 登録メソッドは、アクターに対してこの処理を実行します。

HelloWorldActor/src/reliableactor/HelloWorldActorHost:

public class HelloWorldActorHost {

private static final Logger logger = Logger.getLogger(HelloWorldActorHost.class.getName());

public static void main(String[] args) throws Exception {

        try {

            ActorRuntime.registerActorAsync(HelloWorldActorImpl.class, (context, actorType) -> new FabricActorService(context, actorType, (a,b)-> new HelloWorldActorImpl(a,b)), Duration.ofSeconds(10));
            Thread.sleep(Long.MAX_VALUE);
        } catch (Exception e) {
            logger.log(Level.SEVERE, "Exception occurred", e);
            throw e;
        }
    }
}

アプリケーションのビルド

Service Fabric Yeoman テンプレートには、Gradle のビルドスクリプトが含まれています。このスクリプトを使用して、ターミナルからアプリケーションをビルドすることができます。 Service Fabric Java 依存関係は、Maven からフェッチされます。 Service Fabric Java アプリケーションをビルドして操作するには、JDK と Gradle がインストールされている必要があります。まだインストールされていない場合は、Linux による Service Fabric の概要に関するページを参照し、JDK と Gradle のインストール手順を確認してください。

アプリケーションをビルドしてパッケージ化するには、次のコマンドを実行します。

cd HelloWorldActorApplication
gradle

アプリケーションの配置

ビルドしたアプリケーションは、ローカルクラスターにデプロイできます。

ローカルの Service Fabric クラスターに接続します (クラスターがセットアップ済みで稼働中であることが必要)。
```
sfctl cluster select --endpoint http://localhost:19080
```
テンプレートに用意されているインストールスクリプトを実行してクラスターのイメージストアにアプリケーションパッケージをコピーし、アプリケーションの種類を登録して、アプリケーションのインスタンスを作成します。
```
./install.sh
```

ビルドしたアプリケーションは、他のすべての Service Fabric アプリケーションと同じようにデプロイできます。詳細な手順については、Service Fabric CLI を使用した Service Fabric アプリケーションの管理についてのドキュメントを参照してください。

これらのコマンドのパラメーターは、アプリケーションパッケージ内の生成されたマニフェストで確認できます。

アプリケーションのデプロイ後、ブラウザーを開いて http://localhost:19080/Explorer の Service Fabric Explorer に移動します。次に、Applications ノードを展開し、アプリケーションの種類のエントリと、その種類の最初のインスタンスのエントリができたことを確認してください。

重要

アプリケーションを Azure 内のセキュアな Linux クラスターにデプロイするには、Service Fabric ランタイムを使用してアプリケーションを検証するように証明書を構成する必要があります。これにより、Reliable Actors サービスが基盤の Service Fabric ランタイム API と通信できるようになります。詳しくは、「Reliable Services アプリを Linux クラスター上で実行するように構成する」をご覧ください。

テストクライアントの起動と、フェールオーバーの実行

アクターは単独では何も実行しません。メッセージを送信するには、別のサービスまたはクライアントが必要です。アクターテンプレートには、アクターサービスとの対話に使用できる簡単なテストスクリプトが含まれています。

Note

テストクライアントは、ActorProxy クラスを使用してアクターと通信します。アクターは、アクターサービスと同じクラスター内で実行するか、同じ IP アドレス空間を共有する必要があります。テストクライアントは、ローカル開発クラスターと同じコンピューターで実行できます。ただし、リモートクラスター内のアクターと通信するには、アクターとの外部通信を処理するゲートウェイをクラスターにデプロイする必要があります。

ウォッチユーティリティを使用してスクリプトを実行し、アクターサービスの出力を確認します。テストスクリプトは、アクターに対して setCountAsync() メソッドを呼び出してカウンターを増分させ、getCountAsync() メソッドを呼び出して新しいカウンター値を取得し、その値をコンソールに表示します。

MAC OS X の場合は、次の追加コマンドを実行して、HelloWorldTestClient フォルダーをコンテナー内の場所にコピーする必要があります。
```
 docker cp HelloWorldTestClient [first-four-digits-of-container-ID]:/home
 docker exec -it [first-four-digits-of-container-ID] /bin/bash
 cd /home
```
```
cd HelloWorldActorTestClient
watch -n 1 ./testclient.sh
```
Service Fabric Explorer で、アクターサービスのプライマリレプリカをホストしているノードを見つけます。次のスクリーンショットでは、ノード 3 です。プライマリサービスレプリカは、読み取り操作と書き込み操作を処理します。サービスの状態の変更がセカンダリレプリカにレプリケートされます (次のスクリーンショットでは、ノード 0 のノード 1 で実行されています)。
[ノード] で、前の手順で見つけたノードをクリックし、[アクション] メニューの [非アクティブにする (再起動)] を選択します。この操作によって、プライマリサービスレプリカを実行しているノードが再起動され、別のノードで実行されているセカンダリレプリカのいずれかに強制的にフェールオーバーされます。フェールオーバーされたセカンダリレプリカがプライマリに昇格し、別のノードに別のセカンダリレプリカが作成され、プライマリレプリカによる読み取り/書き込み操作が開始されます。ノードが再起動したら、テストクライアントからの出力を監視して、フェールオーバーにかかわらず、カウンターが増加し続けることを確認してください。

アプリケーションを削除する

テンプレートに用意されているアンインストールスクリプトを使用してアプリケーションインスタンスを削除し、アプリケーションパッケージの登録を解除して、クラスターのイメージストアからアプリケーションパッケージを削除します。

./uninstall.sh

Service Fabric explorer で、アプリケーションとアプリケーションの種類が [アプリケーション] ノードに表示されていないことを確認します。

Maven 上の Service Fabric Java ライブラリ

Service Fabric Java ライブラリは、Maven でホストされてきました。 mavenCentral から Service Fabric Java ライブラリを使用するために、プロジェクトの pom.xml または build.gradle に依存関係を追加することができます。

アクター

アプリケーションの Service Fabric Reliable Actors サポート。

<dependency>
    <groupId>com.microsoft.servicefabric</groupId>
    <artifactId>sf-actors</artifactId>
    <version>1.0.0</version>
</dependency>

repositories {
    mavenCentral()
}
dependencies {
    compile 'com.microsoft.servicefabric:sf-actors:1.0.0'
}

サービス

アプリケーションの Service Fabric Reliable Services サポート。

<dependency>
    <groupId>com.microsoft.servicefabric</groupId>
    <artifactId>sf-services</artifactId>
    <version>1.0.0</version>
</dependency>

repositories {
    mavenCentral()
}
dependencies {
    compile 'com.microsoft.servicefabric:sf-services:1.0.0'
}

その他

トランスポート

Service Fabric Java アプリケーションのトランスポート層サポート。トランスポート層でプログラムを作成する場合以外は、Reliable Actors または Service アプリケーションにこの依存関係を明示的に追加する必要はありません。

<dependency>
    <groupId>com.microsoft.servicefabric</groupId>
    <artifactId>sf-transport</artifactId>
    <version>1.0.0</version>
</dependency>

repositories {
    mavenCentral()
}
dependencies {
    compile 'com.microsoft.servicefabric:sf-transport:1.0.0'
}

Fabric サポート

Service Fabric のシステムレベルのサポート。ネイティブの Service Fabric ランタイムと対話します。 Reliable Actors または Service アプリケーションにこの依存関係を明示的に追加する必要はありません。上記の他の依存関係を取り込むときに、Maven から自動的にフェッチされます。

<dependency>
    <groupId>com.microsoft.servicefabric</groupId>
    <artifactId>sf</artifactId>
    <version>1.0.0</version>
</dependency>

repositories {
    mavenCentral()
}
dependencies {
    compile 'com.microsoft.servicefabric:sf:1.0.0'
}

Linux で初めての Java Service Fabric Reliable Actors アプリケーションを作成する

前提条件

Java のジェネレーターのインストールとセットアップ

基本的な概念

アプリケーションを作成する

Reliable Actors の基本的な構成要素

アクターインターフェイス

アクターサービス

アクター登録

アプリケーションのビルド

アプリケーションの配置

テストクライアントの起動と、フェールオーバーの実行

アプリケーションを削除する

Maven 上の Service Fabric Java ライブラリ

アクター

サービス

その他

トランスポート

Fabric サポート

次のステップ

その他のリソース

Linux で初めての Java Service Fabric Reliable Actors アプリケーションを作成する

前提条件

Java のジェネレーターのインストールとセットアップ

基本的な概念

アプリケーションを作成する

Reliable Actors の基本的な構成要素

アクター インターフェイス

アクター サービス

アクター登録

アプリケーションのビルド

アプリケーションの配置

テスト クライアントの起動と、フェールオーバーの実行

アプリケーションを削除する

Maven 上の Service Fabric Java ライブラリ

アクター

サービス

その他

トランスポート

Fabric サポート

次のステップ

その他のリソース

アクターインターフェイス

アクターサービス

テストクライアントの起動と、フェールオーバーの実行