WPFのためのPrism Libraryを使用して、疎く結合したコンポーネントの間で情報をやりとりする

Solution Commanding

あなたが、（たとえば、ボタンやメニュー項目の）コマンドの呼び出し元をクリックするような、ユーザー・ジェスチャーに対応する必要がある場合、 そして、あなたが、ビジネス・ロジックを基づいて、有効するために、呼び出し元を望む場合、コマンドを使用します。

Windows Presentation Foundation (WPF)は、キーボードフォーカスを持っているビジュアル・ツリーの現在の項目に、関連付けられるコマンド・ハンドラで、メニュー項目とボタンのような、コマンドの呼び出し元を結合するのに役に立つRoutedCommandを提供します。

しかしながら、複合的な筋書きで、コマンド・ハンドラは、多くの場合、ビジュアル・ツリーで、関連するどんな要素も持っていないか、フォーカスされた要素ではなく、ViewModelです。この筋書きに対応するために、Prism Libraryは、コマンドが実行されるとき、あなたが、デリゲート・メソッドを呼び出すことができるDelegateCommandを提供します。そして、CompositeCommandは、あなたが、複数のcommands**.**を結合することができます。これらのコマンドは、ビジュアル・ツリー上に、そして、その下に、コマンド実行と処理を割り振りふる組み込みのRoutedCommandとは異なります。これは、あなたが、ビジュアル・ツリーのこの場所で、コマンドを起動し、そして、それを高いレベルで操作できます。

CompositeCommandは、呼び出し元に結合することができる、ICommandの実装です。CompositeCommandsは、いくつかの子のコマンドに結合されることができます。;CompositeCommandが、呼び出されるとき、子のコマンドもまた、呼び出されます。

CompositeCommandsは、有効化をサポートしています。CompositeCommandsは、その接続されているコマンドの各々のCanExecuteChangedイベントに耳を傾けます。それは、続いて、呼び出し元に知らせるこのイベントを起動します。呼び出し元は、CompositeCommand上で、CanExecuteを呼び出すことによって、このイベントに反応します。CompositeCommandは、続いて、各々の子のコマンド上で、CanExecuteを呼び出すことによって、あらためて、すべてのその子のコマンドの意見を尋ねます。CanExecuteへのどんな呼び出しも、falseを返すとき、CompositeCommandは、falseを返し、このように、呼び出し元を無効にします。

これは、どのように、あなたを、モジュールを横断する通信で支援しますか？Prism Libraryに基づいたアプリケーションは、Save、Save AllやCancelのような、モジュールを横断する意味を持つ、シェル内で定義されている、広域のCompositeCommandsを持ているかもしれません。モジュールは、続いて、これらのグローバルコマンドで、それらのローカル・コマンドを登録することができます。そして、それらの実行に関与しています。

備考: DelegateCommandとCompositeCommandは、Prism.Core Nugetパッケージに配置されるPrism.Commands名前空間で見つかります。

About WPF Routed Events and Routed Commands

ルーティングイベントは、イベントを直接購読したオブジェクトだけに知らせる代わりに、要素ツリー内の複数のリスナー上に、ハンドラを呼び出すことができる一種のイベントです。WPFのルーティング・コマンドは、ビジュアル・ツリー内のUI要素によって、コマンド・メッセージを伝えます。しかし、ツリーの外側の要素は、これらのメッセージを受け取りません。なぜなら、それらは、フォーカスされた要素や明示的な状態の対象とする要素だけで、上昇したり、下降したりします。イベントのためのイベント・データは、ルート内の各々の要素に永続化されるため、ルーティングイベントは、要素ツリーを介して、情報をやりとりするために使用することができます。1つの要素は、イベント・データで、何かを変更することができます。そして、その変更は、ルート内で、次の要素が利用できるようになります。

その結果、あなたは、次のシナリオの中の、WPFルーティングイベントを使用する必要があります。：共通ルートに共通のハンドラを定義したり、独自のカスタムコントロールクラスを定義します。

Creating a Delegate Command

デリゲート・コマンドを作成するために、あなたのViewModelのコンストラクタで、DelegateCommand領域をインスタンス化します。そして、その次に、ICommandプロパティとして、それを公開します。

// ArticleViewModel.cs
public class ArticleViewModel : BindableBase
{
    private readonly ICommand showArticleListCommand;

    public ArticleViewModel(INewsFeedService newsFeedService,
                            IRegionManager regionManager,
                            IEventAggregator eventAggregator)
    {
        this.showArticleListCommand = new DelegateCommand(this.ShowArticleList);
    }

    public ICommand ShowArticleListCommand
    {
        get { return this.showArticleListCommand; }
    }
}

Creating a Composite Command

複合コマンドを作成するために、コンストラクタ内で、CompositeCommand領域をインスタンス化します。それに、コマンドを追加します。そして、その次に、ICommandプロパティとして、それを公開します。

public class MyViewModel : BindableBase
{
    private readonly CompositeCommand saveAllCommand;

    public ArticleViewModel(INewsFeedService newsFeedService,
                            IRegionManager regionManager,
                            IEventAggregator eventAggregator)
    {
        this.saveAllCommand = new CompositeCommand();
        this.saveAllCommand.RegisterCommand(new SaveProductsCommand());
        this.saveAllCommand.RegisterCommand(new SaveOrdersCommand());
    }

    public ICommand SaveAllCommand
    {
        get { return this.saveAllCommand; }
    }
}

Making a Command Globally Available

通常、グローバルに利用できるコマンドを作成するために、DelegateCommand、あるいは、CompositeCommandのインスタンスを作成し、静的クラスによって公開します。

public static class GlobalCommands
{
    public static CompositeCommand MyCompositeCommand = new CompositeCommand();
}

あなたのモジュールで、グローバルに利用できるコマンドに、子のコマンドを関連付けます。

GlobalCommands.MyCompositeCommand.RegisterCommand(command1);
GlobalCommands.MyCompositeCommand.RegisterCommand(command2);

備考: あなたのコードのテスト容易性を向上させるために、あなたは、グローバルに利用できるコマンドを呼び出すために、プロキシ・クラスを使用する、そして、あなたのテスト内のプロキシ・クラスのモックを作成することができます。

Binding to a Globally Available Command

次のコード例は、WPFのボタンをコマンドに、どのように、結合するかを示します。

<Button Name="MyCompositeCommandButton" Command="{x:Static local:GlobalCommands.MyCompositeCommand}">Execute My Composite Command</Button>

備考: 他の方法は、Application.Resources項目内のApp.xamlファイルの内側のリソースとして、コマンドを格納することです。 続いて、ビュー内で、－それが、そのリソースを設定した後に作成する必要があります。－呼び出し元をコマンドに追加するには、あなたは、Command="{Binding MyCompositeCommand, Source={StaticResource GlobalCommands}}"を設定することができます。

Region Context

あなたが、領域内の領域とViewを格納しているView間で、コンテキスト情報を共有したい可能性がある多くの脚本があります。例えば、マスターの詳細－Viewは、ビジネス・エンティティを示す、あるいは、ビジネス・エンティティのために、追加の詳細情報を表示するために、Prism Libraryは、次の図に示すように、領域の内部に読み込まれる、格納される領域とどんなViewの間で、オブジェクトを共有するために、egionContextという名前の概念を使用します。

シナリオに依存して、あなたは、（識別子のような）情報の一部や共有されたModelを共有するために、選択できます。Viewは、RegionContext、そして、変更通知のための上へ記号を取得することができます。また、Viewは、RegionContextの値を変更することができます。RegionContextを公開する、そして、利用するいくつかの方法があります。：

• あなたは、Extensible Application Markup Language (XAML)内の領域に、RegionContextを公開することができます。
• あなたは、コード内の領域に、RegionContextを公開することができます。
• あなたは、領域内でViewからRegionContextを利用することができます。

備考: そのViewが、DependencyObjectである場合、Prism Libraryは、現在、領域内で、Viewから、RegionContextを利用することをサポートするだけです。あなたのViewが、DependencyObjectでない場合、(たとえば、あなたは、WPFの自動データ・テンプレートを使用して、あなたのViewModelを、直接、領域に追加します）、カスタムRegionBehaviorを、前のRegionContextに、あなたのViewオブジェクトに作成することについて考えてみてください。

About the Data Context Property

データ・コンテクストは、要素は、結合のために使用されるデータ・ソースに関する、それらの親の要素から、情報を継承できる概念です。子要素は、自動的に、それらの親の要素のDataContextを継承します。データは、ビジュアル・ツリーを流れ落ちます。

Shared Services

モジュールを横断する通信のもう1つの方法は、共有サービスを介して行われます。モジュールが読み込まれるとき、モジュールは、それらのサービスをサービス・ロケーターに加えます。通常、サービスは、一般的なインターフェイス型で、サービス・ロケーターから、登録されて、取得されます。これは、モジュールに静的参照を必要とすることなく、モジュールが、他のモジュールで提供されるサービスを使用できます。サービス・インスタンスは、モジュール全体で共有されます。それで、あなたは、データを共有し、そして、モジュール間でメッセージを渡すことができます。

株トレーダーの参考になる実装（株トレーダーRI）では、Marketモジュールは、IMarketFeedServiceの実装を提供します。Positionモジュールは、サービスの位置と解像度を提供する、シェル・アプリケーションの依存関係注入コンテナを使用することにより、これらのサービスを利用します。IMarketFeedServiceは、StockTraderRI.Infrastructure共有アセンブリで見つかるように、他のモジュールで利用されることを示しますが、Marketモジュール内で、直接定義され、そして、他のモジュールと独立して、更新することができるように、このインターフェイスの具体的な実装は、共有する必要はありません。

これらのサービスが、どのようにMEFにエクスポートされているか、確認するには、次のコードの例に示すように、MarketFeedService.csとMarketHistoryService.csファイルを参照してください。PositionモジュールのObservablePositionは、コンストラクタの依存関係の注入を通して、IMarketFeedServiceサービスを受け取ります。

// MarketFeedService.cs [Export(typeof(IMarketFeedService))] [PartCreationPolicy(CreationPolicy.Shared)] public class MarketFeedService : IMarketFeedService, IDisposable { ... }

これは、サービスの利用者は、サービスを提供しているモジュールに静的参照を必要としていないため、モジュールを横断する通信に役立ちます。 このサービスは、モジュールの間で、データーを送信、あるいは、受信するために使用することができます。

備考: いくつかの依存関係注入コンテナは、この例で示すように、属性を使用して依存関係の登録ができます。他のコンテナは、明示的な登録を使用するかもしれません。これらの場合では、登録は、一般的に、Prismが、IModule.Initializeメソッドを呼び出すとき、モジュール読み込みの間に、発生します。 詳しくは、モジュール・アプリケーション開発を参照してください。

Event Aggregation

Prism Libraryは、アプリケーションの疎く結合したコンポーネントの間で、通信を有効にするイベントの仕組みを提供します。この仕組みは、発行者と購読者が、イベントを通して、情報をやりとりできる、イベント・アグリゲータ・サービスに基づいています。そして、しかし、直接、互いへの参照がありません。

EventAggregatorは、マルチキャストpublish/subscribe機能を提供します。これは、同じイベントを呼び出す複数の発行者で、できることを示しています。そして、それらは、複数の購読者が、同じイベントを聞き取ることができます。モジュールを横断してイベントを公開する、そして、コントローラとプレゼンターのような、ビジネス・ロジック・コード間でメッセージを送信するとき、EventAggregatorを使用することについて考えてみてください。

株トレーダーRIの1つの例は、Process Orderボタンがクリックされる時、そして、注文を正常に処理します。;この場合、他のモジュールは、Viewを更新することができるため、注文がうまく処理されたことを知っている必要があります。

Prism Libraryで作成されるイベントは、型指定されたイベントです。これは、あなたが、アプリケーションを実行する前に、あなたが、エラーを発見するために、コンパイル時の型検査を利用できることを示しています。Prismライブラリでは、EventAggregatorは、特定のEventBaseを配置するために、購読者や発行者を提供します。また、イベント・アグリゲータは、次の図に示すように、複数の発行者と複数の購読者を認めます。

About .NET Framework Events

使用する.NET フレームワーク・イベントは、疎結合が、要求されない場合、コンポーネントの間の通信のための、最も簡単でわかりやすい方法です。 .NET Frameworkのイベントは、Publish-Subscribeパターンを実装していますが、オブジェクトを購読するために、あなたは、複合アプリケーションでは、通常、別のモジュールに存在する、そのオブジェクトへの直接参照を必要とします。これは、結果として、密接に結合した設計になります。その結果、.NET Framework イベントは、モジュールの間の代わりに、モジュール内での通信のために使用されます。

あなたが、.NET Frameworkイベントを使用する場合、特に、あなたが、静的、あるいは、より長く生きるイベントを購読する、非静的や短命なコンポーネントを持っている場合、あなたは、メモリリークに、とても注意する必要があります。あなたが、購読者の登録を取り消さない場合、それは、発行者によって、生きた状態で維持され、これは、最初のものが、ガーベージ・コレクトするのを防ぎます。

IEventAggregator

EventAggregatorクラスは、コンテナのサービスとして提供されます。そして、IEventAggregatorインターフェイスによって取得することができます。 イベント・アグリゲータは、配置、あるいは、構築イベントのための、そして、システム内で、イベントのコレクションを維持することのための役割を果たします。

public interface IEventAggregator
{
    TEventType GetEvent() where TEventType : EventBase;
}

EventAggregatorは、それが、すでに構築されていない場合、その最初のアクセスでイベントを構築します。 これは、イベントが利用できるかどうかに関係なく、判断する必要から発行者や購読者を軽減します。

PubSubEvent

発行者と購読者を結合する実際の作業は、PubSubEventクラスによって実行されます。これは、Prism Libraryに含まれている、EventBaseクラスの唯一の実装です。このクラスは、購読者のリストを維持し、そして、購読者へのイベントの発送を処理します。

PubSubEventクラスは、ジェネリック・クラスです。それは、ジェネリック型として定義されているペイロード型を必要とします。これは、強制するのに役立ちます。コンパイル時に、その発行者と購読者は、うまくいくイベント接続のための正しいメソッドを提供します。次に示すコードは、PubSubEventクラスの部分的な定義を示しています。

備考 PubSubEventは、Prism.Core Nugetパッケージに配置される、Prism.Events名前空間で見つかります。

// PubSubEvent.cs
public class PubSubEvent<TPayload> : EventBase
{
    ...
    public SubscriptionToken Subscribe(Action<TPayload> action);
    public SubscriptionToken Subscribe(Action<TPayload> action, ThreadOption threadOption);
    public SubscriptionToken Subscribe(Action<TPayload> action, bool keepSubscriberReferenceAlive)
    public SubscriptionToken Subscribe(Action<TPayload> action, ThreadOption threadOption, bool keepSubscriberReferenceAlive)

    public virtual SubscriptionToken Subscribe(Action<TPayload> action, ThreadOption threadOption, bool keepSubscriberReferenceAlive);
    public virtual SubscriptionToken Subscribe(Action<TPayload> action, ThreadOption threadOption, bool keepSubscriberReferenceAlive, Predicate<TPayload> filter);
    public virtual void Publish(TPayload payload);
    public virtual void Unsubscribe(Action<TPayload> subscriber);
    public virtual bool Contains(Action<TPayload> subscriber)
    ...
}

Creating and Publishing Events

次のセクションでは、IEventAggregatorインターフェイスを使用して、PubSubEventを作成し、公開し、そして、購読する方法を説明します。

イベントを作成する

public class TickerSymbolSelectedEvent : PubSubEvent<string>{}

イベントを公開する

this.eventAggregator.GetEvent<TickerSymbolSelectedEvent>().Publish("STOCK0");

Subscribing to Events

購読者は、PubSubEventクラス上にオーバーロードした利用できるSubscribeメソッドの１つを使用しているイベントに参加することができます。PubSubEventsを購読するための、いくつかの方法があります。どのオプションが、あなたの必要に最も適切か判断するのを助けるために、次の基準を使用します。：

• あなたが、イベントを受け取るとき、UI要素を更新できる必要がある場合、UIスレッドで、イベントを受けるために購読します。
• あなたが、イベントをフィルタリングする必要がある場合、購読するとき、フィルタ・デリゲートを提供します。
• PubSubEventの購読を購読する、そして、その次に、手動で、中止するとき、あなたが、イベントの処理能力に懸念がある場合、強く参照されたデリゲートを使用することについて考えてみてください。
• 前述のいずれも適用しない場合、既定の購読を使用します。

次のセクションでは、これらのオプションを説明します。

UIスレッド上で購読する

購読フィルタリング

強い参照を使用して、購読する

FundAddedEvent fundAddedEvent = eventAggregator.GetEvent<FundAddedEvent>();

bool keepSubscriberReferenceAlive = true;

fundAddedEvent.Subscribe(FundAddedEventHandler, ThreadOption.UIThread, keepSubscriberReferenceAlive, fundOrder => fundOrder.CustomerId == _customerId);

既定の購読

public TrendLineViewModel(IMarketHistoryService marketHistoryService, IEventAggregator eventAggregator)
{
    ... eventAggregator.GetEvent<TickerSymbolSelectedEvent>().Subscribe(this.TickerSymbolChanged);
}

public void TickerSymbolChanged(string newTickerSymbol)
{
    MarketHistoryCollection newHistoryCollection = this.marketHistoryService.GetPriceHistory(newTickerSymbol);

    this.TickerSymbol = newTickerSymbol;
    this.HistoryCollection = newHistoryCollection;
}

イベントから購読を中止する

FundAddedEvent fundAddedEvent = this.eventAggregator.GetEvent<FundAddedEvent>();

fundAddedEvent.Subscribe(FundAddedEventHandler, ThreadOption.PublisherThread);

fundAddedEvent.Unsubscribe(FundAddedEventHandler);

FundAddedEvent fundAddedEvent = this.eventAggregator.GetEvent<FundAddedEvent>();

subscriptionToken = fundAddedEvent.Subscribe(FundAddedEventHandler, ThreadOption.UIThread, false, fundOrder => fundOrder.CustomerId == this.customerId);

fundAddedEvent.Unsubscribe(subscriptionToken);

More_Information

弱い参照の詳細については、MSDNの弱い参照を参照してください。