WPF Prism 複数フォルダから動的にモジュールを読み込む方法（単一ファイル）

Question

実現したいこと

「Modules」と「Plugins」というフォルダがあり、それぞれのフォルダに配置されているモジュールを動的に読み込みし、単一ファイルでアプリケーションを発行したいです。（「Modules」は遅延読み込み、「Plugins」は起動時に読み込み）

前提

アプリケーション本体と、複数のモジュールで構成されているアプリケーションをPrismで作成しております。

「Modules」には50個ほどのプロジェクトがあり、こちらは呼び出し時にロードされる遅延読み込みをしております。（Prism.Modularity.InitializationMode.OnDemand）

「Plugins」には機能拡張用の便利ツール等の独立したプロジェクトを配置し、アプリケーション起動時に読み込みされ、Menu要素に表示しております。（Prism.Modularity.InitializationMode.WhenAvailable）

どちらのモジュールも要件によって動的に配置され、アプリケーション本体は何のモジュールがあるかを知りません。

発生している問題・エラーメッセージ

上記の動作は、以下のサイトを参考にして、通常のアプリケーションの発行方法では実現できております。
Multiple DirectoryModuleCatalog in a Prism application（stack overflow）

protected override IModuleCatalog CreateModuleCatalog()
{
    var path = Path.GetDirectoryName(AppContext.BaseDirectory);
    var directories = new string[] { "Modules", "Plugins" };
    List<IModuleCatalogItem> components = [];
    var catalog = new ModuleCatalog();

    foreach (var dir in directories)
    {
        var dirCatalog = new DirectoryModuleCatalog() { ModulePath = $"{path}\\{dir}" };
        dirCatalog.Initialize();        // ★単一ファイルで発行した場合、ここでエラーが発生
        components.AddRange(dirCatalog.Items);
    }
    foreach (var component in components)
    {
        catalog.Items.Add(component);
    }
    // 呼び出し時にモジュールを読み込む（遅延読み込み）
    foreach (var moduleInfo in catalog.Modules)
    {
        if (Path.GetFileName(Path.GetDirectoryName(moduleInfo.Ref)) == "Modules")
            moduleInfo.InitializationMode = InitializationMode.OnDemand;
    }
    return catalog;
}

しかし、単一ファイルで発行した場合には、上記エラー発生個所のPrism内部で、.NET非互換性APIのAssembly.Location等が使用されており、Pathが空文字になるためエラーが発生しているように見受けられます。

DirectoryModuleCatalog.netcore.cs
[Prism.Modularity]

/// <summary>
/// Drives the main logic of building the child domain and searching for the assemblies.
/// </summary>
protected override void InnerLoad()
{
    if (string.IsNullOrEmpty(this.ModulePath))
        throw new InvalidOperationException(Resources.ModulePathCannotBeNullOrEmpty);

    if (!Directory.Exists(this.ModulePath))
        throw new InvalidOperationException(
            string.Format(CultureInfo.CurrentCulture, Resources.DirectoryNotFound, this.ModulePath));

    AppDomain childDomain = AppDomain.CurrentDomain;

    try
    {
        List<string> loadedAssemblies = new List<string>();

        var assemblies = (
                             from Assembly assembly in AppDomain.CurrentDomain.GetAssemblies()
                             where !(assembly is System.Reflection.Emit.AssemblyBuilder)
                                && assembly.GetType().FullName != "System.Reflection.Emit.InternalAssemblyBuilder"
                                && !String.IsNullOrEmpty(assembly.Location)
                             select assembly.Location
                         );

        loadedAssemblies.AddRange(assemblies);

        Type loaderType = typeof(InnerModuleInfoLoader);

        if (loaderType.Assembly != null)
        {
            var loader =
                (InnerModuleInfoLoader)
                childDomain.CreateInstanceFrom(loaderType.Assembly.Location, loaderType.FullName).Unwrap();

            this.Items.AddRange(loader.GetModuleInfos(this.ModulePath));
        }
    }
    catch (Exception ex)
    {
        throw new Exception("There was an error loading assemblies.", ex);
    }
}

エラーメッセージ

There was an error loading assemblies.

同じような処理をされている方もいらっしゃるかと思いますので、どのような方法を取っていらっしゃるのか、お力添えいただけると幸いです。
よろしくお願いいたします。

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

Visual Studio 2022 Version 17.8.6
.NET 8
Prism.DryIoc (8.1.97)

なお、平日日中のお返事になりますことをご了承ください。

Comments

[TN8001]

「自分で読み込んでね」って言ってるような？（自動翻訳なので自信なし）
[[Bug] Exception on startup when using DirectoryModuleCatalog in .NET 5.0 single-file WPF application · Issue #2254 · PrismLibrary/Prism](https://github.com/PrismLibrary/Prism/issues/2254)

課金すれば相談に乗ってくれるかもしれませんね😉

わたしは「同じような処理をされている方」ではないです。

[sakizakino]

TN8001様　いつもWPF関連の質問で大変参考にさせていただいております。
該当のIssueの提示、ありがとうございます。
自分は「DirectoryModule」までで検索していたため、見つけられませんでした・・・。
公式がコードで実装しろとの回答でしたので、そちらの方向で検討します。
貴重なお時間を割いていただき、ありがとうございました。

[TN8001]

> 公式がコードで実装しろとの回答でしたので、そちらの方向で検討します。

何かしら成果がございましたら、知見を共有して頂けたらありがたいです。
[ヘルプ｜質問をした後に自己解決してしまった](https://teratail.com/help#resolve-myself)

[sakizakino]

解決方法につきましては、しばしお時間をいただき、追記いたします。

Answer 1

当初はPrismに用意されている、DirectoryModuleCatalogをどうにかして実現しようとしておりましたが、TN8001様がご提示してくださったIssueや類似のIssueにて、公式が「単一ファイルには対応していない、あなたがプルリクしてね！」というような回答をしていたので、IModuleManagerのLoadModuleを用いて解決しました。

結論として、該当部分は以下のコードになります。

protected override void ConfigureModuleCatalog(IModuleCatalog moduleCatalog)
{
    string appPath = AppContext.BaseDirectory;
    string modulesPath = Path.Combine(appPath, "Modules");
    string pluginsPath = Path.Combine(appPath, "Plugins");

    string[] modules = Directory.GetFiles(modulesPath, "*.dll", SearchOption.TopDirectoryOnly);
    string[] plugins = Directory.GetFiles(pluginsPath, "*.dll", SearchOption.TopDirectoryOnly);

    var pluginMenuService = _container.Resolve<IPluginMenuService>();

    // Modulesフォルダ以下のモジュールを追加
    foreach (string modulePath in modules)
    {
        var assembly = Assembly.LoadFrom(modulePath);
        string assemblyName = assembly.GetName().Name;    // ModuleA

        // [プロジェクト名]Moduleという命名規約にする
        var moduleName = assembly.GetTypes().Where(x => x.Name == $"{assemblyName}Module").FirstOrDefault();

        moduleCatalog.AddModule(new ModuleInfo()
        {
            ModuleName = moduleName.Name,
            ModuleType = moduleName.AssemblyQualifiedName,
            InitializationMode = InitializationMode.OnDemand
        });

        pluginMenuService.ModuleNames.Add($"{assemblyName}Module");
    }

    // Pluginsフォルダ以下のモジュールを追加
    foreach (string modulePath in plugins)
    {
        var assembly = Assembly.LoadFrom(modulePath);
        string assemblyName = assembly.GetName().Name;

        var moduleName = assembly.GetTypes().Where(x => x.Name == $"{assemblyName}Module").FirstOrDefault();

        moduleCatalog.AddModule(new ModuleInfo()
        {
            ModuleName = moduleName.Name,
            ModuleType = moduleName.AssemblyQualifiedName,
            InitializationMode = InitializationMode.WhenAvailable
        });
    }

    // 参照モジュールの追加
    moduleCatalog.AddModule<ModuleBModule>();
}

public MainWindowViewModel(IRegionManager regionManager, IModuleManager moduleManager, IPluginMenuService pluginMenuService)
{
    ModuleMenus = pluginMenuService.ModuleMenus.ToReadOnlyReactiveCollection();
    PluginMenus = pluginMenuService.PluginMenus.ToReadOnlyReactiveCollection();
    ModuleNames = pluginMenuService.ModuleNames.ToReadOnlyReactiveCollection();

    AddModuleCommand.Subscribe(x =>
    {
        moduleManager.LoadModule(x);
    });

    NavigateCommand.Subscribe(x => regionManager.RequestNavigate("ContentRegion", x));
}

いろいろと雑なのはご容赦ください。
一応、全体のコードも載せておきますが、以下は読み飛ばしてください。

プログラムの構成

ModuleLoadManualSample - アプリケーション本体 - MainWindow

ModuleA - 遅延読み込みモジュール - ViewA
ModuleB - プロジェクト参照モジュール（起動時読み込み） - ViewB
PluginA - 起動時読み込みプラグイン - ViewC

PluginServices - プラグイン用のサービス
PluginServices.Interfaces - プラグイン用のサービスのインターフェース

Answer 2

インターフェース

namespace PluginServices.Interfaces.Models
{
    public class MenuBase
    {
        public string Header { get; set; } = string.Empty;
        public string ViewName { get; set; } = string.Empty;
    }
}

using System.Collections.ObjectModel;
using PluginServices.Interfaces.Models;

namespace PluginServices.Interfaces
{
    public interface IPluginMenuService
    {
        ObservableCollection<MenuBase> ModuleMenus { get; }
        ObservableCollection<MenuBase> PluginMenus { get; }
        ObservableCollection<string> ModuleNames { get; }
    }
}

サービス

using System.Collections.ObjectModel;
using PluginServices.Interfaces;
using PluginServices.Interfaces.Models;

namespace PluginServices
{
    public class PluginMenuService : IPluginMenuService
    {
        public ObservableCollection<MenuBase> ModuleMenus { get; } = [];
        public ObservableCollection<MenuBase> PluginMenus { get; } = [];
        public ObservableCollection<string> ModuleNames { get; } = [];
    }
}

モジュール

using System.Windows;
using ModuleA.Views;
using PluginServices.Interfaces;
using Prism.Ioc;
using Prism.Modularity;

namespace ModuleA
{
    public class ModuleAModule : IModule
    {
        public void OnInitialized(IContainerProvider containerProvider)
        {
            var pluginMenu = containerProvider.Resolve<IPluginMenuService>();
            pluginMenu.ModuleMenus.Add(new() { Header = "モジュールA", ViewName = nameof(ViewA) });
        }

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

namespace ModuleB
{
    public class ModuleBModule : IModule
    {
        public void OnInitialized(IContainerProvider containerProvider)
        {
            var pluginMenu = containerProvider.Resolve<IPluginMenuService>();
            pluginMenu.ModuleMenus.Add(new() { Header = "モジュールB", ViewName = nameof(ViewB) });
        }

        public void RegisterTypes(IContainerRegistry containerRegistry)
        {
            containerRegistry.RegisterForNavigation<ViewB>();
        }
    }
}

using System.Windows;
using PluginA.Views;
using PluginServices.Interfaces;
using Prism.Ioc;
using Prism.Modularity;

namespace PluginA
{
    public class PluginAModule : IModule
    {
        public void OnInitialized(IContainerProvider containerProvider)
        {
            var pluginMenu = containerProvider.Resolve<IPluginMenuService>();
            pluginMenu.PluginMenus.Add(new() { Header = "プラグインA", ViewName = nameof(ViewC) });
        }

        public void RegisterTypes(IContainerRegistry containerRegistry)
        {
            containerRegistry.RegisterForNavigation<ViewC>();
        }
    }
}

アプリケーション本体

using System.IO;
using System.Reflection;
using System;
using System.Windows;
using ModuleLoadManualSample.Views;
using PluginServices;
using PluginServices.Interfaces;
using Prism.Ioc;
using Prism.Modularity;
using System.Linq;
using ModuleB;
using DryIoc;
using Prism.DryIoc;

namespace ModuleLoadManualSample
{
    /// <summary>
    /// Interaction logic for App.xaml
    /// </summary>
    public partial class App
    {
        IContainer _container;

        protected override Window CreateShell()
        {
            return Container.Resolve<MainWindow>();
        }

        protected override void RegisterTypes(IContainerRegistry containerRegistry)
        {
            containerRegistry.RegisterSingleton<IPluginMenuService, PluginMenuService>();

            _container = containerRegistry.GetContainer();
        }

        protected override void ConfigureModuleCatalog(IModuleCatalog moduleCatalog)
        {
            string appPath = AppContext.BaseDirectory;
            string modulesPath = Path.Combine(appPath, "Modules");
            string pluginsPath = Path.Combine(appPath, "Plugins");

            string[] modules = Directory.GetFiles(modulesPath, "*.dll", SearchOption.TopDirectoryOnly);
            string[] plugins = Directory.GetFiles(pluginsPath, "*.dll", SearchOption.TopDirectoryOnly);

            var pluginMenuService = _container.Resolve<IPluginMenuService>();

            // Modulesフォルダ以下のモジュールを追加
            foreach (string modulePath in modules)
            {
                var assembly = Assembly.LoadFrom(modulePath);
                string assemblyName = assembly.GetName().Name;

                // [プロジェクト名]Moduleという命名規約にする
                var moduleName = assembly.GetTypes().Where(x => x.Name == $"{assemblyName}Module").FirstOrDefault();

                moduleCatalog.AddModule(new ModuleInfo()
                {
                    ModuleName = moduleName.Name,
                    ModuleType = moduleName.AssemblyQualifiedName,
                    InitializationMode = InitializationMode.OnDemand
                });

                pluginMenuService.ModuleNames.Add($"{assemblyName}Module");
            }

            // Pluginsフォルダ以下のモジュールを追加
            foreach (string modulePath in plugins)
            {
                var assembly = Assembly.LoadFrom(modulePath);
                string assemblyName = assembly.GetName().Name;

                var moduleName = assembly.GetTypes().Where(x => x.Name == $"{assemblyName}Module").FirstOrDefault();

                moduleCatalog.AddModule(new ModuleInfo()
                {
                    ModuleName = moduleName.Name,
                    ModuleType = moduleName.AssemblyQualifiedName,
                    InitializationMode = InitializationMode.WhenAvailable
                });
            }

            // 参照モジュールの追加
            moduleCatalog.AddModule<ModuleBModule>();
        }
    }
}

using System;
using PluginServices.Interfaces;
using PluginServices.Interfaces.Models;
using Prism.Modularity;
using Prism.Mvvm;
using Prism.Regions;
using Reactive.Bindings;

namespace ModuleLoadManualSample.ViewModels
{
    public class MainWindowViewModel : BindableBase
    {
        public ReadOnlyReactiveCollection<MenuBase> ModuleMenus { get; }
        public ReadOnlyReactiveCollection<MenuBase> PluginMenus { get; }
        public ReadOnlyReactiveCollection<string> ModuleNames { get; }

        public ReactiveCommand<string> AddModuleCommand { get; } = new();
        public ReactiveCommand<string> NavigateCommand { get; } = new();

        public MainWindowViewModel(IRegionManager regionManager, IModuleManager moduleManager, IPluginMenuService pluginMenuService)
        {
            ModuleMenus = pluginMenuService.ModuleMenus.ToReadOnlyReactiveCollection();
            PluginMenus = pluginMenuService.PluginMenus.ToReadOnlyReactiveCollection();
            ModuleNames = pluginMenuService.ModuleNames.ToReadOnlyReactiveCollection();

            AddModuleCommand.Subscribe(x =>
            {
                moduleManager.LoadModule(x);
            });

            NavigateCommand.Subscribe(x => regionManager.RequestNavigate("ContentRegion", x));
        }
    }
}

<Window x:Class="ModuleLoadManualSample.Views.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:prism="http://prismlibrary.com/"
        xmlns:viewmodels="clr-namespace:ModuleLoadManualSample.ViewModels"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        d:DataContext="{d:DesignInstance Type=viewmodels:MainWindowViewModel}"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        mc:Ignorable="d" 
        prism:ViewModelLocator.AutoWireViewModel="True"
        Title="ModuleLoadManual" Height="350" Width="525" >
    <Grid>
        <Grid.RowDefinitions>
            <RowDefinition Height="Auto"/>
            <RowDefinition/>
        </Grid.RowDefinitions>
        <Menu>
            <MenuItem Header="モジュールの追加" ItemsSource="{Binding ModuleNames}">
                <MenuItem.ItemContainerStyle>
                    <Style TargetType="MenuItem">
                        <Setter Property="Header" Value="{Binding }"/>
                        <Setter Property="Command" Value="{Binding DataContext.AddModuleCommand, RelativeSource={RelativeSource AncestorType=Window}}"/>
                        <Setter Property="CommandParameter" Value="{Binding }"/>
                    </Style>
                </MenuItem.ItemContainerStyle>
            </MenuItem>
            <MenuItem Header="モジュール" ItemsSource="{Binding ModuleMenus}">
                <MenuItem.ItemContainerStyle>
                    <Style TargetType="MenuItem">
                        <Setter Property="Header" Value="{Binding Header}"/>
                        <Setter Property="Command" Value="{Binding DataContext.NavigateCommand, RelativeSource={RelativeSource AncestorType=Window}}"/>
                        <Setter Property="CommandParameter" Value="{Binding ViewName}"/>
                    </Style>
                </MenuItem.ItemContainerStyle>
            </MenuItem>
            <MenuItem Header="プラグイン" ItemsSource="{Binding PluginMenus}">
                <MenuItem.ItemContainerStyle>
                    <Style TargetType="MenuItem">
                        <Setter Property="Header" Value="{Binding Header}"/>
                        <Setter Property="Command" Value="{Binding DataContext.NavigateCommand, RelativeSource={RelativeSource AncestorType=Window}}"/>
                        <Setter Property="CommandParameter" Value="{Binding ViewName}"/>
                    </Style>
                </MenuItem.ItemContainerStyle>
            </MenuItem>
        </Menu>
        <ContentControl Grid.Row="1" prism:RegionManager.RegionName="ContentRegion" />
    </Grid>
</Window>