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

Creating an Event

PubSubEventは、アプリケーションの、あるいは、モジュールの特定のイベントのための基底クラスであることを意図としています。 TPayLoadは、イベントのペイロード型です。ペイロードは、引数です。それは、イベントが、公開されているとき、購読者に渡されるでしょう。

例えば、次のコードは、株トレーダーのリファレンス実装（株トレーダーRI）に、TickerSymbolSelectedEventを表示します。 ペイロードは、会社記号が含まれている文字列です。このクラスが空のための実装をどのように行うかに注意します。

C#

public class TickerSymbolSelectedEvent : PubSubEvent<string>{}

備考

複合アプリケーションでは、イベントは、複数のモジュール間で、頻繁に共有されます。それで、それらは、共通の場所で、定義されます。 株トレーダーRIでは、これは、StockTraderRI.Infrastructureプロジェクトの中で実行します。

Publishing an Event

発行者は、EventAggregatorからイベントを取得し、そして、Publishメソッドを呼び出すことで、イベントを発生させます。 EventAggregatorにアクセスするために、あなたは、クラスのコンストラクタへ、IEventAggregator型のパラメータを追加することで、依存関係の注入を使用することができます。

次のコードは、TickerSymbolSelectedEventの発行を説明します。

C#

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

Subscribing on the UI Thread

頻繁に、購読者は、イベントに応じて、UI要素を更新する必要があるでしょう。WPFでは、UIスレッドだけは、UI要素を更新することができます。

既定では、購読者は、発行者のスレッド上で、イベントを受け取ります。 発行者が、UIスレッドからイベントを送信する場合、購読者は、UIを更新することができます。 しかしながら、発行者のスレッドが、バックグラウンド・スレッドである場合、購読者は、直接、UI要素を更新できない場合があります。 この場合、購読者は、UIスレッドで、Dispatcherクラスを使用して、更新を予定に入れる必要があります。

Prism Libraryで提供されるPubSubEventは、 購読者が、UIスレッド上で自動的にイベントを受け取ることを提供することによって、支援することができます。 次のコードの例に示すように、購読者は、これを購読の間、示します。

C#

public void Run()
{
   ...
   this.eventAggregator.GetEvent<TickerSymbolSelectedEvent>().Subscribe(ShowNews, ThreadOption.UIThread);
);
}

public void ShowNews(string companySymbol)
{
   this.articlePresentationModel.SetTickerSymbol(companySymbol);
}

次のオプションは、ThreadOptionのために利用できます。：

• PublisherThread。発行者のスレッド上で、イベントを受けるために、この設定を使用します。これは、既定の設定です。
• BackgroundThread。.NET Frameworkスレッド-プール・スレッド上で、非同期で、イベントを受信するために、この設定を使用します。
• UIThread。UIスレッド上で、イベントを受けるために、この設定を使用します。

備考

UIスレッド上で、PubSubEventsを、購読者に公開するため、EventAggregatorは、最初に、UIスレッド上で、構築される必要があります。

Subscription Filtering

購読者は、公開されたイベントのすべてのインスタンスを取り扱う必要はないかもしれません。 これらの場合では、購読者は、フィルタ・パラメータを使用することができます。フィルタ・パラメータは、 イベントが、公開されたイベントのペイロードが、必要となる基準のセットと一致する場合、呼び出された購読者コールバックを持つために、 判断するために発行されるとき、type System.Predicateで、実行されるデリゲートです。 ペイロードが、指定された基準を満たさない場合、購読者コールバックは、実行されません。

頻繁に、このフィルタは、次のコードの例に示すように、ラムダ式として指定されます。

C#

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

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

備考

Subscribeメソッドは、type Microsoft.Practices.Prism.Events.SubscriptionTokenの購読トークンを返します。 それは、後で、イベントの購読を削除するために使用することができます。コールバック・デリゲートとして、 あなたが、匿名型デリゲート、あるいは、ラムダ式を使用するとき、 あるいは、あなたが、異なるフィルタで、同じイベント・ハンドラを購読するとき、このトークンは、特に役に立ちます。

これは、コールバック・デリゲート内から、ペイロード・オブジェクトを変更することは、推奨されません。 なぜなら、いくつかのスレッドは、同時に、ペイロード・オブジェクトを呼び出すことができます。 あなたは、同時実行エラーを避けるために、ペイロードを不変にすることができます。

Subscribing Using Strong References

あなたが、短い期間に、複数のイベントを呼び出し、そして、それらの処理能力の懸念に注意する場合、 あなたは、強いデリゲート参照で、購読する必要があるかもしれません。 あなたが、それを行う場合、購読者を取り除くとき、あなたは、続いて、イベントから、手動で、購読を中止する必要があります。

既定では、PubSubEventは、購読の購読者のハンドラとフィルタに、弱いデリゲート参照を保持します。 これは、PubSubEventが保持する参照が、購読者のガーベージ・コレクションを妨げないことを、示しています。 弱いデリゲート参照を使用することは、購読者を、購読を中止する必要性を軽減します。そして、適切なガーベージ・コレクションを提供します。

しかしながら、この弱いデリゲート参照を保持することは、対応する強い参照に比べて、より遅くなります。 ほとんどアプリケーションでは、この処理能力は、顕著ではありませんが、あなたのアプリケーションが、短い期間に 、多数のイベントを発行する場合、あなたは、PubSubEventで、強い参照を使用する必要があるかもしれません。 あなたが、強いデリゲート参照を使用する場合、あなたの購読者は、それが、もはや使用されないとき、 あなたの購読しているオブジェクトの適切なガーベージ・コレクションを有効にするために、購読を中止する必要があります。

強い参照で購読するには、次のコードの例に示すように、Subscribeメソッドで、keepSubscriberReferenceAliveパラメータを使用します。

C#

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

bool keepSubscriberReferenceAlive = true;

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

keepSubscriberReferenceAliveパラメータは、type boolです。：

• trueに設定されると、イベント・インスタンスは、購読者インスタンスに強い参照を保有します。 それにより、それが、ガベージコレクションを取得することができません。 どのように、購読を中止するかについては、このトピックの後の、イベントから購読を中止するの項目を参照してください。
• falseに設定されたとき、（このパラメータを省略したときの既定の値）、イベントは、購読者インスタンスに、弱い参照を保持します。 それによって、それへの他の参照がないとき、購読者インスタンスが、収集されたとき、 ガーベジコレクタが、購読者インスタンスを取り除くことができ、イベントは、自動的に、購読を中止します。

Default Subscriptions

最少限、あるいは、既定の購読のため、購読者は、イベント通知を受け取る適切な署名で、コールバック・メソッドを提供する必要があります。 例えば、次のコードの例に示すように、TickerSymbolSelectedEventのためのハンドラは、文字列パラメータを取得するメソッドを必要とします。

Unsubscribing from an Event

あなたの購読者が、イベントを受けることをもはや望まない場合、あなたの購読者のハンドラを使用して、 あなたは、購読を中止することができます。あるいは、あなたは、購読トークンを使用することで、購読を中止することができます。

次のコード例は、どのように、ハンドラに、直接、購読を中止するかを示します。

C#

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

fundAddedEvent.Subscribe(FundAddedEventHandler, ThreadOption.PublisherThread);

fundAddedEvent.Unsubscribe(FundAddedEventHandler);

次のコード例は、購読トークンで、どのように、購読を中止するかを示します。トークンは、Subscribeメソッドからの戻り値として、指定されます。

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

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

fundAddedEvent.Unsubscribe(subscriptionToken);