PrismでViewを動的ロード

Question

前提・実現したいこと

WPFでPrismを使用したプログラムを作成しようとしています。

やりたいことは、動作等が全く同じで見た目だけが違うViewを動的にロードして切り替えたいというものです。

今までは同様のプログラムを作成する際、MVVMを使用せず動的にロードしたユーザーコントロールを貼り付けていました。(動作はベースクラスで記述)

始めたばかりで理解度が浅く、どうしていいのか途方に暮れている状態です。

試したこと

とりあえず、やってみてダメだったものをいかに記します。

１．View1プロジェクトを作成し、View1というViewを作成する。

２．App.xaml.csのRegisterTypesでDLLを読み込んでDIに登録する。

var oAssembly = Assembly.LoadFrom(@".\View1.dll");
var oClass = oAssembly.CreateInstance("View1.View1");
containerRegistry.RegisterInstance(oClass);

３．で？

という感じです。
実際には、ViewModelのプロジェクトを作成してViewで参照し、assembly付きでDataContextを指定したり、MainWindowViewModel内でRequestNavigateでView1を指定してみたり、DIにViewModelも登録してみたりと、思いつく限りはしてみたのですが、思うようにいきません。

本当に見た目しか違わないので、VMの使いまわし方も含めてご教授いただければと思います。

補足情報（FW/ツールのバージョンなど）

VisualStudio 2019 (V16.9.4)
Prism V8

Comments

[TN8001]

モジュールで調べたらいいと思います。

[C# prism module - Google 検索](https://www.google.com/search?q=C%23+prism+module

私はやったことがないので詳しくはわかりません^^;

[yamaj]

説明が稚拙で申し訳ありません。
どうやったら動的にロードしたViewをリージョンマネージャーでナビゲートできるかという質問でした。

[hihijiji]

本当にやりたいこと(目的)はなんですか？
ページの外観を動的に変えたいってことですか？
少なくともViewを動的にロード云々は手段であって目的ではないはずです。
まずやるべきは少ない選択肢(知識)の中で手段を考えるのではなく、選択肢(知識)を増やすことです。
WPF + Prism で検索すればサンプルはいくらでも転がってますから、サンプルをたくさん見て選択肢を増やすのが近道です。

[yamaj]

ん～。
Viewの切り替えが主目的ですね。
デバイスエミュレーターみたいなもので、キー数や表示桁数は一緒で配置やサイズが違うフェイスをプラグイン的に切り替えたいので。
なので、VMは使いまわしたい、Viewは動的にロードしたいというのが目的です。
ちなみにViewModelを別プロジェクトへ外出し(XAMLでAssembly指定のDataContext設定)もDI注入部がエラーを吐いて失敗してます。
※引数なしのコンストラクタがないエラー

[hihijiji]

そもそもViewは動的に割り当てるのが普通なので、基礎さえ身についていれば
悩むところじゃないんですが…

つまずくとしたら、
prism:ViewModelLocator.AutoWireViewModel="True"
の所のViewの名前からViewModelを引き当てるところぐらい。

これを活かそうとするなら、約束通りの名前のViewModelを作って
そこに本来のViewModelの型のプロパティHogeHogeViewModelを1つだけ置きView冒頭で
DataContext="{Binding HogeHogeViewModel}"
と指定するとか

[yamaj]

引数なしのコンストラクタの場合はおっしゃる通りで実行できます。
ただ、注入を期待して以下のように書いてると…。
Project:ViewProcess
public class ProcViewModel : BindableBase
{
　　public ProcViewModel(IDataProvider dp)
　　{
　　}
}
View側のXAMLで以下のように書いても…。
<UserControl x:Class="View1.View1"
　　...
　　xmlns:vm="clr-namespace:ViewProcess;assembly=ViewProcess"
　　prism:ViewModelLocator.AutoWireViewModel="True">
　　<UserControl.DataContext>
　　　<vm:ProcViewModel />
　　</UserControl.DataContext>
</UserControl>
「型 'ProcViewModel' はパブリックでないか、パラメーターなしのパブリック コンストラクターまたは型コンバーターを定義していないため、オブジェクト要素として使用できません。」
となってしまいます。
これではDI注入の恩恵を受けることができないのです。

まぁ、同プロジェクトのVMは普通に自動割付されるので、全ての処理を書いたベースクラスを継承すればやりたいことはできそうですが…。

[hihijiji]

<UserControl.DataContext>
　　　<vm:ProcViewModel />
　　</UserControl.DataContext>
この書き方だと自分でProcViewModelのインスタンスをつくってますから
そりゃ無理です。
AutoWireViewModelの恩恵を受けるためには約束の名前空間に約束の名前のViewModelが
必要です。
で↑↑のアドバイス

[yamaj]

ご指摘の通りですね。
とりあえず、「ViewModelLocationProvider.SetDefaultViewTypeToViewModelTypeResolver」で強制的にAssembly書き換えたら別DLLのVMまで到達しました。
ただ、これをやっちゃっていいものかどうか…。
やはり無難にベースクラス作ったほうが後々「何やってるか分からない！」って事にはならなさそうな気がしてきました。

[hihijiji]

だからView1ViewModelにProcViewModelを置けば簡単に解決するんだって
View2ViewModel、View3ViewModelって増えてもProcViewModelは共用するには
ProcViewModelをDIに放り込むときシングルトンにすればOK

[yamaj]

あ、これも説明不足かも…。
プラグインのように使いたいので、各DLLにはViewが１つだけ入っているのが最高の理想で、ProcViewModelのインスタンスはView毎に生成されても全く問題はありません。
（処理自体はModelでやるので）
って、またトンチンカンな事書いてますかね？

[hihijiji]

> プラグインのように使いたい
ようやく本当にやりたいことが出てきましたね。
でもそれって、レイアウトやスタイルだけをリソースにしたら良くない？

[yamaj]

昔（えとひとまわりくらい）は、わざわざデザインツールを作って画像やら座標やらをXMLでパックして…なんてやってましたが、1回作ればほぼ触らないですし、新しいのを作る場合は機能アップがある場合もあるのでロジック側と一緒に画面も作ってしまえばせっかくある純正デザイナーが使えますし、他の人に渡すにも取説つくるより「ソース見ろ」で済みますし。ね？

[hihijiji]

状況はなんとなくわかりましたが、それゆえアドバイス出来ることはなにもないです。m(_ _)m
自分はアプリケーションの仕様書だけはしっかり書いてますが、汎用DLL以外はXMLドキュメントすらお座なりです。

[yamaj]

色々とお付き合い頂きありがとうございました。
仕様書を書かない自分が悪いんですが、時間が経つと自分でも何をしてたかわからなくなるんですよねｗ
周りにまともに相談できる人がいないので、とても有り難く思いました。
また何かあればよろしくお願いいたします。

Answer 1

個人的にはAutoWireしなければ親のDataContextを引き継ぎますから、どうにでもコントロールできていいと思うのですが（Prism的にはいまいちなんですかね）

あとd:DataContextにデザイン用VMなりVMでデザイン時を判断しデータを入れるようにしておくと気が利くなって思います。

回答の私のコメントを回収しておきます。
VMの条件によってはAutoWireしてもいいと思います。
SetDefaultViewTypeToViewModelTypeResolverが面倒だったら、本体のViewAViewModelをカラ継承しておいておくとか？^^;

本体はプラグインのことを知らないが、プラグインは本体のことを知っていていいんですよね？

本体側

<Window
  x:Class="BlankCoreApp1.Views.MainWindow"
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  xmlns:ViewModels="clr-namespace:BlankCoreApp1.ViewModels"
  xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
  xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
  xmlns:prism="http://prismlibrary.com/"
  Width="525"
  Height="350"
  d:DataContext="{d:DesignInstance {x:Type ViewModels:MainWindowViewModel}}"
  prism:ViewModelLocator.AutoWireViewModel="True"
  mc:Ignorable="d">
  <Grid>
    <GroupBox Header="ViewA">
      <ContentControl prism:RegionManager.RegionName="ContentRegion" DataContext="{Binding ViewAViewModel}" />
    </GroupBox>
  </Grid>
</Window>

<UserControl
  x:Class="BlankCoreApp1.Views.DefaultViewA"
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  xmlns:ViewModels="clr-namespace:BlankCoreApp1.ViewModels"
  xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
  xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
  d:DataContext="{d:DesignInstance {x:Type ViewModels:ViewAViewModel}, IsDesignTimeCreatable=True}"
  mc:Ignorable="d">
  <DockPanel>
    <TextBlock DockPanel.Dock="Top" Text="BlankCoreApp1.Views.DefaultViewA" />
    <TextBlock Text="{Binding Message}" />
  </DockPanel>
</UserControl>

using BlankCoreApp1.Views;
using Prism.Mvvm;
using Prism.Regions;

namespace BlankCoreApp1.ViewModels
{
    public class MainWindowViewModel : BindableBase
    {
        // 本題でないので直接newするが好きにDIしてください
        public ViewAViewModel ViewAViewModel { get; } = new ViewAViewModel();

        public MainWindowViewModel() { }

        public MainWindowViewModel(IRegionManager regionManager)
        {
            // CustomViewがなければデフォルトを表示
            regionManager.RegisterViewWithRegion("ContentRegion", typeof(DefaultViewA));
        }
    }

    public class ViewAViewModel : BindableBase
    {
        private string _message;
        public string Message { get => _message; set => SetProperty(ref _message, value); }

        public ViewAViewModel() => Message = $"{GetType().FullName}";
    }
}

using BlankCoreApp1.Views;
using Prism.Ioc;
using Prism.Modularity;
using System.Windows;

namespace BlankCoreApp1
{
    public partial class App
    {
        protected override Window CreateShell() => Container.Resolve<MainWindow>();

        protected override IModuleCatalog CreateModuleCatalog()
        {
            // 指定フォルダからモジュール読み込み
            return new DirectoryModuleCatalog() { ModulePath = @".\Modules" };
        }

        protected override void RegisterTypes(IContainerRegistry containerRegistry) { }
    }
}

---

プラグイン側

<UserControl
  x:Class="CustomViewAModule.Views.ViewA"
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  xmlns:ViewModels="clr-namespace:BlankCoreApp1.ViewModels;assembly=BlankCoreApp1"
  xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
  xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
  d:DataContext="{d:DesignInstance {x:Type ViewModels:ViewAViewModel}, IsDesignTimeCreatable=True}"
  mc:Ignorable="d">
  <DockPanel>
    <TextBlock DockPanel.Dock="Top" Text="CustomViewAModule.Views.ViewA" />
    <TextBlock Text="{Binding Message}" />
  </DockPanel>
</UserControl>

using CustomViewAModule.Views;
using Prism.Ioc;
using Prism.Modularity;
using Prism.Regions;

namespace CustomViewAModule
{
    public class CustomViewAModuleModule : IModule
    {
        public void OnInitialized(IContainerProvider containerProvider)
        {
            var regionManager = containerProvider.Resolve<IRegionManager>();

            // CustomViewで上書きナビゲート
            regionManager.RequestNavigate("ContentRegion", "ViewA");

            // こちらが後に呼ばれているのにうまく出なかった
            //regionManager.RegisterViewWithRegion("ContentRegion", typeof(ViewA));
        }

        public void RegisterTypes(IContainerRegistry containerRegistry) 
            => containerRegistry.RegisterForNavigation<ViewA>();
    }
}

Answer 2

どうやったら動的にロードしたViewをリージョンマネージャーでナビゲートできるかという質問でした。

モジュールについて調べていただけたのか甚だ疑問ですが、どうしてもCreateInstanceしたいということでしょうか？
モジュールにはその辺の機能もありますしロード方法も選べるのですが。

何か事情があるとして（特別な事情は質問に書いてください）提示の方法でやってみます。
Prismはコードが膨れがちでお互い説明や再現するのも大変なので、テンプレートをベースにします。

入っていると思いますがPrism Template PackのPrism Full App(.NET Core)で、新規にソリューションを作ります。

テストを含めてプロジェクト６つの、ゴツめのソリューションが生成されます。
すでにモジュールを使うようになっていますが、あえて使わないようにします。

1. FullApp1をスタートアッププロジェクトにして実行し、どのようなウィンドウが出るのか確認する
2. FullApp1.Modules.ModuleName.ModuleNameModuleを削除なりコメント化する
3. ModuleNameModuleの使用箇所、FullApp1.App.ConfigureModuleCatalogを削除なりコメント化する
4. 一度ソリューションをリビルドする
5. FullApp1プロジェクトから、FullApp1.Modules.ModuleNameの参照を切る
6. FullApp1.Modules.ModuleName.dllを、出力ディレクトリを変えるなり手でコピーするなりでFullApp1.exeと同じフォルダに配置する
7. FullApp1.Appを下記に書き換える

using FullApp1.Core;
using FullApp1.Services;
using FullApp1.Services.Interfaces;
using FullApp1.Views;
using Prism.Ioc;
using Prism.Regions;
using System.Reflection;
using System.Windows;

namespace FullApp1
{
    public partial class App
    {
        protected override Window CreateShell()
        {
            return Container.Resolve<MainWindow>();
        }

        protected override void RegisterTypes(IContainerRegistry containerRegistry)
        {
            containerRegistry.RegisterSingleton<IMessageService, MessageService>();

            var oAssembly = Assembly.LoadFrom(@".\FullApp1.Modules.ModuleName.dll");
            var oClass = oAssembly.CreateInstance("FullApp1.Modules.ModuleName.Views.ViewA");
            containerRegistry.RegisterInstance(oClass, "ViewA");
        }

        //protected override void ConfigureModuleCatalog(IModuleCatalog moduleCatalog)
        //{
        //    moduleCatalog.AddModule<ModuleNameModule>();
        //}

        protected override void OnInitialized()
        {
            base.OnInitialized();

            var regionManager = Container.Resolve<IRegionManager>();
            regionManager.RequestNavigate(RegionNames.ContentRegion, "ViewA");
        }
    }
}

では実行します。初めに実行したときと同じになったでしょうか？

RequestNavigateのタイミングが難しいというか、早すぎると出ないことはありました（よくわかっていません^^;

VMの使いまわし方

それこそRegisterInstanceやRegisterSingleton等、好きに登録したらいいんじゃないですか？

Comments

[yamaj]

すいません、動的ロードについては、休み中にこちらを見る前に解決できてしまいました。
単に以下の通りにすればよかったみたいです。

Assembly oAssembly = Assembly.LoadFrom(@".\View1.dll");
rgnMan.RegisterViewWithRegion("ContentRegion", oAssembly.GetType("View1.View1"));

切り替える際には、一旦リージョンから登録したものを削除して再登録してやればいけました。

[yamaj]

教えていただいたやり方をやってみました。

何分Prism Full Appプロジェクトを作成したのが初めてなもので、まずは生のテンプレートを調べるところから始めないとダメだなと感じました。
モジュールについての指摘は、実は未だにピンときていませんが、モジュール側で個別に初期化処理を走らせる事ができる点についての指摘かなと思っています。（間違っていたらご指摘ください）
今回は、最初の質問で「なんとかしてDIに登録しなければ」という思い込みから始まったもので、着地点が全く違うところ（MainWindowViewModelでRegisterViewWithRegionをする）に自分の中ではなりそうです。
「そんなのは作法とは違う」というご指摘などがあれば是非お願いします。

[TN8001]

まず私はPrismに関してteratailの回答でちょろっと触る程度で1回もまともには使っていませんのでyamajさんと大差ないです。
指摘を入れるほど知りませんし、私のほうが間違っているかもしてません^^;

> 動的ロードについては、休み中にこちらを見る前に解決できてしまいました。

じゃああとは何が問題なんですか？
ViewとViewModelのアセンブリを分ける方法？
追記依頼のコメントを整理して質問に追記してください。

> 強制的にAssembly書き換えたら別DLLのVMまで到達しました。

[PrismでViewとViewModelのアセンブリを分けたい場合 - nuits.jp blog](https://www.nuits.jp/entry/2016/11/04/093826

これですよね。

> ただ、これをやっちゃっていいものかどうか…。

もともとがリフレクションなんだし自分がわかっていれば別にいい気がしますけど、引っかかってる点「…」を書いてもらわないと伝わりませんよ。

> モジュールについての指摘は、実は未だにピンときていませんが、

指定フォルダをまとめて読むとか読み込むタイミング、（モジュール内に書いていれば）DI登録等が楽でしょうってことが言いたかったのです。

> プラグインのように使いたいので、各DLLにはViewが１つだけ入っているのが最高の理想

> 他の人に渡すにも取説つくるより「ソース見ろ」で済みますし。

どこまでがyamajさんの管理下なんでしょう？
他人がViewを作る想定なんですか？

[yamaj]

とりあえず実現方法は見えてきたので、解決方法を纏めて質問を閉じてもいいんですが、何分一人でやっているもので周りに相談できる人がいないんですよね。
なので、色んな人の意見（それこそお作法なんか）が聞ければいいなとは思っています。

>> 強制的にAssembly書き換えたら…
これは、元々ViewとかViewModelというフォルダが鬱陶しくてネットで検索したものに置き換えていたので、デバッガで止めて文字列イジっての確認ですね。(元ネタ紛失)
ロジカルなことは一切考えてなかったので、「リテラルで置き換えちゃっていいのかなー」という意味での「やっちゃっていいのかどうか」でした。

管理的な事で言えば「孤独な一人部署」状態ですかねー。
ものを作る時は好き勝手できますが、後々面倒なので、「あとから手を加えそうな部分は分離したい」とか「手を加える範囲は最小限にしたい」とか「一段落したら丸投げしたい」とか、そういった部分で一般的なお作法や考え方が知りたいのです。
プロジェクトテンプレートでも作っておいて、ある程度簡単に（それこそXAML以外はノーコードで）画面が追加できるというのが理想ですね。

[TN8001]

「今は全部自分の管理下だが、自分の手が離れたときに混乱させたくない」
ということですか。

> 色んな人の意見（それこそお作法なんか）が聞ければいいなとは思っています。

hihijijiさんはなにか回答いただけるかもしれませんが、多様なというのは難しいかもしれません。
* WPFネタはアクティブな人があまりいない
* teratailの文化的に（必要十分と見られれば）あまり回答をかぶせない
* 意見募集を押し出すと「問題・課題が含まれていない質問」と言われてしまう

すぐ閉めろという気は全くありませんので、yamajさんが納得した段階で自己回答でも（私は）全く問題ありません。

> プロジェクトテンプレートでも作っておいて、ある程度簡単に（それこそXAML以外はノーコードで）画面が追加できるというのが理想ですね。

これはView（プラグイン）の話ですよね？
個人的にはAutoWireしなければ親のDataContextを引き継ぎますから、どうにでもコントロールできていいと思うのですが（Prism的にはいまいちなんですかね）

あとd:DataContextにデザイン用VMなりVMでデザイン時を判断しデータを入れるようにしておくと気が利くなって思います。

[yamaj]

色々とお付き合い頂きありがとうございました。
どちらかというと、物忘れが激しい上に仕様書を残さないので未来の自分の為にやってる感が強いかもしれません。
面倒な処理はベースクラスなんかで隠蔽したり、プロジェクトテンプレートを作ったりして、できるだけ後が楽なように作ろうとしています。
まぁ、結局毎回色んな所をいじりまわしてて隠蔽が意味なかったりするんですけどね。

今回、初めてteratailを使ったのでこの世界の常識もまだ分かっていませんが、少し揉まれながらやってみたいと思います。

質問を閉めるのは、TN8001さんから頂いたもう一つの回答を検証後にしたいと思いますが、ちょっと他に対応しなければいけない事が出てきてしまいすぐには手を付けられない状態になってしまいました。
今回は色々教えて頂き、本当にありがとうございました。

Answer 3

色々ご意見を頂きましたが、今回は以下のコードで対応しました。

Assembly oAssembly = Assembly.LoadFrom(@".\View1.dll");
rgnMan.RegisterViewWithRegion("ContentRegion", oAssembly.GetType("View1.View1"));

また、VMの使いまわしについてはTN8001さんの回答を元にもう少し考えてみます。
（理解が追いついていない部分があるため）