【実務・中級編】【上級者向け】VB.NETとWPFで構築するプラグインアーキテクチャ:Assembly.LoadFromによる動的モジュール拡張手法 – Visual Basic (VB / VB.NET)解析バイブル

スポンサーリンク
スポンサーリンク

巨大化する業務システムを救う:VB.NET + WPF による動的プラグインアーキテクチャの極意

業務システムの開発現場において、避けては通れない「魔物」がある。それは、「機能追加に伴う肥大化」だ。

最初はシンプルだったツールも、数年の運用を経て、会計、在庫、人事、そして独自の業務ロジックがすべて一つのEXEファイルの中に詰め込まれていく。その結果、一つの修正がシステム全体のリビルドを強いて、テスト工程を膨大にし、デプロイの恐怖を生む。これでは、本来の目的である「業務効率化」が、開発コストによって相殺されてしまう。

我々プロフェッショナルが目指すべきは、「本体(Core)は変化せず、機能(Plugin)だけを差し替える」アーキテクチャである。

本稿では、VB.NETとWPFを用い、`Assembly.LoadFrom` を活用した動的なプラグイン拡張手法を解説する。単なるコードの書き方ではない。保守性と堅牢性を両立させるための「設計思想」を伝授しよう。

1. 設計の要諦:疎結合を実現する「契約(Contract)」

プラグインアーキテクチャを構築する際、最もやってはいけないミスは、メインアプリケーションがプラグインの具体的なクラス名を知っている状態(密結合)を作ることだ。

これを防ぐには、「インターフェース(Contract)」を独立したプロジェクトとして定義し、本体とプラグインの両方がそれを参照する構造にする必要がある。

プロジェクト構成の黄金律

1. `MyApp.Contracts` (Class Library): インターフェースと共通のデータモデルのみを定義。
2. `MyApp.Core` (WPF Application): プラグインをロードし、UIを表示する本体。`Contracts` を参照。
3. `MyApp.Plugins.Inventory` (WPF UserControl Library): 具体的な機能を持つプラグイン。`Contracts` を参照。

2. 実装:インターフェースの定義

まずは、プラグインが「何ができるか」を定義する契約書を作成する。WPFとの親和性を高めるため、プラグインは自身の「ViewModel」を返すように設計するのがスマートだ。

' プロジェクト: MyApp.Contracts
Public Interface IPlugin
    ''' <summary>
    ''' プラグインの表示名
    ''' </summary>
    ReadOnly Property PluginName As String

    ''' <summary>
    ''' プラグインのアイコン(任意)
    ''' </summary>
    ReadOnly Property Icon As String

    ''' <summary>
    ''' プラグインのメインとなるViewModelを生成して返す
    ''' </summary>
    Function CreateViewModel() As Object
End Interface

3. 実装:動的ロードエンジン(Reflectionの制御)

ここが本題だ。`Assembly.LoadFrom` を使い、特定のフォルダ内にあるDLLをスキャンして、`IPlugin` を実装しているクラスを抽出する。

ここで重要なのは、「例外処理」と「依存関係の解決」だ。不正なDLLが混入しただけでメインアプリがクラッシュしては、業務ツールとしての信頼性はゼロになる。

' プロジェクト: MyApp.Core
Imports System.Reflection
Imports System.IO
Imports MyApp.Contracts

Public Class PluginLoader
    ''' <summary>
    ''' 指定されたディレクトリからIPluginを実装するモジュールをロードする
    ''' </summary>
    ''' <param name="pluginDirectory">DLLが格納されているパス</param>
    ''' <returns>ロードされたプラグインのインスタンスリスト</returns>
    Public Function LoadPlugins(pluginDirectory As String) As List(Of IPlugin)
        Dim plugins As New List(Of IPlugin)()

        If Not Directory.Exists(pluginDirectory) Then
            Directory.CreateDirectory(pluginDirectory)
            Return plugins
        End If

        ' ディレクトリ内の全DLLを取得
        Dim dllFiles = Directory.GetFiles(pluginDirectory, "*.dll")

        For Each dllPath In dllFiles
            Try
                ' Assembly.LoadFrom を使用。
                ' LoadFile ではなく LoadFrom を使う理由は、
                ' 依存する他のDLLを同じディレクトリから自動的に解決してくれるため。
                Dim assembly As Assembly = Assembly.LoadFrom(dllPath)

                ' アセンブリ内の全型を走査
                For Each t As Type In assembly.GetTypes()
                    ' IPluginインターフェースを実装しており、かつ抽象クラスではないクラスを探す
                    If GetType(IPlugin).IsAssignableFrom(t) AndAlso Not t.IsInterface AndAlso Not t.IsAbstract Then
                        ' インスタンス化
                        Dim pluginInstance = DirectCast(Activator.CreateInstance(t), IPlugin)
                        plugins.Add(pluginInstance)
                    End If
                Next
            Catch ex As Exception
                ' ここでログを出力する。一つのDLLの失敗が全体を止めてはならない。
                Debug.WriteLine($"Failed to load plugin: {dllPath}. Error: {ex.Message}")
            End Try
        Next

        Return plugins
    End Function
End Class

4. WPFでのモダンなUI統合

ロードしたプラグインをどう画面に表示するか。WPFの真骨頂である `DataTemplate` を活用する。
プラグインが返すのは「ViewModel」であり、それに対応する「View(UserControl)」をWPF側に定義しておくことで、コードビハインドを汚さずに表示を切り替えられる。

MainViewの設計 (XAML)

<!-- プロジェクト: MyApp.Core (MainWindow.xaml) -->
<Window x:Class="MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:local="clr-namespace:MyApp.Core"
        Title="Enterprise Modular System" Height="450" Width="800">
    
    <Window.Resources>
        <!-- 
            重要:プラグインのViewModelが渡されたとき、
            どのViewを表示するかをここで紐付ける。
            実際の実装では、プラグイン側で定義されたViewの型をここに登録するか、
            名前解決の仕組みを導入する。
        -->
        <!-- 例: InventoryViewModel が来たら InventoryView を表示する -->
        <!-- <DataTemplate DataType="{x:Type plugins:InventoryViewModel}">
            <plugins:InventoryView />
        </DataTemplate> -->
    </Window.Resources>

    <Grid>
        <Grid.ColumnDefinitions>
            <ColumnDefinition Width="200"/>
            <ColumnDefinition Width="*"/>
        </Grid.ColumnDefinitions>

        <!-- サイドバー:プラグイン一覧 -->
        <ListBox x:Name="PluginListBox" Grid.Column="0" 
                 DisplayMemberPath="PluginName"
                 SelectionChanged="PluginListBox_SelectionChanged"/>

        <!-- メインコンテンツ:選択されたプラグインのViewModelを表示 -->
        <ContentControl Grid.Column="1" Content="{Binding SelectedPluginViewModel}"/>
    </Grid>
</Window>

5. 現場で直面する「落とし穴」とその回避策

伝説的なアーキテクトとして、君たちが現場で血を流さないためのアドバイスを授けよう。

① 依存関係の地獄 (Dependency Hell)

プラグインAが `Newtonsoft.Json` の Ver.12 を使い、プラグインBが Ver.13 を使う場合、メインアプリの実行時に衝突が起きる。
対策: 可能な限り、プラグインが必要とする外部ライブラリは、プラグイン自身のフォルダ内に隔離し、`AppDomain` や最新の `.NET` であれば `AssemblyLoadContext` を用いて分離ロードを検討せよ。

② リソースの解放漏れ

プラグインがデータベース接続やファイルハンドルを掴んだまま終了すると、メモリリークやファイルロックの原因となる。
対策: `IPlugin` インターフェースに `IDisposable` を継承させ、プラグインがアンロードされる際に必ず `Dispose()` を呼び出す仕組みを本体側に実装せよ。

③ データベース連携の注意点

プラグインごとに独自のテーブルを持たせたい場合、本体のDB接続文字列をそのまま渡すのは危険だ。
対策: 接続文字列そのものを渡すのではなく、`IDbConnectionFactory` のような抽象化されたインターフェースを介して、接続権限を制御して提供せよ。

まとめ

プラグインアーキテクチャは、単なる「便利な機能」ではない。システムが数年、十数年と生き残り、進化し続けるための「生存戦略」である。

`Assembly.LoadFrom` による動的ロードは、強力だが諸刃の剣だ。インターフェースによる厳格な契約、例外を許容する堅牢なロード処理、そして WPF の `DataTemplate` を活用したクリーンなUI統合。これらを組み合わせることで、君たちの作るシステムは、単なるツールから「プラットフォーム」へと昇華する。

設計に迷ったら、常に自分に問いかけろ。
「この機能を追加するために、私は本体のコードを一行でも書き換える必要があるか?」

もし「YES」なら、君の設計はまだ、未完成だ。

タイトルとURLをコピーしました