Send アクティビティのキャッシュ共有レベルの変更

[アーティクル]
04/07/2023

SendMessageChannelCache 拡張機能により、キャッシュ共有レベルのカスタマイズやチャネルファクトリキャッシュの設定のカスタマイズを行えるほか、Send メッセージングアクティビティを使用してサービスエンドポイントにメッセージを送信するワークフローのチャネルキャッシュの設定のカスタマイズも可能になります。これらのワークフローは、通常はクライアントワークフローですが、WorkflowServiceHost でホストされるワークフローサービスである場合もあります。チャネルファクトリキャッシュには、ChannelFactory<TChannel> オブジェクトがキャッシュされます。チャネルキャッシュには、チャネルがキャッシュされます。

Note

ワークフローは Send メッセージングアクティビティを使用してメッセージまたはパラメーターを送信できます。このワークフローのランタイムはチャネルファクトリをキャッシュに追加しますが、チャネルファクトリで作成されるチャネルは、IRequestChannel アクティビティを ReceiveReply アクティビティと共に使用したときは Send 型で、IOutputChannel アクティビティだけを (Send なしで) 使用したときは ReceiveReply 型です。

既定では、WorkflowServiceHost によってホストされるワークフローにおいて、Send メッセージングアクティビティが使用するキャッシュは WorkflowServiceHost のすべてのワークフローインスタンス間で共有されます (ホストレベルのキャッシュ)。 WorkflowServiceHost によってホストされないクライアントワークフローの場合、キャッシュを使用できるのはワークフローインスタンスだけです (インスタンスレベルのキャッシュ)。このキャッシュは、アンセーフキャッシュが有効になっている場合を除き、構成で定義されているエンドポイントを使用しない Send アクティビティに対してのみ使用可能です。

ワークフローの Send アクティビティに使用可能なさまざまなキャッシュ共有レベルと、推奨される使用方法を次に示します。

ホストレベル: ホスト共有レベルでは、キャッシュを使用できるのはワークフローサービスホストでホストされるワークフローインスタンスだけです。キャッシュはプロセス全体のキャッシュのワークフローサービスホスト間で共有できます。
インスタンスレベル: インスタンス共有レベルでは、キャッシュを使用できるのは有効期間中の特定のワークフローインスタンスで、他のワークフローインスタンスはキャッシュを使用できません。
キャッシュなし: 構成で定義されているエンドポイントを使用するワークフローがある場合、キャッシュは既定でオフになります。この場合、キャッシュをオンにすると安全性が損なわれることがあるため、オフにしておくことをお勧めします。たとえば、送信ごとに異なる ID (異なる資格情報、または偽装の使用) が必要な場合があります。

クライアントワークフローでのキャッシュの共有を設定するには、SendMessageChannelCache クラスのインスタンスを目的のワークフローインスタンスのセットに拡張として追加します。この結果、すべてのワークフローインスタンス間でキャッシュが共有されます。次のコード例は、この手順を実行する方法を示しています。

まず、SendMessageChannelCache 型のインスタンスを宣言します。

// Create an instance of SendMessageChannelCache with default cache settings.  
static SendMessageChannelCache sharedChannelCacheExtension =  
    new SendMessageChannelCache();

次に、各クライアントワークフローのインスタンスにキャッシュ拡張を追加します。

WorkflowApplication clientInstance1 = new WorkflowApplication(new clientWorkflow1());  
WorkflowApplication clientInstance2 = new WorkflowApplication(new clientWorkflow2());  
  
// Share the cache extension object
  
clientInstance1.Extensions.Add(sharedChannelCacheExtension);  
clientInstance2.Extensions.Add(sharedChannelCacheExtension);

ホストされるワークフローサービスでのキャッシュの共有を設定するには、SendMessageChannelCache クラスのインスタンスをすべてのワークフローサービスホストに拡張として追加します。この結果、すべてのワークフローサービスホスト間でキャッシュが共有されます。次のコード例は、この手順を実行する方法を示しています。

まず、SendMessageChannelCache 型のインスタンスをクラスレベルで宣言します。

// Create static instance of SendMessageChannelCache with default cache settings.  
static SendMessageChannelCache sharedChannelCacheExtension = new  
    SendMessageChannelCache();

次に、各ワークフローサービスホストに静的キャッシュ拡張を追加します。

WorkflowServiceHost host1 = new WorkflowServiceHost(new serviceWorkflow1(), new Uri(baseAddress1));  
WorkflowServiceHost host2 = new WorkflowServiceHost(new serviceWorkflow2(), new Uri(baseAddress2));  
  
// Share the static cache to get an AppDomain level cache.  
host1.WorkflowExtensions.Add(sharedChannelCacheExtension);  
host2.WorkflowExtensions.Add(sharedChannelCacheExtension);

ホストされるワークフローサービスでのキャッシュ共有をインスタンスレベルに設定するには、Func<SendMessageChannelCache> デリゲートをワークフローサービスホストに拡張として追加し、SendMessageChannelCache クラスの新しいインスタンスをインスタンス化するコードにこのデリゲートを割り当てます。この結果、ワークフローサービスホストのすべてのワークフローインスタンスで 1 つのキャッシュが共有されるのではなく、ワークフローインスタンスごとに異なるキャッシュが使用されます。次のコード例は、このデリゲートがポイントする SendMessageChannelCache 拡張を直接定義するラムダ式を使用して上記の処理を実行する方法を示しています。

serviceHost.WorkflowExtensions.Add(() => new SendMessageChannelCache  
{  
    // Use FactorySettings property to add custom factory cache settings.  
    FactorySettings = new ChannelCacheSettings
    { MaxItemsInCache = 5, },  
    // Use ChannelSettings property to add custom channel cache settings.  
    ChannelSettings = new ChannelCacheSettings
    { MaxItemsInCache = 10 },  
});

キャッシュ設定のカスタマイズ

チャネルファクトリキャッシュおよびチャネルキャッシュのキャッシュ設定をカスタマイズできます。キャッシュ設定は ChannelCacheSettings クラスで定義されています。 SendMessageChannelCache クラスでは、チャネルファクトリキャッシュおよびチャネルキャッシュの既定のキャッシュ設定が、そのパラメーターなしのコンストラクターで定義されます。次の表は、これらのキャッシュ設定の既定値をキャッシュのタイプごとに示しています。

設定	LeaseTimeout (分)	IdleTimeout (分)	MaxItemsInCache
ファクトリキャッシュの既定値	TimeSpan.MaxValue	2	16
チャネルキャッシュの既定値	5	2	16

ファクトリキャッシュおよびチャネルキャッシュの設定をカスタマイズするには、パラメーター化されたコンストラクター SendMessageChannelCache を使用して SendMessageChannelCache クラスをインスタンス化し、ChannelCacheSettings の新しいインスタンスをカスタム値と共に factorySettings パラメーターおよび channelSettings パラメーターにそれぞれ渡します。次に、このクラスの新しいインスタンスをワークフローサービスホストまたはワークフローインスタンスに拡張として追加します。次のコード例は、ワークフローインスタンスに対してこの手順を実行する方法を示しています。

ChannelCacheSettings factorySettings = new ChannelCacheSettings{  
                        MaxItemsInCache = 5,
                        IdleTimeout = TimeSpan.FromMinutes(5),
                        LeaseTimeout = TimeSpan.FromMinutes(20)};  
  
ChannelCacheSettings channelSettings = new ChannelCacheSettings{  
                        MaxItemsInCache = 5,
                        IdleTimeout = TimeSpan.FromMinutes(2),  
                        LeaseTimeout = TimeSpan.FromMinutes(10) };  
  
SendMessageChannelCache customChannelCacheExtension =
    new SendMessageChannelCache(factorySettings, channelSettings);  
  
clientInstance.Extensions.Add(customChannelCacheExtension);

構成で定義されているエンドポイントがワークフローサービスにある場合にキャッシュを有効にするには、SendMessageChannelCache パラメーターが SendMessageChannelCache に設定された、パラメーター化されたコンストラクター allowUnsafeCaching を使用して true クラスをインスタンス化します。次に、このクラスの新しいインスタンスをワークフローサービスホストまたはワークフローインスタンスに拡張として追加します。次のコード例は、ワークフローインスタンスのキャッシュを有効にする方法を示しています。

SendMessageChannelCache customChannelCacheExtension =
    new SendMessageChannelCache{ AllowUnsafeCaching = true };  
  
clientInstance.Extensions.Add(customChannelCacheExtension);

チャネルファクトリおよびチャネルのキャッシュを完全に無効にするには、チャネルファクトリキャッシュを無効にします。こうすると、対応するチャネルファクトリにチャネルが所有されるので、チャネルキャッシュもオフになります。チャネルファクトリキャッシュを無効にするには、factorySettings 値が 0 の SendMessageChannelCache インスタンスに初期化された ChannelCacheSettings コンストラクターに MaxItemsInCache パラメーターを渡します。このコード例を次に示します。

// Disable the factory cache. This results in the channel cache to be turned off as well.  
ChannelCacheSettings factorySettings = new ChannelCacheSettings  
    { MaxItemsInCache = 0 };  
  
ChannelCacheSettings channelSettings = new ChannelCacheSettings();  
  
SendMessageChannelCache customChannelCacheExtension =
    new SendMessageChannelCache(factorySettings, channelSettings);
  
clientInstance.Extensions.Add(customChannelCacheExtension);

チャネルファクトリキャッシュのみを使用し、チャネルキャッシュを無効にするには、channelSettings 値が 0 の SendMessageChannelCache インスタンスに初期化された ChannelCacheSettings コンストラクターに MaxItemsInCache パラメーターを渡します。このコード例を次に示します。

ChannelCacheSettings factorySettings = new ChannelCacheSettings();  
// Disable only the channel cache.  
ChannelCacheSettings channelSettings = new ChannelCacheSettings  
    { MaxItemsInCache = 0};  
  
SendMessageChannelCache customChannelCacheExtension =
    new SendMessageChannelCache(factorySettings, channelSettings);
  
clientInstance.Extensions.Add(customChannelCacheExtension);

ホストされたワークフローサービスでは、ファクトリキャッシュとチャネルキャッシュの設定をアプリケーション構成ファイルで指定できます。これを行うには、ファクトリキャッシュおよびチャネルキャッシュのキャッシュ設定を含むサービス動作を追加し、そのサービス動作をサービスに追加します。次の例は、カスタムのファクトリキャッシュおよびチャネルキャッシュの設定が指定された MyChannelCacheBehavior サービス動作を含む構成ファイルの内容を示しています。このサービス動作は、behaviorConfiguration 属性を通じてサービスに追加されます。

<configuration>
  <system.serviceModel>  
    <!-- List of other config sections here -->
    <behaviors>  
      <serviceBehaviors>  
        <behavior name="MyChannelCacheBehavior">  
          <sendMessageChannelCache allowUnsafeCaching ="false" >  
            <!-- Control only the host level settings -->
            <factorySettings maxItemsInCache = "8" idleTimeout = "00:05:00" leaseTimeout="10:00:00" />  
            <channelSettings maxItemsInCache = "32" idleTimeout = "00:05:00" leaseTimeout="00:06:00" />  
          </sendMessageChannelCache>  
        </behavior>  
      </serviceBehaviors>  
    </behaviors>  
    <services>  
      <service name="MyService" behaviorConfiguration="MyChannelCacheBehavior" />  
    </services>  
  </system.serviceModel>  
</configuration>

キャッシュ共有レベル

クライアント ワークフローのキャッシュ共有レベルの変更

ホストされるワークフロー サービスのキャッシュ共有レベルの変更

キャッシュ設定のカスタマイズ

その他のリソース

クライアントワークフローのキャッシュ共有レベルの変更

ホストされるワークフローサービスのキャッシュ共有レベルの変更