ワークフロー実行プロパティ

[アーティクル]
02/24/2011

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

CLR は、スレッドローカルストレージ (TLS) を介して各スレッドの実行コンテキストを維持します。この実行コンテキストは、スレッド ID、アンビエントトランザクション、現在のアクセス許可セットなど、既知のスレッドプロパティだけでなく、名前付きスロットのようなユーザー定義のスレッドプロパティを制御します。

CLR を直接対象にするプログラムとは異なり、ワークフロープログラムは、スレッド非依存環境で実行されるアクティビティのツリーへ階層的にスコープ設定されます。つまり、特定の作業項目のスコープに含まれるコンテキストを判断するために、標準の TLS 機構を直接使用することはできません。たとえば、2 つの並行する実行の分岐で異なるトランザクションを使用していても、スケジューラは同じ CLR スレッド上でそれらの実行をインターリーブすることがあります。

ワークフローの実行プロパティには、アクティビティの環境にコンテキスト特有のプロパティを追加する機構が用意されています。そのため、サブツリーのスコープに含まれるプロパティをアクティビティで宣言できるだけでなく、CLR オブジェクトと適切に相互作用するように TLS の設定および設定解除を行うフックを実現できます。

ワークフロー実行プロパティの作成と使用

ワークフロー実行プロパティは IExecutionProperty インターフェイスを実装します。ワークフロー実行プロパティを作成するには、IExecutionProperty インターフェイスを実装するクラスを作成し、メンバーの SetupWorkflowThread および CleanupWorkflowThread を実装します。これらのメンバーには、プロパティを含むアクティビティ (すべての子アクティビティを含む) の作業の各パルス中に、スレッドローカルストレージを適切に設定および設定解除できる実行プロパティがあります。この例では、Console.ForegroundColor を設定する ConsoleColorProperty を作成します。

注 :
このトピックの次のコード例は、「実行プロパティ」のサンプルコードに基づいています。

class ConsoleColorProperty : IExecutionProperty
{
    public const string Name = "ConsoleColorProperty";

    ConsoleColor original;
    ConsoleColor color;

    public ConsoleColorProperty(ConsoleColor color)
    {
        this.color = color;
    }

    void IExecutionProperty.SetupWorkflowThread()
    {
        original = Console.ForegroundColor;
        Console.ForegroundColor = color;
    }

    void IExecutionProperty.CleanupWorkflowThread()
    {
        Console.ForegroundColor = original;
    }
}

アクティビティ作成者がこのプロパティを使用するには、アクティビティの実行オーバーライドに登録します。この例では、現在の NativeActivityContext の Properties コレクションに追加することで、ConsoleColorProperty を登録する ConsoleColorScope アクティビティが定義されています。

public sealed class ConsoleColorScope : NativeActivity
{
    public ConsoleColorScope()
        : base()
    {
    }

    public ConsoleColor Color { get; set; }
    public Activity Body { get; set; }

    protected override void Execute(NativeActivityContext context)
    {
        context.Properties.Add(ConsoleColorProperty.Name, new ConsoleColorProperty(this.Color));

        if (this.Body != null)
        {
            context.ScheduleActivity(this.Body);
        }
    }
}

アクティビティの本体が作業のパルスを開始すると、プロパティの SetupWorkflowThread メソッドが呼び出されます。作業のパルスが完了すると、CleanupWorkflowThread が呼び出されます。この例では、3 つの分岐がある Parallel アクティビティを使用するワークフローが作成されます。最初の 2 つの分岐では ConsoleColorScope アクティビティを使用しますが、3 つ目の分岐は使用しません。3 つの分岐にはいずれも 2 つの WriteLine アクティビティと 1 つの Delay アクティビティが含まれます。Parallel アクティビティが実行されると、その分岐に含まれるアクティビティはインターリーブ形式で実行されますが、それぞれの子アクティビティが実行されるため、ConsoleColorProperty によって適切なコンソールの色が適用されます。

Activity wf = new Parallel
{
    Branches = 
    {
        new ConsoleColorScope
        {
            Color = ConsoleColor.Blue,
            Body = new Sequence
            {
                Activities = 
                {
                    new WriteLine
                    {
                        Text = "Start blue text."
                    },
                    new Delay
                    {
                        Duration = TimeSpan.FromSeconds(1)
                    },
                    new WriteLine
                    {
                        Text = "End blue text."
                    }
                }
            }
        },
        new ConsoleColorScope
        {
            Color = ConsoleColor.Red,
            Body = new Sequence
            {
                Activities = 
                {
                    new WriteLine
                    {
                        Text = "Start red text."
                    },
                    new Delay
                    {
                        Duration = TimeSpan.FromSeconds(1)
                    },
                    new WriteLine
                    {
                        Text = "End red text."
                    }
                }
            }
        },
        new Sequence
        {
            Activities = 
            {
                new WriteLine
                {
                    Text = "Start default text."
                },
                new Delay
                {
                    Duration = TimeSpan.FromSeconds(1)
                },
                new WriteLine
                {
                    Text = "End default text."
                }
            }
        }
    }
};

WorkflowInvoker.Invoke(wf);

このワークフローを呼び出すと、次の出力がコンソールウィンドウに書き込まれます。

Start blue text.
Start red text.
Start default text.
End blue text.
End red text.
End default text.

注 :
前の出力には示していませんが、コンソールウィンドウの各テキスト行は、指定した色で表示されます。

ワークフロー実行プロパティは、カスタムアクティビティ作成者が使用できます。また、このプロパティには、CorrelationScope や TransactionScope などのアクティビティ向けにハンドル管理の機構も用意されています。

参照

リファレンス

IExecutionProperty
IPropertyRegistrationCallback
RegistrationContext

次の方法で共有

ワークフロー実行プロパティ

ワークフロー実行プロパティの作成と使用

参照

リファレンス

その他のリソース