.NET Framework 4.5 での Windows Workflow Foundation の新機能

[アーティクル]
05/10/2023

.NET Framework 4.5 の Windows Workflow Foundation (WF) には、新しいアクティビティ、デザイナー機能、ワークフロー開発モデルなど、多くの新機能が導入されています。 .NET Framework 4.5 で導入された新しいワークフロー機能の多く (ただし、すべてではありません) は、ホストを変更したワークフローデザイナーでサポートされています。サポートされる新機能の詳細については、「再ホストされたワークフローデザイナーにおける Workflow Foundation 4.5 の新機能のサポート」を参照してください。 .NET Framework 3.0 および .NET Framework 3.5 のワークフローアプリケーションを移行して最新バージョンを使用する方法の詳細については、「移行ガイダンス」を参照してください。この記事では、.NET Framework 4.5 で導入された新しいワークフロー機能の概要について説明します。

警告

.NET Framework 4.5 で導入された新しい Windows Workflow Foundation 機能は、以前のバージョンのフレームワークを対象とするプロジェクトには使用できません。 .NET Framework 4.5 を対象とするプロジェクトの対象を以前のバージョンのフレームワークに変更すると、いくつかの問題が発生する場合があります。

デザイナーでは、C# の式が「値が XAML で設定されました」というメッセージに置き換えられます。
次のエラーを含む、多くのビルドエラーが発生します。

現在のターゲットフレームワークと互換性のないファイル形式です。ファイル形式を変換するにはファイルを明示的に保存してください。このエラーメッセージは、ファイルを保存してデザイナーを開き直すと表示されなくなります。

ワークフローのバージョン管理

.NET Framework 4.5 では、新しい WorkflowIdentity クラスに基づいて、いくつかの新しいバージョン管理機能が導入されました。 WorkflowIdentity には、ワークフローアプリケーションの作成者向けに、永続化されたワークフローインスタンスをその定義でマップするメカニズムが備わっています。

WorkflowApplication ホスティングを使用する開発者は、WorkflowIdentity を使用して、ワークフローの複数のバージョンを同時にホストできます。永続化されたワークフローインスタンスは新しい WorkflowApplicationInstance クラスを使用して読み込むことができ、ホストは DefinitionIdentity を使用して、WorkflowApplication のインスタンス化時に適切なバージョンのワークフロー定義を提供できます。詳細については、「WorkflowIdentity と Versioning の使用」および「方法: ワークフローの複数のバージョンを同時にホストする」を参照してください。
現在、WorkflowServiceHost は複数のバージョンのホストです。ワークフローサービスの新しいバージョンを配置すると、新しいインスタンスが新しいサービスを使用して作成されますが、既存のインスタンスは以前のバージョンを使用して完了します。詳細については、「WorkflowServiceHost による side-by-side でのバージョン管理」を参照してください。
永続化されたワークフローインスタンスの定義を更新するためのメカニズムを提供する動的更新が導入されました。詳細については、「動的な更新」および「方法: 実行中のワークフローインスタンスの定義を更新する」を参照してください。
SqlWorkflowInstanceStoreSchemaUpgrade.sql データベーススクリプトは、.NET Framework 4 データベーススクリプトを使用して作成された永続性データベースをアップグレードするために用意されています。このスクリプトにより、.NET Framework 4.5 で導入された新しいバージョン管理機能をサポートするように .NET Framework 4 永続性データベースが更新されます。データベースで永続化されたワークフローインスタンスは、既定のバージョン番号が付与されるため、side-by-side 実行および動的更新に参加できるようになります。詳細については、「ワークフローのバージョン管理をサポートする .NET Framework 4 永続性データベースのアップグレード」を参照してください。

Activities

組み込みのアクティビティライブラリには、既存のアクティビティ用の新しいアクティビティと新しい機能が含まれています。

NoPersistScope

NoPersistScope は、NoPersistScope の子アクティビティの実行時にワークフローが永続化されないようにする新しいコンテナーアクティビティです。これは、ワークフローがファイルハンドルなどのコンピューター固有のリソースを使用している場合、データベーストランザクション中など、ワークフローの永続化が適切でないシナリオで役立ちます。以前のバージョンでは、アクティビティ実行中に永続化されないようにするために、NativeActivity を使用したカスタム NoPersistHandle が必要でした。

フローチャートの新機能

.NET Framework 4.5 用に更新されたフローチャートには、次の新機能があります。

DisplayName アクティビティまたは FlowSwitch<T> アクティビティの FlowDecision プロパティは編集できます。これにより、アクティビティデザイナーではアクティビティの目的に関する詳細な情報を表示できます。
フローチャートには ValidateUnconnectedNodes という新しいプロパティがあります。このプロパティの既定値は False です。このプロパティを True に設定すると、接続されていないフローチャートノードでは検証エラーが発生します。

部分信頼のサポート

.NET Framework 4 のワークフローでは、完全に信頼されたアプリケーションドメインが必要でした。 .NET Framework 4.5 では、ワークフローを部分信頼環境で動作させることができます。部分信頼環境では、サードパーティのコンポーネントは、ホストのリソースに対するフルアクセスを許可しなくても使用できます。部分信頼でのワークフローの実行に関する問題は次のとおりです。

部分信頼環境では、Interop アクティビティに含まれるレガシコンポーネント (規則など) を使用することはできません。
WorkflowServiceHost において部分信頼でワークフローを実行することはできません。
部分信頼シナリオで例外を永続化すると、セキュリティ上の脅威になる可能性があります。例外の永続化を無効にするには、例外が永続化されないように ExceptionPersistenceExtension 型の拡張機能をプロジェクトに追加する必要があります。この型を実装する方法を示したコード例を次に示します。
```
public class ExceptionPersistenceExtension
{
    public ExceptionPersistenceExtension()
    {
        this.PersistExceptions = false;
    }
    public bool PersistExceptions { get; set; }
}
```
例外がシリアル化されない場合は、例外が NoPersistScope 内で使用されていることを確認してください。
アクティビティの作成者は、CacheMetadata をオーバーライドして、ワークフローランタイムが型に対してリフレクションを自動的に実行しないようにする必要があります。引数と子アクティビティには null 以外を指定する必要があり、Bind は明示的に呼び出す必要があります。 CacheMetadata のオーバーライドの詳細については、「CacheMetadata を使用したデータの公開」を参照してください。また、型が internal または private の引数のインスタンスは、リフレクションによって作成されないように、CacheMetadata で明示的に作成される必要があります。
型は、シリアル化に ISerializable または SerializableAttribute を使用しません。シリアル化する型では、DataContractSerializer をサポートする必要があります。
LambdaValue<TResult> を使用する式は RestrictedMemberAccess を必要とするため、部分信頼では動作しません。 LambdaValue<TResult> を使用するワークフローでは、これらの式を、CodeActivity<TResult> から派生するアクティビティと置き換える必要があります。 .
部分信頼では、TextExpressionCompiler または Visual Basic でホストされているコンパイラを使用して式をコンパイルすることはできませんが、以前コンパイルされた式を実行することはできます。
レベル 2 の透過性を使用する 1 つのアセンブリは、.NET Framework 4、.NET Framework 4.6.1 (完全な信頼)、および .NET Framework 4.6.1 (部分信頼) では使用できません。

デザイナーの新機能

デザイナーでの検索

より大規模なワークフローを管理しやすくするために、キーワードでワークフローを検索できるようになりました。この機能は Visual Studio でのみ使用できます。再ホストされたデザイナーではこの機能を使用できません。利用できる検索機能には 2 種類あります。

クイック検索 (Ctrl+F キーまたは [編集] 、 [検索と置換] 、 [クイック検索] で開始します)。
フォルダーを指定して検索 (Ctrl+Shift+F キーまたは [編集] 、 [検索と置換] 、 [フォルダーを指定して検索] で開始します)。

置換はサポートされていません。

クイック検索

ワークフロー内で検索されるキーワードは、次のデザイナー項目に一致します。

Activity オブジェクト、FlowNode オブジェクト、State オブジェクト、Transition オブジェクト、およびその他のカスタムフロー制御項目のプロパティ。
変数
引数
式

クイック検索はデザイナーの ModelItem ツリーで実行されます。クイック検索は、ワークフロー定義にインポートされた名前空間を検索しません。

[フォルダーを指定して検索]

ワークフロー内で検索されるキーワードは、ワークフローファイルの実際のコンテンツに一致します。検索結果は Visual Studio の検索結果ビューペインに表示されます。結果の項目をダブルクリックすると、ワークフローデザイナーで一致を含むアクティビティに移動します。

変数デザイナーと引数デザイナーのコンテキストメニューの [削除]

.NET Framework 4 では、変数および引数を削除できるのは、デザイナーでキーボードを使用した場合だけでした。 .NET Framework 4.5 以降では、コンテキストメニューを使用して変数および引数を削除できます。

変数デザイナーと引数デザイナーのコンテキストメニューを次のスクリーンショットに示しています。

ブロックの自動挿入シーケンス

ワークフローまたは特定のコンテナーアクティビティ (NoPersistScope など) には Body アクティビティを 1 つしか含めることができないため、2 つ目のアクティビティを追加するには、開発者が最初のアクティビティを削除し、Sequence アクティビティを追加してから、シーケンスアクティビティに両方のアクティビティを追加する必要がありました。 .NET Framework 4.5 以降では、デザイナー画面に 2 つ目のアクティビティを追加すると、Sequence アクティビティが自動的に作成され、両方のアクティビティがラップされます。

次のスクリーンショットは、WriteLine の Body 内の NoPersistScope アクティビティを示しています。

NoPersistScope アクティビティの Body 内の WriteLine アクティビティ。

次のスクリーンショットは、2 つ目の WriteLine を 1 つ目の下にドロップしたときに Body 内に自動的に作成された Sequence アクティビティを示しています。

NoPersistScope の Body 内に自動的に作成された Sequence。

パンモード

デザイナーで大規模なワークフロー内をより簡単に移動するには、パンモードを有効にすると、開発者は、スクロールバーを使用する必要なく、ワークフローの表示される部分をクリックおよびドラッグして移動できるようになります。パンモードをアクティブ化するボタンは、デザイナーの右下隅にあります。

次のスクリーンショットは、ワークフローデザイナーの右下隅にあるパンボタンを示しています。

マウスの中央ボタンまたは Space キーを使用して、ワークフローデザイナーをパンすることもできます。

複数選択

複数のアクティビティを同時に選択できます。これを行うには、複数のアクティビティを囲むようにドラッグするか (パンモードが無効な場合)、Ctrl キーを押したまま目的のアクティビティを 1 つずつクリックします。

選択した複数のアクティビティは、デザイナー内でドラッグアンドドロップすることも、コンテキストメニューを使用して操作することもできます。

ワークフロー項目のアウトライン表示

階層ワークフローを移動しやすくするため、ワークフローのコンポーネントはツリースタイルのアウトライン表示で示されます。アウトライン表示は、 [ドキュメントアウトライン] ビューに表示されます。このビューを開くには、上部のメニューから [表示] 、 [その他のウィンドウ] 、 [ドキュメントアウトライン] の順に選択するか、Ctrl キーを押しながら W キーと U キーを押します。アウトライン表示でノードをクリックすると、ワークフローデザイナーの対応するアクティビティに移動し、アウトライン表示が更新されて、デザイナーで選択されているアクティビティが表示されます。

「チュートリアル入門」の完成したワークフローの次のスクリーンショットは、シーケンシャルワークフローを含むアウトライン表示を示しています。

Visual Studio のシーケンシャルワークフローを含むアウトライン表示のスクリーンショット。

C# の式

.NET Framework 4.5 より前のバージョンでは、ワークフロー内のすべての式を Visual Basic のみで記述できました。 .NET Framework 4.5 では、Visual Basic の式は Visual Basic を使用して作成されたプロジェクトでのみ使用されます。 Visual C# プロジェクトでは、式に C# が使用されるようになりました。文法強調表示や Intellisense などの機能を備えた、フル機能の C# 式エディターが用意されています。以前のバージョンで作成された、Visual Basic の式を使用する C# ワークフロープロジェクトは引き続き動作します。

C# の式はデザイン時に検証されます。 C# 式のエラーは赤い波下線でマークされます。

C# 式の詳細については、「C# の式」を参照してください。

シェルバーおよびヘッダー項目の可視性の詳細な制御

再ホストされたデザイナーでは、標準 UI コントロールの中に、特定のワークフローにとって意味がないものもあれば、無効になっているものもあります。 .NET Framework 4 では、このカスタマイズがデザイナーの下部のシェルバーのみでサポートされています。 .NET Framework 4.5 では、デザイナーの上部にあるシェルのヘッダー項目の表示は、WorkflowShellHeaderItemsVisibility に適切な ShellHeaderItemsVisibility 値を設定することにより調整できます。

フローチャートおよびステートマシンのワークフローの自動接続と自動挿入

.NET Framework 4 では、フローチャートワークフロー内のノード間の接続は手動で追加する必要がありました。 .NET Framework 4.5 では、フローチャートおよびステートマシンのノードに、アクティビティをツールボックスからデザイナー画面上にドラッグすると表示される自動接続ポイントがあります。アクティビティをこれらのポイントのうち 1 つにドロップすると、アクティビティが必要な接続と共に自動的に追加されます。

次のスクリーンショットは、アクティビティがツールボックスからドラッグされるときに表示されるアタッチポイントを示します。

フローチャートの開始ノードに自動接続ポイントが示されている

アクティビティは、フローチャートノードと状態の間の接続にドラッグすることで、その他 2 つのノード間にノードを自動挿入することもできます。次のスクリーンショットは、アクティビティをツールボックスからドラッグアンドドロップできる、強調表示された接続線を示しています。

アクティビティをドロップするための自動挿入ハンドル

デザイナー注釈

より大規模なワークフローの開発を容易にするため、デザインプロセスを追跡できるよう注釈の追加がサポートされるようになりました。注釈は、アクティビティ、状態、フローチャートノード、変数、および引数に追加できます。次のスクリーンショットは、デザイナーに注釈を追加するためのコンテキストメニューを示しています。

デバッグ状態

.NET Framework 4 では、アクティビティ以外の要素は、実行の単位ではないため、デバッグブレークポイントがサポートされていませんでした。このリリースでは、State オブジェクトにブレークポイントを追加する機能が用意されています。ブレークポイントを State に設定した場合、そのエントリアクティビティまたはトリガーがスケジュールされる前に、状態が遷移すると実行が停止します。

デザイナーでの ActivityDelegate オブジェクトの定義と使用

.NET Framework 4 のアクティビティでは、ActivityDelegate オブジェクトを使用して、ワークフローの他の部分がワークフローの実行と対話できる実行ポイントを公開していましたが、通常、これらの実行ポイントを使用するには相当な量のコードが必要でした。このリリースでは、開発者はワークフローデザイナーを使用してアクティビティデリゲートを定義および使用できます。詳細については、「ワークフローデザイナーでアクティビティデリゲートを定義および使用する方法」を参照してください。

ビルド時の検証

.NET Framework 4 では、ワークフローの検証エラーが、ワークフロープロジェクトのビルド中のビルドエラーとして数えられていませんでした。つまり、ワークフローの検証エラーが発生した場合でも、ワークフロープロジェクトのビルドは成功している可能性があります。 .NET Framework 4.5 では、ワークフローの検証エラーが発生するとビルドは失敗します。

デザイン時バックグラウンド検証

.NET Framework 4 では、ワークフローがフォアグラウンドプロセスとして検証されていました。これにより、複雑または時間のかかる検証プロセスでは UI がブロックされる可能性がありました。現在、ワークフローの検証はバックグラウンドスレッドで実行されるため、UI がブロックされることはありません。

XAML ファイル内で別々の場所にあるビューステート

.NET Framework 4 では、ワークフローのビューステート情報は、多くの異なる場所にある XAML ファイルに保存されていました。これは、XAML を直接読み取ったり、ビューステート情報を削除するコードを記述したりする開発者にとっては不便です。 .NET Framework 4.5 では、XAML ファイル内のビューステート情報は XAML ファイル内の個別の要素としてシリアル化されています。開発者は、簡単に、アクティビティのビューステート情報を探して編集したり、ビューステートを完全に削除したりできます。

式の拡張性

.NET Framework 4.5 では、開発者が、ワークフローデザイナーにプラグインできる、独自の式および式作成操作を作成できるようになります。

再ホストされたデザイナーでの Workflow 4.5 機能のオプトイン

下位互換性を維持するために、再ホストされたデザイナーでは、.NET Framework 4.5 に含まれる新機能の一部が既定で有効になっていません。これは、再ホストされたデザイナーを使用する既存のアプリケーションが、最新バージョンに更新することで壊れないようにするためです。再ホストされたデザイナーで新機能を有効にするには、TargetFrameworkName を ".NET Framework 4.5" に設定するか、DesignerConfigurationService の各メンバーを設定して各機能を有効にします。

新しいワークフロー開発モデル

このリリースには、フローチャートおよびシーケンシャルワークフロー開発モデルに加えて、ステートマシンのワークフロー、およびコントラクト優先ワークフローサービスが含まれています。

ステートマシンのワークフロー

ステートマシンワークフローは、.NET Framework 4、バージョン 4.0.1 の一部として Microsoft .NET Framework 4 Platform Update 1 で導入されました。この更新プログラムには、開発者がステートマシンのワークフローを作成できるようにする、いくつかの新しいクラスとアクティビティが含まれていました。これらのクラスおよびアクティビティは .NET Framework 4.5 用に更新されました。更新プログラムには次のものが含まれています。

状態にブレークポイントを設定する機能。
ワークフローデザイナーで遷移をコピーして貼り付ける機能。
トリガーを共有する遷移の作成に対するデザイナーのサポート。
ステートマシンのワークフロー作成に使用するアクティビティ (StateMachine State、Transition など)。

次のスクリーンショットは、「チュートリアル入門」の「方法: ステートマシンワークフローを作成する」のステップで完成したステートマシンワークフローを示しています。

完成したステートマシンワークフローを示す図。

ステートマシンワークフローの作成について詳しくは、「ステートマシンワークフロー」を参照してください。

コントラクト優先ワークフローの開発

コントラクト優先ワークフローの開発ツールにより、開発者はコード優先のコントラクトを設計することができ、その後、Visual Studio で数回クリックするだけで、各操作を表すアクティビティテンプレートをツールボックス内に自動的に生成できます。これらのアクティビティは、コントラクトで定義された操作を実装するワークフローを作成するために使用されます。ワークフローデザイナーは、ワークフローサービスを検証し、これらの操作が実装され、ワークフローの署名がコントラクトの署名と一致することを確認します。また、開発者は、ワークフローサービスを、実装済みコントラクトのコレクションと関連付けることもできます。コントラクト優先ワークフローサービスの開発について詳しくは、「既存のサービスコントラクトを使用するワークフローサービスを作成する方法」を参照してください。

.NET Framework 4.5 での Windows Workflow Foundation の新機能

ワークフローのバージョン管理