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

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

モノリスからの脱却:VB.NETとWPFによる動的プラグインアーキテクチャの極致

業務システムの規模が拡大し、機能要件が複雑化していく過程で、避けて通れない壁がある。それは「モノリス(巨大な単一構造)の限界」だ。

すべての機能を一つの実行ファイル(EXE)に詰め込み、ビルドのたびに全機能を再テストする。そんな非効率な開発サイクルは、エンタープライズの現場では致命的な遅延を招く。真に堅牢で拡張性の高いシステムとは、本体(Host)と機能(Plugin)が疎結合であり、実行時にモジュールを差し替え、あるいは追加できる構造を持っていなければならない。

本稿では、VB.NETとWPFを用い、`Assembly.LoadFrom`による動的アセンブリロードを核とした、プロフェッショナルなプラグインアーキテクチャの設計思想とその実装技術を詳解する。

1. アーキテクチャの設計思想:契約(Contract)による支配

プラグインアーキテクチャにおいて、最も重要なのは「何を作るか」ではなく「どう約束するか」である。本体とプラグインの間には、共通の「契約」が必要だ。これを誤ると、型定義の不一致による`InvalidCastException`の嵐に晒されることになる。

共通インターフェースの定義

まず、本体とプラグインの両方が参照する「Contractプロジェクト(DLL)」を独立して作成する。ここには、実装ではなく、インターフェースのみを定義する。

' --- ContractAssembly.dll ---
Namespace Enterprise.Plugin.Contract
    ''' <summary>
    ''' 全てのプラグインが実装すべき基本契約
    ''' </summary>
    Public Interface IPlugin
        ''' <summary>
        ''' プラグインの識別名
        ''' </summary>
        ReadOnly Property PluginName As String

        ''' <summary>
        ''' プラグインの初期化処理
        ''' </summary>
        ''' <param name="context">本体から渡されるコンテキスト情報</param>
        Sub Initialize(context As IPluginContext)

        ''' <summary>
        ''' WPFのUI要素(UserControl)を返す
        ''' </summary>
        Function GetView() As System.Windows.Controls.UserControl

        ''' <summary>
        ''' 解放処理。メモリリークを防ぐための必須メソッド
        ''' </summary>
        Sub Shutdown()
    End Interface

    ''' <summary>
    ''' 本体からプラグインへ提供するサービスインターフェース
    ''' </summary>
    Public Interface IPluginContext
        ReadOnly Property Version As String
        Sub LogMessage(message As String)
    End Interface
End Namespace

2. 動的ロードの実装:Assembly.LoadFromの制御

次に、本体側(Host)の実装だ。ここでは、特定のディレクトリをスキャンし、`Assembly.LoadFrom`を用いて実行時にDLLをメモリへ展開する。

ここで注意すべきは、`Assembly.Load`(GACやアプリケーションベースの検索)ではなく、あえて`LoadFrom`を使用する点だ。これにより、アプリケーションの実行ディレクトリ外にある任意のパスからモジュールをロードできる柔軟性が生まれる。

' --- HostApplication (WPF) ---
Imports System.Reflection
Imports System.IO
Imports Enterprise.Plugin.Contract

Public Class PluginLoader
    Private _loadedPlugins As New List(Of IPlugin)()

    ''' <summary>
    ''' 指定されたディレクトリ内のDLLからプラグインをロードする
    ''' </summary>
    Public Sub LoadPlugins(ByVal pluginDirectory As String, ByVal context As IPluginContext)
        If Not Directory.Exists(pluginDirectory) Then Return

        Dim dllFiles = Directory.GetFiles(pluginDirectory, "*.dll")

        For Each dllPath In dllFiles
            Try
                ' Assemblyを動的にロード
                Dim assembly As Assembly = Assembly.LoadFrom(dllPath)

                ' IPluginインターフェースを実装している型を探査
                Dim pluginTypes = assembly.GetTypes().
                    Where(Function(t) TypeOf GetType(IPlugin).IsAssignableFrom(t) AndAlso Not t.IsInterface AndAlso Not t.IsAbstract)

                For Each pluginType In pluginTypes
                    ' 型からインスタンスを生成
                    Dim pluginInstance As IPlugin = DirectCast(Activator.CreateInstance(pluginType), IPlugin)
                    
                    ' 初期化
                    pluginInstance.Initialize(context)
                    _loadedPlugins.Add(pluginInstance)
                    
                    Debug.WriteLine($"Successfully loaded: {pluginInstance.PluginName}")
                Next

            Catch ex As Exception
                ' 業務システムでは、一つのプラグインの失敗が全体を停止させてはならない
                ' 厳格なエラーハンドリングとロギングが必須
                Debug.WriteLine($"Failed to load {dllPath}: {ex.Message}")
            End Try
        Next
    End Sub

    Public ReadOnly Property Plugins As List(Of IPlugin)
        Get
            Return _loadedPlugins
        End Get
    End Property

    ''' <summary>
    ''' 全てのプラグインを安全に破棄する
    ''' </summary>
    Public Sub UnloadAll()
        For Each plugin In _loadedPlugins
            plugin.Shutdown()
        Next
        _loadedPlugins.Clear()
        ' 注意: .NET Frameworkにおいて、ロードされたAssemblyを個別にメモリから完全に消去することは困難。
        ' 完全なアンロードが必要な場合は AppDomain の分離を検討せよ。
    End Sub
End Class

3. WPFへの統合:XAMLによる動的UI展開

ロードされたプラグインが持つ`UserControl`を、WPFのメイン画面にどう組み込むか。ここでは、`ItemsControl`や`ContentControl`を利用し、`DataTemplate`を通じてUIを流し込む手法が最も洗練されている。

MainView.xaml の設計

プラグインのViewを、タブ形式、あるいはサイドバー形式で表示する設計にする。

<!-- MainView.xaml -->
<Window x:Class="MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        Title="Enterprise Plugin Host" Height="450" Width="800">
    <Grid>
        <TabControl x:Name="PluginTabControl">
            <!-- プラグインのViewがここに追加されていく -->
        </TabControl>
    </Grid>
</Window>

MainWindow.xaml.vb のロジック

ロードしたプラグインをUI要素として追加するプロセスだ。

' --- MainWindow.xaml.vb ---
Class MainWindow
    Private _loader As New PluginLoader()

    Private Sub MainWindow_Loaded(sender As Object, e As RoutedEventArgs) Handles Me.Loaded
        ' コンテキストの実装(簡易版)
        Dim context As IPluginContext = New PluginContextImpl()

        ' プラグインディレクトリの指定
        Dim pluginPath As String = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Plugins")
        
        ' ロード実行
        _loader.LoadPlugins(pluginPath, context)

        ' UIへの反映
        For Each plugin In _loader.Plugins
            Dim tabItem As New TabItem()
            tabItem.Header = plugin.PluginName
            
            ' プラグインが提供するUserControlを取得してContentにセット
            Dim view = plugin.GetView()
            tabItem.Content = view
            
            PluginTabControl.Items.Add(tabItem)
        Next
    End Sub
End Class

' コンテキストの実装例
Public Class PluginContextImpl
    Implements IPluginContext

    Public ReadOnly Property Version As String Implements IPluginContext.Version
        Get
            Return "1.0.0"
        End Get
    End Property

    Public Sub LogMessage(message As String) Implements IPluginContext.LogMessage
        ' 本来はログライブラリ(NLogやlog4net)を呼び出す
        Console.WriteLine($"[PluginLog] {message}")
    End Sub
End Class

4. 伝説のアーキテクトが教える「極限の知見」:メモリとライフサイクル

ここまでが「動くもの」を作る方法だ。しかし、シニアエンジニアが真に注視すべきは、「動いた後の挙動」である。

① Assemblyのメモリリーク問題

`Assembly.LoadFrom`でロードされたアセンブリは、そのプロセスが終了するまでメモリ上に残り続ける。`.NET Framework`環境において、個別のAssemblyをアンロードすることは不可能に近い。
もし、プラグインの頻繁な追加・削除(Hot Reload)が必要なシステムであれば、`AppDomain`をプラグインごとに作成し、`AppDomain.Unload`を呼び出す設計にせざるを得ない。これはオーバーヘッドが大きいが、メモリ管理の観点からは正解だ。

② 依存関係の地獄(DLL Hell)

プラグインAが`Newtonsoft.Json v12`を使い、プラグインBが`v13`を使う場合、ロード時に衝突が発生する。
これを回避するには、以下の対策を講じることだ:

  • 強固な契約: インターフェース(Contract)は可能な限り、標準ライブラリのみで構成する。
  • 依存関係の局所化: プラグイン側に必要な依存DLLを同梱させ、`AppDomain.AssemblyResolve`イベントをハンドルして、適切なパスからロードされるよう制御する。

③ オブジェクトの明示的な解放

WPFにおいて、プラグインのView(UserControl)がイベントハンドラを登録したまま破棄されると、GC(Garbage Collector)がそのオブジェクトを回収できず、メモリリークを引き起こす。
必ず、`IPlugin.Shutdown()` メソッドを実装し、その中で以下の処理を行うことを徹底せよ。

  • イベントハンドラの解除(`-= handler`)
  • `IDisposable`を実装しているリソースの`Dispose()`呼び出し
  • WPFのデータバインディングに関連する参照のクリア

結言

プラグインアーキテクチャは、単なる「機能追加のテクニック」ではない。それは、システムの寿命を決定づける「保守性の設計」そのものである。

`Assembly.LoadFrom`による動的拡張は強力な武器となるが、その刃は常に「メモリ管理」と「依存関係の制御」というリスクを伴う。インターフェースという名の「契約」を厳格に守り、オブジェクトのライフサイクルを完全に掌握すること。それこそが、大規模システムを統べるアーキテクトに求められる真の資質である。

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