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

このトピックの内容は、Windows Workflow Foundation 4 に該当します。

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

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

キャッシュ共有レベル

既定では、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 クラスは、チャネル ファクトリ キャッシュおよびチャネル キャッシュの既定のキャッシュ設定を、その既定のコンストラクターで定義します。次の表は、これらのキャッシュ設定の既定値をキャッシュのタイプごとに示しています。

ファクトリ キャッシュおよびチャネル キャッシュの設定をカスタマイズするには、パラメーター化されたコンストラクター 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);

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

    SendMessageChannelCache customChannelCacheExtension = 
        new SendMessageChannelCache{ AllowUnsafeCaching = true };

    clientInstance.Extensions.Add(customChannelCacheExtension);

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

    // 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);

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

    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 サービス動作を含む構成ファイルの内容を示しています。このサービス動作は、behaviorConfiguarion 属性を通じてサービスに追加されます。

<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>