Reliable Actors の使用

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

この記事では、Visual Studio で簡単な Reliable Actors アプリケーションを作成およびデバッグする手順について説明します。 Reliable Actors の詳細については、「Service Fabric Reliable Actors の概要」を参照してください。

前提条件

開始する前に、マシン上に Service Fabric 開発環境 (Visual Studio など) が設定されていることを確認します。詳細については、開発環境の設定方法に関するページをご覧ください。

Visual Studio での新しいプロジェクトの作成

Visual Studio 2019 以降を管理者として起動し、新しい Service Fabric アプリケーション プロジェクトを作成します。

Visual Studio 用の Service Fabric ツール - 新しいプロジェクト

次のダイアログボックスで、 [.NET Core 2.0] の下の [アクターサービス] を選択し、サービスの名前を入力します。

Service Fabric プロジェクトのテンプレート

作成されたプロジェクトの構造は次のとおりです。

Service Fabric プロジェクトの構造

ソリューションの確認

ソリューションには 3 つのプロジェクトが含まれています。

アプリケーションプロジェクト (MyApplication) 。このプロジェクトには、デプロイ用のすべてのサービスがまとめてパッケージ化されています。アプリケーションを管理するための ApplicationManifest.xml と PowerShell スクリプトが含まれています。
インターフェイスプロジェクト (HelloWorld.Interfaces) 。このプロジェクトには、アクターのインターフェイス定義が含まれています。アクターインターフェイスは、任意の名前の任意のプロジェクトで定義できます。このインターフェイスは、アクターコントラクトを定義します。コントラクトは、アクター実装と、アクターを呼び出すクライアントによって共有されます。クライアントプロジェクトがこれに依存する可能性があるため、通常は、アクター実装とは別のアセンブリで定義するのが妥当です。
アクターサービスプロジェクト (HelloWorld) 。このプロジェクトは、アクターをホストする Service Fabric サービスを定義します。これには、アクターの実装である HelloWorld.cs が含まれています。アクター実装は、基本型 Actor から派生し、MyActor.Interfaces プロジェクトで定義されたインターフェイスを実装するクラスです。またアクタークラスは、ActorService インスタンスおよび ActorId を受け取り、ベース Actor クラスに渡すコンストラクターを実装する必要があります。

このプロジェクトには Program.cs も含まれています。これは、ActorRuntime.RegisterActorAsync<T>() を使用して、アクタークラスを Service Fabric ランタイムに登録します。 HelloWorld クラスは既に登録されています。プロジェクトに追加された追加アクター実装も、Main() メソッドに登録する必要があります。

HelloWorld アクターのカスタマイズ

プロジェクトテンプレートは IHelloWorld インターフェイスでいくつかのメソッドを定義し、それらのメソッドを HelloWorld アクター実装に実装します。アクターサービスが単純な "Hello World" 文字列を返すように、それらのメソッドを置き換えます。

HelloWorld.Interfaces プロジェクトの IHelloWorld.cs ファイルで、インターフェイス定義を次のように置き換えます。

public interface IHelloWorld : IActor
{
    Task<string> GetHelloWorldAsync();
}

HelloWorld プロジェクトの HelloWorld.cs で、クラス定義全体を次のように置き換えます。

[StatePersistence(StatePersistence.Persisted)]
internal class HelloWorld : Actor, IHelloWorld
{
    public HelloWorld(ActorService actorService, ActorId actorId)
        : base(actorService, actorId)
    {
    }

    public Task<string> GetHelloWorldAsync()
    {
        return Task.FromResult("Hello from my reliable actor!");
    }
}

Ctrl + B + Shift キーを押してプロジェクトをビルドし、すべてがコンパイルされることを確認してください。

クライアントの追加

簡単なコンソールアプリケーションを作成して、アクターサービスを呼び出します。

ソリューションエクスプローラーでソリューションを右クリックし、>[追加]>[新しいプロジェクト] の順に選択します。
.NET Core プロジェクトタイプで、コンソールアプリ (.NET Core) を選択します。プロジェクトの名前として「ActorClient」と入力します。

Note

コンソールアプリケーションは、Service Fabric でクライアントとして通常使用するアプリの種類ではありませんが、ローカル Service Fabric クラスターを使用したデバッグおよびテストの例として役に立ちます。
コンソールアプリケーションは、インターフェイスプロジェクトおよびその他の依存関係との互換性を維持するために、64 ビットアプリケーションである必要があります。ソリューションエクスプローラーで、ActorClient プロジェクトを右クリックし､ [プロパティ] をクリックします｡ [ビルド] タブで、 [プラットフォームターゲット] を [x64] に設定します。
クライアントプロジェクトには、信頼できるアクターの NuGet パッケージが必要です。 [ツール]>[NuGet パッケージマネージャー]>[パッケージマネージャーコンソール] の順にクリックします。パッケージマネージャーコンソールで、次のコマンドを入力します。
```
Install-Package Microsoft.ServiceFabric.Actors -IncludePrerelease -ProjectName ActorClient
```
NuGet パッケージとそのすべての依存関係が、ActorClient プロジェクトにインストールされます。
クライアントプロジェクトには、インターフェイスプロジェクトへの参照も必要です。 ActorClient プロジェクトで、 [依存関係] を右クリックし、 [プロジェクト参照の追加] をクリックします。 [プロジェクト] > [ソリューション] (まだ選択されていない場合) の順に選択し、HelloWorld.Interfaces の横にあるチェックボックスをオンにします。 [OK] をクリックします。

ActorClient プロジェクトで、Program.cs のすべての内容を次のコードで置き換えます。

using System;
using System.Threading.Tasks;
using Microsoft.ServiceFabric.Actors;
using Microsoft.ServiceFabric.Actors.Client;
using HelloWorld.Interfaces;

namespace ActorClient
{
    class Program
    {
        static void Main(string[] args)
        {
            IHelloWorld actor = ActorProxy.Create<IHelloWorld>(ActorId.CreateRandom(), new Uri("fabric:/MyApplication/HelloWorldActorService"));
            Task<string> retval = actor.GetHelloWorldAsync();
            Console.Write(retval.Result);
            Console.ReadLine();
        }
    }
}

実行およびデバッグ

F5 キーを押して、Service Fabric 開発クラスターで、アプリケーションをローカルでビルド、配置、および実行します。デプロイプロセス中は、 [出力] ウィンドウで進行状況を確認できます。

Service Fabric デバッグ出力ウィンドウ

出力に "アプリケーションの準備が整いました" というテキストが含まれる場合は、ActorClient アプリケーションを使用してサービスをテストできます。ソリューションエクスプローラーで、ActorClient プロジェクトを右クリックし､ [デバッグ]>[新しいインスタンスを開始] の順にクリックします。コマンドラインアプリケーションには、アクターサービスからの出力が表示されます。

アプリケーションの出力

ヒント

Service Fabric Actors ランタイムは、アクターメソッドに関連する一部のイベントとパフォーマンスカウンターを出力します。これらは、診断やパフォーマンスの監視に役立ちます。

次のステップ

「Reliable Actors の Service Fabric プラットフォームの使用方法」で詳細を参照してください。