WPF + Caliburn.Micro + Castle.Windsorモジュラーアプリケーション

まず、この記事でモジュラーアプリケーションが何を意味するのかを判断します。 したがって、いわゆるアプリケーションで構成されるアプリケーションなどのモジュール式アプリケーションを検討します。 シェルとプラグインのセット。 それらの間には直接的な関係はなく、契約を通じてのみです。 これにより、各コンポーネントを個別に変更したり、構成を変更したりできます。 私がいない人は皆、モジュール式アーキテクチャの利点を知っていると思います。







おそらく、このアーキテクチャでWPFアプリケーションを作成するための最も有名なフレームワークはPrismです。 この記事では、比較分析を行いません。 Prismの使用経験はありません。 チュートリアルを読んだ後、すべてのリージョン、mef、およびその他のアーティファクトを含むPrismは、非常に複雑に思えました。 Prismを知っている読者が、私が間違っていることと、このフレームワークの利点を合理的に指摘してくれたら、感謝します。



この記事では、これらのツールを使用した単純なモジュール式アプリケーションの開発について説明します。

Caliburn.Micro

Caliburn.Microは、ViewおよびViewModelの記述を大幅に簡素化するフレームワークです。 実際、彼自身が命名規則に基づいてバインダーを作成しているため、開発者は手作業でバインダーを作成する必要がなく、コードをより小さく、よりきれいにすることができます。 ここに彼らのサイトからのいくつかの例があります：

<ListBox x:Name="Products" />
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

 public BindableCollection<ProductViewModel> Products { get; private set; } public ProductViewModel SelectedProduct { get { return _selectedProduct; } set { _selectedProduct = value; NotifyOfPropertyChange(() => SelectedProduct); } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

このXAMLでは、ItemSourceまたはSelectedItemのいずれも指定していません。

 <StackPanel> <TextBox x:Name="Username" /> <PasswordBox x:Name="Password" /> <Button x:Name="Login" Content="Log in" /> </StackPanel>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

 public bool CanLogin(string username, string password) { return !String.IsNullOrEmpty(username) && !String.IsNullOrEmpty(password); } public string Login(string username, string password) { ... }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

コマンドとCommandParameterはありません。



必要に応じて、契約を再定義できます。

もちろん、Caliburn.Microにはもっとやることがあります。 さらに検討します。残りはドキュメントに記載されています。

Castle.windsor

Castle.Windsorは、.netで最も有名で最も機能的なDIコンテナーの1つです（読者はDIおよびIoCを認識していると想定されます）。 はい、Caliburn.Microは、他の多くのフレームワークと同様に、独自のDIコンテナSimpleContainerを備えており、さらなる例としては、その機能で十分です。 しかし、より複雑なタスクの場合は適切ではない可能性があるため、例としてCastle.Windsorを使用して任意のコンテナを使用する方法を示します。

挑戦する

例として、単純なモジュール式アプリケーションを作成するプロセスを検討することを提案します。 その主要部分-シェル-はウィンドウであり、その左側にListBoxメニューがあります。 メニュー項目を選択すると、対応するフォームが右側に表示されます。 メニューは、ロード時または操作中にモジュールで満たされます。 モジュールは、シェルの開始時と操作中の両方でロードできます（たとえば、モジュールは必要に応じて他のモジュールをロードできます）。

契約

すべてのコントラクトは、コントラクトアセンブリに含まれ、シェルとモジュールが参照する必要があります。 タスクに基づいて、シェルのコントラクトを作成します。

 public interface IShell { IList<ShellMenuItem> MenuItems { get; } IModule LoadModule(Assembly assembly); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

  public class ShellMenuItem { public string Caption { get; set; } public object ScreenViewModel { get; set; } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ここではすべてが明確だと思います。 シェルを使用すると、モジュールでメニューを管理したり、プロセスでモジュールをロードしたりできます。 メニュー項目には表示名とViewModelが含まれ、そのタイプは絶対に任意です。 ウィンドウの右側でメニュー項目を選択すると、このViewModelに対応するビューが表示されます。 適切なビューを判断する方法は？ Caliburn.Microがこれを処理します。 このアプローチはViewModel-firstと呼ばれます。コードではビューモデルを操作し、ビューの作成は背景にフェードインし、フレームワークの手に委ねられるためです。 詳細は以下の通りです。



モジュールコントラクトは非常に単純に見えます。

 public interface IModule { void Init(); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

Init（）メソッドは、モジュールのロードを開始したパーティを呼び出します。



アセンブリがプロジェクトで署名され、通常は大規模プロジェクトである場合、シェルとモジュールが同じバージョンのコントラクトを持つアセンブリを使用することを確認する必要があることに注意することが重要です。

シェルを使い始める

タイプWPFアプリケーションのプロジェクトを作成します。 次に、Caliburn.MicroとCastle.WIndsorをプロジェクトに接続する必要があります。 これを行う最も簡単な方法は、NuGetを使用することです。



PM> Install-Package Caliburn.Micro -Version 2.0.2

PM> Install-Package Castle.Windsor









ただし、アセンブリをダウンロードするか、自分で組み立てることができます。 次に、プロジェクトに2つのフォルダー、ViewsとViewModelsを作成します。 ViewModelsフォルダーで、ShellViewModelクラスを作成します。 INotifyPropertyChangedを実装しないように、Caliburn.MicroのPropertyChangedBaseから継承します。 これは、シェルのメインウィンドウのビューモデルになります。

 class ShellViewModel: PropertyChangedBase { public ShellViewModel() { MenuItems = new ObservableCollection<ShellMenuItem>(); } public ObservableCollection<ShellMenuItem> MenuItems { get; private set; } private ShellMenuItem _selectedMenuItem; public ShellMenuItem SelectedMenuItem { get { return _selectedMenuItem; } set { if(_selectedMenuItem==value) return; _selectedMenuItem = value; NotifyOfPropertyChange(() => SelectedMenuItem); NotifyOfPropertyChange(() => CurrentView); } } public object CurrentView { get { return _selectedMenuItem == null ? null : _selectedMenuItem.ScreenViewModel; } } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

メインウィンドウMainWindow自体がビューにコピーされ、ShellViewに名前が変更されます。 ファイルだけでなく、名前空間を持つクラスの名前も忘れないでください。 つまり Shell.MainWindowsクラスの代わりに、Shell.Views.ShellViewが必要です。 これは重要です。 そうしないと、Caliburn.Microは、以前に作成されたモデルと一致するのはこのビューであると判断できません。 前述のように、Caliburn.Microは命名規則に依存しています。 この場合、ビューモデルのクラス名から「モデル」という単語が削除され、対応するビューのクラス名が取得されます（Shell.ViewModels.ShellViewModel-Shell.Views.ShellView）。 Viewの役割は、Windows、UserControl、Pageです。 モジュールでは、UserControlを使用します。

メインウィンドウのXAMlレイアウトは次のようになります。

 <Window x:Class="Shell.Views.ShellView" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" Title="MainWindow" Height="350" Width="525"> <Grid> <Grid.ColumnDefinitions> <ColumnDefinition Width="200"/> <ColumnDefinition Width="*"/> </Grid.ColumnDefinitions> <ListBox x:Name="MenuItems" DisplayMemberPath="Caption" Grid.Column="0"/> <ContentControl x:Name="CurrentView" Grid.Column="1"/> </Grid> </Window>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

Caliburn.Microを起動します

これを行うには、最初に最小限のコンテンツでBootstraperクラスを作成します。

 public class ShellBootstrapper : BootstrapperBase { public ShellBootstrapper() { Initialize(); } protected override void OnStartup(object sender, StartupEventArgs e) { DisplayRootViewFor<ShellViewModel>(); } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

BootstrapperBaseから継承する必要があります。 OnStartupメソッドは、プログラムの起動時に呼び出されます。 DisplayRootViewFor（）は、デフォルトではビューモデルクラスのインスタンスをデフォルトのコンストラクターで作成し、上記のアルゴリズムを使用して対応するビューを検索し、表示します。



これを機能させるには、アプリケーションへのエントリポイント-App.xamlを編集する必要があります。

 <Application x:Class="Shell.App" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:shell="clr-namespace:Shell"> <Application.Resources> <ResourceDictionary> <ResourceDictionary.MergedDictionaries> <ResourceDictionary> <shell:ShellBootstrapper x:Key="bootstrapper" /> </ResourceDictionary> </ResourceDictionary.MergedDictionaries> </ResourceDictionary> </Application.Resources> </Application>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

StartupUri（ブートストラップに割り当てられている）を削除し、ブートストラップをリソースに追加しました。 このようなネストは、そのようなものではありません。そうでなければ、プロジェクトは組み立てられません。



これで、アプリケーションが起動すると、ブートストラップが作成され、OnStartupが呼び出され、ビューモデルに関連付けられたメインアプリケーションウィンドウが表示されます。



ビューモデルの作成に注意してください。 デフォルトのコンストラクターによって作成されます。 そして、もし彼女が持っていなければ？ 彼女が他のエンティティに依存している場合、または他のエンティティが彼女に依存していますか？ Castle.WindsorのDIコンテナを実行する時が来たと思います。

Castle.Windsorを起動する

ShellInstallerクラスを作成します。

 class ShellInstaller : IWindsorInstaller { public void Install(IWindsorContainer container, IConfigurationStore store) { container .Register(Component.For<IWindsorContainer>().Instance(container)) .Register(Component.For<ShellViewModel>() /*.LifeStyle.Singleton*/); } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

その中で、流れるような構文を使用して、すべてのコンポーネントをコードに登録します。 xmlを使用してこれを行うことができます。サイトのドキュメントを参照してください。 これまでのところ、メインウィンドウのビューモデルという1つのコンポーネントがあります。 これをシングルトンとして登録します（これはデフォルトでLifeStyleであるため、明示的に指定することはできません）。 また、コンテナにアクセスできるように、コンテナ自体も登録します。 今後の予定-モジュールをロードするときにこれが必要になります。



次に、ブートストラップに変更を加えます。

 public class ShellBootstrapper : BootstrapperBase { private readonly IWindsorContainer _container = new WindsorContain-er(); public ShellBootstrapper() { Initialize(); } protected override void OnStartup(object sender, StartupEventArgs e) { DisplayRootViewFor<ShellViewModel>(); } protected override void Configure() { _container.Install(new ShellInstaller()); } protected override object GetInstance(Type service, string key) { return string.IsNullOrWhiteSpace(key) ? _container.Kernel.HasComponent(service) ? _container.Resolve(service) : base.GetInstance(service, key) : _container.Kernel.HasComponent(key) ? _container.Resolve(key, service) : base.GetInstance(service, key); } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

コンテナを作成します。 再定義されたConfigureメソッドでは、インストーラーを使用します。 GetInstanceメソッドをオーバーライドします。 基本的な実装では、デフォルトのコンストラクターを使用してオブジェクトを作成します。 コンテナからオブジェクトを取得しようとします。

モジュールとの相互作用

まず、モジュールをロードする方法を学ぶ必要があります。 そして、このために、モジュールとは何かを決めましょうか？



モジュール（この場合）は、必要な機能を実装するクラスのセットを含むアセンブリです。 これらのクラスの1つは、IModuleコントラクトを実装する必要があります。 さらに、シェルと同様に、モジュールには、DIコンテナーにモジュールのコンポーネント（クラス）を登録するインストーラーが必要です。



次に、ブートローダーの実装を開始しましょう。 ダウンロードは、シェルの起動時に呼び出され、プロセス内で呼び出すこともできるため、別のクラスを作成します。

 class ModuleLoader { private readonly IWindsorContainer _mainContainer; public ModuleLoader(IWindsorContainer mainContainer) { _mainContainer = mainContainer; } public IModule LoadModule(Assembly assembly) { try { var moduleInstaller = FromAssembly.Instance(assembly); var modulecontainer = new WindsorContainer(); _mainContainer.AddChildContainer(modulecontainer); modulecontainer.Install(moduleInstaller); var module = modulecontainer.Resolve<IModule>(); if (!AssemblySource.Instance.Contains(assembly)) AssemblySource.Instance.Add(assembly); return module; } catch (Exception ex) { //TODO: good exception handling return null; } } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

シェルコンテナーがデザイナーを通じて表示されます（これのために特別に登録しましたか？）。 LoadModuleメソッドでは、モジュールアセンブリからインストーラーを取得します。 ロード可能なモジュールのコンポーネント用に個別のコンテナを作成します。 シェルコンテナに関連して子として登録します。 インストーラーモジュールを使用します。 IModuleのインスタンスを返そうとしています。 Caliburn.Microにアセンブリを通知し、アセンブリ内のコンポーネントの命名規則を適用します。



また、ShellInstallerにモジュールローダーを登録することを忘れないでください。

 .Register(Component.For<ModuleLoader>()
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

「子コンテナ」について少し。 一番下の行は、そのすべてのコンポーネントが、独自のコンテナに加えて、親コンテナのコンポーネントを「見る」ことですが、その逆はそうではありません。 異なる子コンテナのコンポーネントもお互いについて何も知りません。 私たちはシェルをモジュールから分離し、モジュールを互いに分離しますが、シェルからは分離しません-彼らはそれを見ます。



次に、モジュールがシェルにアクセスするためのIShellコントラクトを実装します。

  class ShellImpl: IShell { private readonly ModuleLoader _loader; private readonly ShellViewModel _shellViewModel; public ShellImpl(ModuleLoader loader, ShellViewModel shellViewModel) { _loader = loader; _shellViewModel = shellViewModel; } public IList<ShellMenuItem> MenuItems { get { return _shellViewModel.MenuItems; } } public IModule LoadModule(Assembly assembly) { return _loader.LoadModule(assembly); } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

登録します。

 .Register(Component.For<IShell>().ImplementedBy<ShellImpl>())
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

次に、シェルの起動時にモジュールをロードする必要があります。 そして、彼らはどこから来るのでしょうか？ この例では、シェルはShell.exeの隣にモジュールを持つアセンブリを探します。



この機能は、OnStartupメソッドで実装する必要があります。

  protected override void OnStartup(object sender, StartupEventArgs e) { var loader = _container.Resolve<ModuleLoader>(); var exeDir = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location); var pattern = "*.dll"; Directory .GetFiles(exeDir, pattern) .Select(Assembly.LoadFrom) .Select(loader.LoadModule) .Where(module => module != null) .ForEach(module => module.Init()); DisplayRootViewFor<ShellViewModel>(); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

すべて、シェルの準備ができました！

モジュールを書く

ロード時のテストモジュールは、シェルメニューに2つのアイテムを追加します。 最初のアイテムは、碑文のある非常にシンプルなフォームを右側に表示します。 2番目のボタンはボタンのあるフォームで、開いたファイル選択ダイアログでモジュールを選択してモジュールをロードできます。 命名規則に従って、2つのビューとViewModelsフォルダーを作成します。 その後、それらを埋めます。



最初のビューとビューモデルは簡単です。

 <UserControl x:Class="Module.Views.FirstView" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" xmlns:d="http://schemas.microsoft.com/expression/blend/2008" mc:Ignorable="d" d:DesignHeight="300" d:DesignWidth="300"> <Grid> <TextBlock HorizontalAlignment="Center" VerticalAlignment="Center" FontSize="60">Hello, I'm first !</TextBlock> </Grid> </UserControl>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

  class FirstViewModel { }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

2番目のビューも難しくありません。

 <UserControl x:Class="Module.Views.SecondView" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" xmlns:d="http://schemas.microsoft.com/expression/blend/2008" mc:Ignorable="d" d:DesignHeight="300" d:DesignWidth="300"> <Grid> <Button x:Name="Load" HorizontalAlignment="Center" VerticalAlignment="Center" FontSize="50">Load Module</Button> </Grid> </UserControl>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

2番目のビューモデルでは、選択したモジュールをロードします。

 class SecondViewModel { private readonly IShell _shell; public SecondViewModel(IShell shell) { _shell = shell; } public void Load() { var dlg = new OpenFileDialog (); if (dlg.ShowDialog().GetValueOrDefault()) { var asm = Assembly.LoadFrom(dlg.FileName); var module = _shell.LoadModule(asm); if(module!=null) module.Init(); } } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

IModuleコントラクトを実装します。 Initメソッドで、アイテムをシェルメニューに追加します。

 class ModuleImpl : IModule { private readonly IShell _shell; private readonly FirstViewModel _firstViewModel; private readonly SecondViewModel _secondViewModel; public ModuleImpl(IShell shell, FirstViewModel firstViewModel, SecondViewModel secondViewModel) { _shell = shell; _firstViewModel = firstViewModel; _secondViewModel = secondViewModel; } public void Init() { _shell.MenuItems.Add(new ShellMenuItem() { Caption = "First", ScreenViewModel = _firstViewModel }); _shell.MenuItems.Add(new ShellMenuItem() { Caption = "Second", ScreenViewModel = _secondViewModel }); } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

そして最後の仕上げはインストーラーです。

 public class ModuleInstaller:IWindsorInstaller { public void Install(IWindsorContainer container, IConfigurationStore store) { container .Register(Component.For<FirstViewModel>()) .Register(Component.For<SecondViewModel>()) .Register(Component.For<IModule>().ImplementedBy<ModuleImpl>()); } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

できた！



ソース-gitハブ 。

おわりに

この記事では、Castle.WindwsorおよびCaliburn.Microフレームワークを使用して、最も単純なモジュラーWPFアプリケーションを作成することを検討しました。 もちろん、多くの側面がカバーされていなかった、いくつかの詳細が省略されていた、など、そうでなければ本は判明し、そうではなかったでしょう。 さらに詳細な情報は、公式リソースだけでなく、見つけることができます。



すべての質問に喜んでお答えします。



ご清聴ありがとうございました！