Prism Library 5.0 for WPFを拡張する

Exposing Functionality

ライブラリは、その機能を公開するために、public APIを与える必要があります。APIのインターフェイスは、内部実装から独立している必要があります。開発者は、その既定の機能を効果的に使用するために、ライブラリの設計や実装を理解することを、求められていません。可能な限り、APIは、固有の機能のための共通のシナリオを適用する必要があります。

Extending Libraries

Prismライブラリは、開発者は、それらのニーズに合わせて、ライブラリを調整するために、使用することができる、拡張ポイントを提供します。例えば、Prism Libraryを使用すると、あなたは、与えられたログの記録サービスを、あなた独自のログの記録サービスに置き換えることができます。

あなたは、そのソース・コードを変更することなく、ライブラリを拡張できます。これを達成するために、あなたは、public基底クラスやインターフェイスのような、拡張ポイントを使用する必要があります。開発者は、基底クラスを拡張することができる、あるいは、インターフェイスを実装することができ、そして、ライブラリに、それらの拡張を追加します。拡張ポイントの設定を定義するとき、ユーザビリティ上で効果を考慮します。拡張ポイントの多くは、使用するために、そして、設定することが難しい、複雑なライブラリを作成することができます。

一部の開発者は、拡張ポイントを使用して、ソース・コードを変更することを示す、コードをカスタマイズすることに、興味を持っている可能性があります。この努力に対応するために、ライブラリ・デザインは、次のことを提供する必要があります。：

• 実際的な場合はいつでも、オブジェクト指向デザインの原則に従う必要があります。
• 実際的な場合はいつでも、オブジェクト指向デザインの原則に従う必要があります。
• それは、リソースを効率的に使用する必要があります。
• それは、セキュリティの原則を厳守する必要があります。(たとえば、ユーザー入力を疑う、そして、最小特権の原則）。

Container and Bootstrapper

Prism Libraryは、直接、依存関係注入コンテナとして、Unityアプリケーション・ブロック（Unity）と拡張管理フレームワーク(MEF)をサポートしています。;しかしながら、コンテナが、IServiceLocatorインターフェイスによって呼び出されるため、コンテナは、置き換えることができます。

各々のPrismアプリケーションは、ブートストラッパー・クラスによってPrism Libraryを設定します。ブートストラップ工程の各段階は、工程そのものと同様に、交換可能です。ブートストラッパーは、デフォルトの実装をカスタム実装で、あるいは、追加のデータ型とサービスを登録する、交換をするために、重要な拡張ポイントを提供します。

Logging

Prism Libraryは、直接、依存関係注入コンテナとして、Unityアプリケーション・ブロック（Unity）と拡張管理フレームワーク(MEF)をサポートしています。;しかしながら、コンテナが、IServiceLocatorインターフェイスによって呼び出されるため、コンテナは、置き換えることができます。

各々のPrismアプリケーションは、ブートストラッパー・クラスによってPrism Libraryを設定します。ブートストラップ工程の各段階は、工程そのものと同様に、交換可能です。ブートストラッパーは、デフォルトの実装をカスタム実装で、あるいは、追加のデータ型とサービスを登録する、交換をするために、重要な拡張ポイントを提供します。

Modules

Prism Libraryは、モジュール・カタログを埋め込むさまざまな方法とロードモジュールを提供します。;しかしながら、あなたのシナリオは、ライブラリを与えない必要があるかもしれません。

モジュールの読み込みは、カスタマイズすることができる、次の3つの段階が含まれています。：

• モジュール発見。

  Module discovery.

  これは、モジュール・カタログを埋め込む工程です。頻繁に、これは、直接、あるいは、ディレクトリを掃引して行われますが、あなたのアプリケーションは、これを、データベースのような、他の方法で行う必要があるかもしれません。これらの場合では、あなたは、適切なソースからそれ自体を埋め込む、カスタム・カタログを作成することができます。

• モジュールの検索と読み込み。

  Module retrieval and loading.

  これは、ローカルに、モジュール・バイナリを取得する工程です。そして、現在のアプリケーション・ドメインに、モジュールを読み込みます。ライブラリは、FileModuleTypeLoaderを提供しますが、あなた独自の探索戦略を実装することもできます。

• モジュールの初期化。

  Module initialization.

  これは、モジュールを初期化する処理です。ライブラリでは、これは、ModuleInitializerによって行われますが、ModuleInitialzerを実装する、新しいオブジェクトを提供することで、置き換えることができます。

Region

領域ナビゲーション。

領域ナビゲーション。

Container and Bootstrapper

Prism Libraryには、Bootstrapper基底クラスが含まれています。UnityとMEFコンポーネントは、それぞれ、UnityBootstrapperとMefBootstrapperとして、このクラスから派生します。Bootstrapper基底クラスは、工程の正確な順序付けを、派生クラスに残す、抽象的なRunメソッドを定義します。ほとんどすべてのメソッドは、カスタマイズ、そして、ブートストラップ工程を拡張するために、それぞれのメソッドを上書できる、仮想であるように、マークされます。

ほとんどの型のインスタンス化のために、ブートストラッパーは、依存関係注入コンテナを使用するでしょう。しかしながら、コンテナを使用することができない、ブートストラップ工程のいくつかの部分があります。：

• ロガーを作成する

  Creating the logger.

  通常、ブートストラッパーは、コンテナを作成することに関する情報を記録する必要があるため、ロガーは、まず、（コンテナの前に）作成されます。ログの記録の実装を変更することの詳細については、「ログの記録」の項目を参照してください。

• カタログを作成して、設定する

  Creating and configuring catalogs.

  カタログ（たとえば、ModuleCatalogとAggregateCatalog）は、コンテナ構築の間、使用されるため、コンテナの前に、作成されます。

• シェルを作成する

  Creating the shell.

  ブートストラップ・シーケンスを実行する前に、シェルがすでに存在するかもしれないため、CreateShellメソッドは、実装するアプリケーション開発者のため、抽象として、残っています。アプリケーション開発者は、コンテナが作成され、そして、初期化されたため、シェルをインスタンス化、あるいは、配置するために、コンテナを使用することができます。

Replacing Default Prism Library Types

あなたが、アプリケーションのために、Prism Library型の基盤となる実装を変更、あるいは、拡張する必要があるとき、時間があるかもしれません。Prism Libraryが、依存関係注入に依存するため、あなたは、ブートストラップ・シーケンスの間、型を置き換えることができます。そして、あなたのアプリケーションとPrism Libraryは、新しい型を使用するでしょう。

既定のデータ型をUnityを使用して、置き換える

// when using Unity
public class ReplacementEventAggregator : IEventAggregator
{
    // ...
}

// when using Unity
protected override void ConfigureContainer()
{
    this.RegisterTypeIfMissing(typeof(IEventAggregator), typeof(ReplacementEventAggregator), true);
    base.ConfigureContainer();
}

既定の型をMEFを使用して、置き換える

// when using MEF
[Export(typeof(IEventAggregator))]
[PartCreationPolicy(CreationPolicy.Shared)]
public class ReplacementEventAggregator : IEventAggregator
{
    // ...
}

MEFコンテナに、非MEF属性型を登録する

[Export(typeof(IRegionManager))]
public class MefRegionManager : RegionManager
{
}

Creating a Minimal Bootstrapper

一部のアプリケーションでは、Prism Libraryの機能の多くを使用していません。場合によっては、アプリケーション開発者は、絶対最小のサービス水準を望むかもしれません。－依存関係の注入とサービスの位置だけ。これを実行するには、次に示すブートストラッパーと実装で、ConfigureContainerメソッドを上書きします。

基底クラスの実装は、故意に、base.ConfigureContainer()を呼び出しません。;

// when using UnityBootstrapper
// UnityBootstrapperを使用するとき、
protected override void ConfigureContainer()
{
    // Base class implementation deliberately not called
    // base.ConfigureContainer();
    // 基底クラスの実装は、故意に、base.ConfigureContainer()を呼び出しません。;
    this.Container.AddNewExtension<UnityBootstrapperExtension>();
    Container.RegisterInstance<ILoggerFacade>(Logger);
    this.Container.RegisterInstance(this.ModuleCatalog);
    RegisterTypeIfMissing(typeof(IServiceLocator), typeof(UnityServiceLocatorAdapter), true);
}

protected override RegionAdapterMappings ConfigureRegionAdapterMappings()
{
    return null;
}

protected override IRegionBehaviorFactory ConfigureDefaultRegionBehaviors()
{
    return null;
}

備考: インターフェイスの実装が、要求されるとき、Unityが、返すために、適切で、具体的な型を決定できないため、領域アダプタとマッピングのオーバーライドは、必要とされます。これらは、それぞれのインターフェイスを返すために、具体的な型の関連付けを呼び出します。必要とされる具体的な型が、要求されるとき、Unityは、型をインスタンス化することによって、直接、それらを解決することができます。

// when using MEFBootstrapper
protected override void ConfigureContainer()
{
    // Base class implementation deliberately not called
    // base.ConfigureContainer();
    // 基底クラスの実装は、故意に、base.ConfigureContainer()を呼び出しません。;

    this.Container.ComposeExportedValue<ILoggerFacade>(this.Logger);
    this.Container.ComposeExportedValue<IServiceLocator>(new MefServiceLocatorAdapter(this.Container));
    this.Container.ComposeExportedValue<AggregateCatalog>(this.AggregateCatalog);
}

Changing Dependency Injection Containers

あなたが、あなたのアプリケーションで、UnityやMEF以外のコンテナ付きのPrismを使用する場合、あなたが、行う必要がある、いくつかのことがあります。まず、あなたは、あなたのコンテナのためのサービス・ロケーター・アダプタを記述することを必要とします。あなたは、どのように、行うことができるかの例として、MefServiceLocatorAdapterとUnityServiceLocatorAdapterを使用することができます。また、あなたは、コンテナ固有のブートストラッパー・クラスを記述する必要があります。次に、あなたは、Bootstrapperクラスから派生する、新しいコンテナ固有のブートストラッパーを作成する必要があります。そして、例として、MefBootstrapperとUnityBootstrapperの利用して、必要なメソッドを実装します。

Adding Features to the Module Catalog

Prismライブラリは、両方のクラスとして、ModuleCatalogを提供します。あなたは、AddModuleメソッドを通して、直接、埋め込むことができます。あるいは、あなたは、Itemsプロパティを埋め込むために、addメソッドから、派生することができます。

Prism LibraryのModuleCatalogクラスは、IModuleインターフェイスを越えた追加機能の多くを提供します。AddModuleメソッド、モジュール・グループの依存関係の検証と並べ替えの多くの異なるオーバーロードがあリます。ModuleCatalogの機能を拡張する、いくつかの方法があります。：

ModuleCatalogから派生します。あなたが、ModuleCatalogの挙動を変更する必要がある場合、新しいクラスを派生し、そして、仮想メソッドを上書きします。

IModuleCatalog上で、拡張メソッドを記述します。あなたが、IModuleCatalogを使用するアプリケーションにおいて、追加の機能を必要とする場合、インターフェイス上で、拡張メソッドを記述します。

ModuleCatalog上で、拡張メソッドを記述します。あなたが、追加の機能を必要とする場合、しかし、あなたが、ModuleCatalogを使用する場所だけで、具体的な型の上で、拡張メソッドを記述します。

Discovering Modules from a Custom Source

Prism Libraryは、アプリケーション設定から、そして、XAMLファイルから、モジュール・カタログを埋め込むことをサポートしています。あなたは、Webサービス、データベース、他の外部ファイルような、他のデータ・ソースからの読み込みをサポートするために、あなたのアプリケーション内で、Prismを拡張できます。

以下は、カタログを埋め込むための、いくつかの方法を説明します。

• 静的CreateFromXamlメソッドを使用します。あなたのデータが、すでに、Modularity:ModuleCatalog XAMLスキーマである場合、あるいは、それが、簡単に変換することができる場合、あなたは、直接、ModuleCatalogを埋め込む、このメソッドを使用することができます。
• ConfigurationModuleCatalog内の、IConfigurationStoreを置き換えます。あなたが、WPFデスクトップ・アプリケーションを実行する場合、あなたは、ConfigurationModuleCatalogのためのモジュール項目を返すために、IConfigurationStoreを実装することができます。
• ModuleCatalogから派生します。また、あなたは、ModuleCatalogから派生するために、あなたのデータを取得する、ConfigurationModuleCatalogの例に従うことができます。そして、その次に、カタログを埋め込むために、AddModuleメソッドを呼び出します。

次のコード例は、ディスクから、カスタム設定モジュール・ファイルを、どのように、読み込むかを示しています。

// Bootstrapper
protected override Microsoft.Practices.Prism.Modularity.IModuleCatalog CreateModuleCatalog()
{
    ConfigurationModuleCatalog catalog = new ConfigurationModuleCatalog();
    catalog.Store = new MyModuleCatalogStore();
    return catalog;
}

// MyModuleCatalogStore
public class MyModuleCatalogStore : IConfigurationStore
{

    public ModulesConfigurationSection RetrieveModuleConfigurationSection()
    {
        ExeConfigurationFileMap fileMap = new ExeConfigurationFileMap()
        {
            ExeConfigFilename = "MyModuleCatalog.config"
        };
        Configuration configuration = ConfigurationManager.OpenMappedExeConfiguration(fileMap, ConfigurationUserLevel.None);
        return configuration.GetSection("modules") as ModulesConfigurationSection;
    }
}

Retrieving and Loading Modules from a Custom Assembly Source

あなたのアプリケーションが、実装、あるいは、アセンブリ以外の配布の仕組みを持っている場合、あなたは、型をダウンロードあるは呼び出すために、あなた独自のIModuleTypeLoaderを実装することができます。

Prism 4.1ライブラリのMefXapModuleTypeLoaderクラスは、この例です。それは、XAPファイルをダウンロードする、アセンブリを配置する、そして、それらとMEFカタログを登録するために、MEF DeploymentCatalogを使用します。

各々のIModuleTypeLoaderは、モジュールを取得するために使用する、適切な型のローダーを決定するためにModuleManagerを提供する、CanLoadModuleTypeメソッドを実装しています。次のコード例は、MefXapModuleTypeLoader実装**を示しています。**

// MefXapModuleTypeLoader.cs
public bool CanLoadModuleType(ModuleInfo moduleInfo)
{
    if (moduleInfo == null)
    {
        throw new ArgumentNullException("moduleInfo");
    }

    if (!string.IsNullOrEmpty(moduleInfo.Ref))
    {
        Uri uriRef;
        return Uri.TryCreate(moduleInfo.Ref, UriKind.RelativeOrAbsolute, out uriRef);
    }

    return false;
}

あなたが、モジュール・データ型ローダーを持ったあと、あなたは、それが、型ローダーのModuleManagerのコレクションであることを確実にする必要があります。次のコード例は、Prism.MefExtensions.Silverlightプロジェクトからです。

// MefModuleManager.Silverlight.cs
public override IEnumerable<IModuleTypeLoader> ModuleTypeLoaders
{
    get
    {
        if (this.mefTypeLoaders == null)
        {
            this.mefTypeLoaders = new List<IModuleTypeLoader>()
                { this.MefXapModuleTypeLoader }
        }
        return this.mefTypeLoaders;
    }
    set
    {
        this.mefTypeLoaders = value;
    }
}

Region Adapters

領域アダプタは、ホスト・コントロールと相互作用する領域で、項目を、どのように、配置するかを制御します。 次のセクションでは、カスタム領域アダプタとアダプタの登録を制御することを作成することで、このビヘイビアを、どのように、拡張するかを説明します。

ユーザー定義した領域アダプタを作成する

public interface IRegionAdapter
{
    IRegion Initialize(object regionTarget, string regionName);
}

public class ContentControlRegionAdapter : RegionAdapterBase<ContentControl>
{
    public ContentControlRegionAdapter(IRegionBehaviorFactory regionBehaviorFactory)
        : base(regionBehaviorFactory)
    {
    }

    protected override void Adapt(IRegion region, ContentControl regionTarget)
    {
        if (regionTarget == null) throw new ArgumentNullException("regionTarget");
        bool contentIsSet = regionTarget.Content != null;
        contentIsSet = contentIsSet || (BindingOperations.GetBinding(regionTarget, ContentControl.ContentProperty) != null);

        if (contentIsSet)
        {
            throw new InvalidOperationException(Resources.ContentControlHasContentException);
        }

        region.ActiveViews.CollectionChanged += delegate
        {
            regionTarget.Content = region.ActiveViews.FirstOrDefault();
        };

        region.Views.CollectionChanged +=
            (sender, e) =>
            {
                if (e.Action == NotifyCollectionChangedAction.Add && region.ActiveViews.Count() == 0)
                {
                    region.Activate(e.NewItems\[0\]);
                }
            };
    }

    protected override IRegion CreateRegion()
    {
            return new SingleActiveRegion();
    }
}

領域アダプタ・マッピングをカスタマイズする

// Bootstrapper.cs
protected virtual RegionAdapterMappings ConfigureRegionAdapterMappings()
{
    RegionAdapterMappings regionAdapterMappings = ServiceLocator.Current.GetInstance<RegionAdapterMappings>();
    if (regionAdapterMappings != null)
    {
        regionAdapterMappings.RegisterMapping(typeof(Selector), ServiceLocator.Current.GetInstance<SelectorRegionAdapter>());
        regionAdapterMappings.RegisterMapping(typeof(ItemsControl), ServiceLocator.Current.GetInstance<ItemsControlRegionAdapter>());
        regionAdapterMappings.RegisterMapping(typeof(ContentControl), ServiceLocator.Current.GetInstance<ContentControlRegionAdapter>());
    }
    return regionAdapterMappings;
}

Region Behaviors

領域ビヘイビアは、領域のための機能のほとんどを与えるPrism Libraryで使用されています。ブートストラップ工程の間、ブートストラッパーは、既定で、各々の領域に添付される領域ビヘイビアを登録します。さらに、アダプタは、領域が、特定のコントロール型だけで、関連付けられるとき、ビヘイビアを追加するかもしれません。

すべての領域のための領域ビヘイビアを追加する

protected override IRegionBehaviorFactory ConfigureDefaultRegionBehaviors()
{
    IRegionBehaviorFactory factory = base.ConfigureDefaultRegionBehaviors();
    factory.AddIfMissing("MyBehavior", typeof(MyCustomBehavior));
}

一つの領域のための領域ビヘイビアを追加する

IRegion region = regionManager.Region\["Region1"\];
region.Behaviors.Add("MyBehavior", new MyRegion());

Replacing an Existing Region Behavior

あなたが、既定のビヘイビアを、異なるビヘイビアに置き換えたい場合、あなたは、あなたのアプリケーション固有のブートストラッパーで、ConfigureDefaultRegionBehaviorsメソッドを上書きすることで、それを追加することができます。そして、あなたのビヘイビアを、既定のビヘイビアとして、同じキー値と一緒に登録します。Prism Libraryは、そのキーと一緒にビヘイビアが、すでに追加されていない場合のみ、既定の領域ビヘイビアを追加します。

時折、あなたは、個々のView上に、領域ビヘイビアを、領域に追加、あるいは、置き換えたいかもしれません。それらの領域が、XAML内で定義される場合、ほとんどの領域のように、領域は、あなたのカスタム・ビヘイビアを添付するために、最初に、利用できないかもしれません。領域が、利用できるようになるとき、あなたは、領域の有効性を監視し、そして、あなたのビヘイビアを添付する必要があります。次のコード例は、領域が、利用できるようになるとき、AutoPopulateBehaviorを、あなたのカスタム・バージョンに、どのように、置き換えるかを示します。

public class MyView : UserControl
{
    public MyView()
    {
        InitializeComponent();

        ObservableObject<IRegion> observableRegion = RegionManager.GetObservableRegion(this.MyRegionHostControl);

        observableRegion.PropertyChanged += (sender, args) =>
        {
            IRegion region = ((ObservableObject<IRegion>)sender).Value;
            region.Behaviors.Add(AutoPopulateBehavior.BehaviorKey,
                new CustomAutoPopulateBehavior());
        };
    }
}

領域ビヘイビアを削除する

Viewが、どのように、発見されるかを変更する

Region Navigation

次のセクションでは、Prism Libraryの領域ナビゲーション機能を、どのように、拡張するかを説明します。

Changing Your Logical Navigation Structure

Prism Libraryの領域ナビゲーション機能は、ナビゲーション統一リソース識別子 (URI)として、各々のviewの型名を使用します。あなたのアプリケーションは、View型名から独立した、URIナビゲーション・スキームを公開したいかもしれません。

WPFアプリケーションは、同じ結果を得るために、IRegionNavigationContentLoader実装を置き換えることができます。また、多標的アプリケーションは、この方法を使用する、アプリケーションのためのURI構造が定義される一つの場所を維持することを望むかもしれません。

論理的ナビゲーション構造を変更するには、RegionNavigationContentLoaderから新しいクラスを派生し、GetContractFromNavigationContextメソッドを上書きします。メソッド内で、読み込むView型名を、入力契約名に変換します。都合良く、検査する契約文字列にURIを解析するため、基底クラスを呼び出すために、推奨されます。次のコード例は、Home」をHomeビューに、そして、「About」をAboutビューにマッピングするカスタム領域のコンテンツ・ローダーを示します。

備考: この例では、エクスポート属性は、MEFコンテナで利用できるように、クラスの一番上に、適用して、MEFを使用します。

[Export(typeof(IRegionNavigationContentLoader))]
[PartCreationPolicy(CreationPolicy.Shared)]
public class CustomRegionNavigationContentLoader : RegionNavigationContentLoader
{
    [ImportingConstructor]
    public CustomRegionNavigationContentLoader(IServiceLocator serviceLocator)
        : base(serviceLocator)
    {
    }

    protected override string GetContractFromNavigationContext(NavigationContext navigationContext)
    {

        string contract = base.GetContractFromNavigationContext(navigationContext);
    
        if (contract.Equals("Home", StringComparison.OrdinalIgnoreCase))
        {
            return typeof(HomeView).Name;
        }

        if (contract.Equals("About", StringComparison.OrdinalIgnoreCase))
        {
            return typeof(AboutView).Name;
        }
    
        return contract;
    }
}

あなたが、カスタム・ナビゲーション・コンテンツ・ローダーを持ったあと、それを、コンテナ内のIRegionNavigationContentLoaderの実装として、置き換えます。コンテナ内で、置き換える型の詳細については、このトピックの初めの、コンテナとBootstrapperの項目を参照してください。

Advanced Navigation Replacements

次のセクションでは、Prism Libraryで、提供される領域ナビゲーション基盤構造の主要な部分を置き換えることを説明します。ほとんどの開発者は、カスタマイズのこのレベルを必要とするシナリオを持っていません。

RegionNavigationContentLoader

IRegionNavigationJournal/IRegionNavigationJournalEntry

IRegionNavigationService

Changing the View Model Locator Conventions

ViewModelLocationProviderは、ViewModelに、Viewを関連付けるための、あなた独自の規則を提供するために、使用できるSetDefaultViewTypeToViewModelTypeResolverと呼び出される静的メソッドを提供します。

ViewModelLocationProvider.SetDefaultViewTypeToViewModelTypeResolver((viewType) =>
{
    ...
    return viewModelType;
});

既定では、View名前空間に配置される場合、Viewは、ViewModelに名前空間を更新する、そして、Viewの名前に「ViewModel」接尾辞を添付するでしょう。Prismは、同じアセンブリで、このViewModelを探すでしょう。

Configuring the ViewModelLocationProvider to Use a Container

次の例は、コンテナを使用して、ViewModelを構築するために、ViewModelLocationProviderを、どのように、設定するかを示します。

あなたのアプリケーションを起動する時、VieModel型を解決するためのあなたのコンテナを使用するために、SetDefaultViewModelFactoryメソッドを使用します。以下は、MicrosoftのUnity依存関係注入コンテナを使用する例です。

IUnityContainer _container = new UnityContainer();
...
ViewModelLocationProvider.SetDefaultViewModelFactory((t) => _container.Resolve(t));

あなたが、ViewModel内に、既定のコンストラクタを持っている、そして、注入される依存関係がない場合、ViewModelを作成するための既定の戦略は、有効なアプローチのActivator.CreateInstanceメソッドを使用することです。