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

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

【極限の知見】VB.NETとWPFで構築するプラグインアーキテクチャ:Assembly.LoadFromによる動的モジュール拡張手法

こんにちは。今日は、プログラミングの世界における「一歩上のステージ」へ踏み出したいと考えている皆さんに、非常にエキサイティングな話をしましょう。

これまで、Excelマクロ(VBA)や、単一のEXEファイルを作るだけのプログラムを書いてきた方もいるかもしれません。それらは素晴らしい第一歩です。しかし、業務システムが巨大化し、「機能を追加するたびに、システム全体をビルドし直して、全ユーザーに再配布するのは非効率だ」と感じる瞬間が必ず訪れます。

そこで必要になるのが、「プラグインアーキテクチャ(拡張基盤)」です。

今回は、メインのプログラム(ホスト)はそのままに、後から「DLL(部品)」をフォルダに放り込むだけで機能が増える、プロフェッショナルな設計手法を、VB.NETとWPFを使って紐解いていきましょう。

1. なぜ「プラグイン」が必要なのか? —— 密結合からの脱却

まず、概念を整理しましょう。

一般的なプログラムは、すべての機能が「密結合(べったりとくっついた状態)」になっています。Aという機能を追加しようとすると、本体のコードを書き換え、再コンパイルし、配布し直す必要があります。

これに対し、プラグインアーキテクチャは「疎結合(ゆるやかな繋がり)」を目指します。

  • ホスト(本体): 「何をするか」は知らないが、「このルール(インターフェース)に従う部品が来たら、画面に表示する」という仕組みだけを持っている。
  • プラグイン(部品): 「具体的な機能」を持っているが、ホストが誰であるかは知らない。ただ、「このルール(インターフェース)を守って作ります」と宣言している。

この「ルール(契約)」こそが、リフレクションや `Assembly.LoadFrom` を使いこなす鍵となります。

2. 設計の要:インターフェースという「契約書」

プラグインを作る際、最も重要なのは「本体と部品が共通して理解できる言語」を作ることです。これをプログラミング用語で「インターフェース(Interface)」と呼びます。

まずは、共通のルールを定義するプロジェクト(例:`MySystem.Core`)を作成しましょう。

''' <summary>
''' プラグインが実装すべき共通の「契約書」です。
''' このプロジェクトを、本体とプラグインの両方が参照します。
''' </summary>
Public Interface IPlugin
    ''' <summary>
    ''' プラグインの表示名(メニューなどに使用)
    ''' </summary>
    ReadOnly Property PluginName As String

    ''' <summary>
    ''' プラグインが提供するUI要素(WPFのコントロール)
    ''' </summary>
    ReadOnly Property PluginView As System.Windows.FrameworkElement

    ''' <summary>
    ''' プラグインが初期化される時に呼ばれるメソッド
    ''' </summary>
    Sub Initialize()
End Interface

ここがポイント!
`PluginView` の型を `FrameworkElement` にしている点に注目してください。これにより、プラグイン側が「UserControl」を作ろうが「Button」を作ろうが、本体側は「WPFの部品であること」さえ分かれば、受け入れることができるのです。

3. プラグインの実装:新しい機能の具現化

次に、実際に機能を持つ「部品」を作ります。新しいクラスライブラリ・プロジェクト(例:`MySystem.Plugin.Sample`)を作成し、先ほどの `Core` を参照します。

ここでは、WPFの `UserControl` を使って、ちょっとした計算機能を持つプラグインを作ってみましょう。

PluginView.xaml (UserControl)

<UserControl x:Class="PluginView"
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             Height="100" Width="200">
    <StackPanel VerticalAlignment="Center">
        <TextBlock Text="サンプルプラグイン" HorizontalAlignment="Center" FontWeight="Bold"/>
        <Button x:Name="btnHello" Content="挨拶する" Margin="5" Click="btnHello_Click"/>
    </StackPanel>
</UserControl>

PluginImplementation.vb (クラス本体)

Imports System.Windows
Imports MySystem.Core

''' <summary>
''' 実際に動作するプラグインの実体です。
''' </summary>
Public Class PluginImplementation
    Implements IPlugin

    ' インターフェースの実装
    Public ReadOnly Property PluginName As String Implements IPlugin.PluginName
        Get
            Return "挨拶プラグイン"
        End Get
    End Property

    Public ReadOnly Property PluginView As FrameworkElement Implements IPlugin.PluginView
        Get
            ' 作成したUserControlのインスタンスを返す
            Return New PluginView()
        End Get
    End Property

    Public Sub Initialize() Implements IPlugin.Initialize
        ' 初期化処理が必要ならここに記述
        Debug.WriteLine("プラグインが起動しました。")
    End Sub
End Class

4. ホストの魔法:Assembly.LoadFrom による動的ロード

いよいよ、本体(WPFアプリケーション)の実装です。ここが最もテクニカルな部分です。
本体は、起動時に特定のフォルダ(例:`./Plugins`)をスキャンし、中にあるDLLを読み込みます。

Imports System.IO
Imports System.Reflection
Imports MySystem.Core

Public Class MainWindow
    ' 読み込まれたプラグインを保持するリスト
    Private _loadedPlugins As New List(Of IPlugin)()

    ''' <summary>
    ''' 指定されたフォルダ内のDLLをスキャンしてプラグインを読み込みます。
    ''' </summary>
    <System.Windows.Threading.DispatcherTimer.Tick> ' ※実際はボタンクリック等で呼び出し
    Private Sub LoadPlugins(ByVal folderPath As String)
        If Not Directory.Exists(folderPath) Then
            Directory.CreateDirectory(folderPath)
            Return
        End If

        ' フォルダ内のすべてのDLLファイルを取得
        Dim dllFiles = Directory.GetFiles(folderPath, "*.dll")

        For Each dllPath In dllFiles
            Try
                ' 【重要】Assembly.LoadFrom でDLLをメモリにロードする
                Dim assembly As Assembly = Assembly.LoadFrom(dllPath)

                ' DLLの中から IPlugin インターフェースを実装しているクラスを探す
                Dim pluginTypes = assembly.GetTypes().
                    Where(Function(t) TypeOf GetInterface(t, GetType(IPlugin)) IsNot Nothing AndAlso Not t.IsInterface AndAlso Not t.IsAbstract)

                For Each t In pluginTypes
                    ' クラスのインスタンスを作成
                    Dim pluginInstance As IPlugin = DirectCast(Activator.CreateInstance(t), IPlugin)
                    
                    ' 初期化してリストに追加
                    pluginInstance.Initialize()
                    _loadedPlugins.Add(pluginInstance)

                    ' UI(メニューなど)に反映させる処理をここに書く
                    AddPluginToUI(pluginInstance)
                Next

            Catch ex As Exception
                ' 読み込み失敗(依存関係不足など)はログに記録して続行
                Debug.WriteLine($"エラー: {dllPath} の読み込みに失敗しました。 {ex.Message}")
            End Try
        Next
    End Sub

    Private Sub AddPluginToUI(plugin As IPlugin)
        ' 例:左側のリストボックスに名前を追加し、クリックで画面表示
        ' ここでは簡略化のため、メインのContentエリアに直接表示します
        Me.Content = plugin.PluginView
    End Sub
End Class

コードの解説:リフレクションの深淵

ここで使っている `Assembly.LoadFrom` と `Activator.CreateInstance` は、「リフレクション」と呼ばれる技術です。
通常のプログラミングでは、`Dim p = New MyPlugin()` と書きますが、これでは「本体がプラグインの存在を知っている」ことになり、拡張性がありません。
リフレクションを使うことで、「名前も中身も知らないけれど、とにかく DLL を開いて、中にある『IPlugin』というルールを守っている奴を捕まえてこい!」という命令が可能になるのです。

5. 陥りやすい落とし穴(プロの警告)

この手法は強力ですが、設計を誤るとシステムを崩壊させます。以下の3点は必ず覚えておいてください。

1. 依存関係の地獄 (Dependency Hell)
プラグインが「独自のDLL」に依存している場合、そのDLLも同じフォルダに置いておく必要があります。また、本体とプラグインで「同じライブラリのバージョンが違う」と、実行時に謎のエラー(`FileLoadException`)が発生します。「共通ライブラリは必ず一つのプロジェクト(Core)にまとめる」のが鉄則です。

2. メモリリークとライフサイクル
`Assembly.LoadFrom` で読み込んだDLLは、一度ロードすると、そのプロセスが終了するまでメモリから消せません(アンロードが非常に困難です)。プラグインを頻繁に入れ替える必要がある場合は、`AssemblyLoadContext`(.NET Core / .NET 5+ の場合)などのより高度な仕組みを検討する必要があります。

3. 例外の連鎖
プラグインの中でエラー(例外)が発生したとき、それを適切に `Try…Catch` していないと、プラグインのバグ一つで本体(メインシステム)まで巻き添えでクラッシュします。 プラグインの実行は常に「信頼できないもの」として、防壁を築いておきましょう。

最後に:ここをクリアすれば、あなたはもう「開発者」です

いかがでしたでしょうか?
「インターフェースで契約を結び、リフレクションで動的に呼び出す」。
この仕組みを理解し、実装できるようになれば、あなたが作れるシステムの規模と柔軟性は、マクロの世界とは比較にならないほど広大なものになります。

最初は難しく感じるかもしれません。でも、大丈夫です。
「ルール(Interface)を決めること」と「そのルールに従うこと」の二点に集中して、少しずつコードを書いてみてください。

ここをクリアすれば、Visual Basic (VB.NET) の設計思想の基本はバッチリですよ。応援しています!

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