変数と引数

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

Windows Workflow Foundation (WF) では、変数はデータストレージを表し、引数はアクティビティとの間のデータフローを表します。アクティビティには一連の引数があり、その引数はアクティビティの署名を構成します。また、アクティビティは開発者がワークフローの設計時に変数を追加または削除できる変数のリストを保持しています。引数は、値を返す式を使用してバインドされます。

変数

変数はデータを保存する場所です。変数はワークフロー定義の一部として宣言されます。変数は実行時に値を受け取ります。これらの値はワークフローインスタンスの状態の一部として保存されます。変数の定義では、変数の型を指定します。オプションで名前を指定する場合もあります。変数を宣言し、Assign<T> アクティビティを使用して変数に値を代入し、その値を WriteLine アクティビティを使用してコンソールに表示する方法を次のコードに示します。

// Define a variable named "str" of type string.  
Variable<string> var = new Variable<string>  
{  
    Name = "str"  
};  
  
// Declare the variable within a Sequence, assign  
// a value to it, and then display it.  
Activity wf = new Sequence()  
{  
    Variables = { var },  
    Activities =  
    {  
        new Assign<string>  
        {  
            To = var,  
            Value = "Hello World."  
        },  
        new WriteLine  
        {  
            Text = var  
        }  
    }  
};  
  
WorkflowInvoker.Invoke(wf);

オプションで、変数宣言の一部として既定値の式を指定できます。また、変数は修飾子を使用することもできます。たとえば変数が読み取り専用の場合は、読み取り専用の VariableModifiers 修飾子を適用できます。次の例では、既定値を代入した読み取り専用の変数を作成します。

// Define a read-only variable with a default value.  
Variable<string> var = new Variable<string>  
{  
    Default = "Hello World.",  
    Modifiers = VariableModifiers.ReadOnly  
};

変数のスコープ

実行時の変数の有効期間は、変数を宣言したアクティビティの有効期間と同じです。アクティビティが完了すると、その変数はクリーンアップされ、その後は参照できません。

引数

アクティビティの作成者は、引数を使用してアクティビティとのデータフローの方法を定義します。各引数には In、Out、InOut などの方向が指定されます。

ワークフローランタイムでは、アクティビティへのデータ移動のタイミングについて次のように保証しています。

アクティビティが実行を開始すると、すべての入力および入出力引数の値が計算されます。たとえば、Get が呼び出されるタイミングにかかわらず、返される値は Execute が呼び出される前にランタイムによって計算された値になります。
Set が呼び出されると、ランタイムはすぐにその値を設定します。
必要に応じて、引数に EvaluationOrder を指定できます。 EvaluationOrder は引数の評価順序を指定するゼロベースの値です。既定では引数の評価順序は指定されておらず、UnspecifiedEvaluationOrder の値と同じです。 EvaluationOrder に 0 以上の値を設定して、この引数の評価順序を指定します。 Windows Workflow Foundation により、指定した評価順序を使用して引数が昇順で評価されます。評価順序が指定されていない引数は、評価順序が指定されている引数の前に評価されることに注意してください。

アクティビティの作成者は、引数を公開する場合に厳密な型指定のメカニズムを使用できます。これを行うには、InArgument<T>、OutArgument<T>、および InOutArgument<T> の型のプロパティを宣言します。これにより、アクティビティの作成者は、アクティビティに受け渡しするデータの特定のコントラクトを確立できます。

アクティビティの引数の定義

InArgument<T>、OutArgument<T>、および InOutArgument<T> 型のプロパティを指定することで、アクティビティに引数を定義できます。次のコードでは、ユーザーに表示する文字列を受け取り、ユーザーの応答を含む文字列を返す Prompt アクティビティの引数を定義する方法を示します。

public class Prompt : Activity  
{  
    public InArgument<string> Text { get; set; }  
    public OutArgument<string> Response { get; set; }  
    // Rest of activity definition omitted.  
}

Note

1 つの値を返すアクティビティは、Activity<TResult>、NativeActivity<TResult>、または CodeActivity<TResult> から派生させることができます。これらのアクティビティは、アクティビティの戻り値を含む OutArgument<T> という名前の適切に定義された Result を持っています。

ワークフローでの変数と引数の使用

次の例は、ワークフローで変数と引数を使用する方法を示しています。このワークフローは、3 つの変数 var1、var2、var3 を宣言するシーケンスです。このワークフローの最初のアクティビティは Assign アクティビティで、変数 var1 の値を変数 var2 に代入します。これに WriteLine アクティビティが続き、変数 var2 の値を出力します。その次はもう 1 つの Assign アクティビティで、変数 var2 の値を変数 var3 に代入します。最後にもう 1 つの WriteLine アクティビティがあり、変数 var3 の値を出力します。最初の Assign アクティビティは、アクティビティの引数のバインドを明示的に表す InArgument<string> オブジェクトと OutArgument<string> オブジェクトを使用します。 InArgument<string> は、値が Value アクティビティにその Assign<T> 引数を通ってフローするので、Value に使用されます。OutArgument<string> は、値が To 引数から変数へフローするので、To に使用されます。 2 番目の Assign アクティビティは、より少ないコードで暗黙的なキャストを使用する同等の構文を使用して同じ内容を実行します。 WriteLine アクティビティも少ないコードの構文を使用します。

// Declare three variables; the first one is given an initial value.  
Variable<string> var1 = new Variable<string>()  
{  
    Default = "one"  
};  
Variable<string> var2 = new Variable<string>();  
Variable<string> var3 = new Variable<string>();  
  
// Define the workflow  
Activity wf = new Sequence  
{  
    Variables = { var1, var2, var3 },  
    Activities =
    {  
        new Assign<string>()  
        {  
            Value = new InArgument<string>(var1),  
            To = new OutArgument<string>(var2)  
        },  
        new WriteLine() { Text = var2 },  
        new Assign<string>()  
        {  
            Value = var2,  
            To = var3  
        },  
        new WriteLine() { Text = var3 }  
    }  
};  
  
WorkflowInvoker.Invoke(wf);

コードに基づいたアクティビティでの変数と引数の使用

前の例は、ワークフローの引数と変数、および宣言型のアクティビティを使用する方法を示しています。引数と変数は、コードに基づくアクティビティでも使用されます。概念上は、使用法は非常に似ています。変数はアクティビティ内のデータストレージを表し、引数はアクティビティへのデータフローを表し、ワークフロー作成者によってワークフローでデータの受け渡しを行う場所を示す他の変数または引数にバインドされます。アクティビティの変数または引数の値を取得または設定するには、アクティビティの現在の実行環境を表すアクティビティコンテキストを使用する必要があります。これは、ワークフローランタイムによってアクティビティの Execute メソッドに渡されます。次の例では、2 つの Add 引数を持つカスタムの In アクティビティが定義されています。この引数の値にアクセスするために Get メソッドが使用され、ワークフローランタイムによって渡されたコンテキストが使用されます。

public sealed class Add : CodeActivity<int>  
{  
    [RequiredArgument]  
    public InArgument<int> Operand1 { get; set; }  
  
    [RequiredArgument]  
    public InArgument<int> Operand2 { get; set; }  
  
    protected override int Execute(CodeActivityContext context)  
    {  
        return Operand1.Get(context) + Operand2.Get(context);  
    }  
}

コード内の引数、変数、式を操作する方法について詳しくは、「命令型コードを使用してワークフロー、アクティビティ、および式を作成する方法」および「必須の引数とオーバーロードグループ」をご覧ください。

変数と引数

変数

変数のスコープ

引数

アクティビティの引数の定義

ワークフローでの変数と引数の使用

コードに基づいたアクティビティでの変数と引数の使用

フィードバック

その他のリソース