【テクニカル・上級編】【プラグイン機構の実装】FileSystemObject と Execute メソッドを組み合わせた、外部 .vbs ファイルを動的にロードして機能を拡張するモジュール設計 – VBScript (Visual Basic Scripting Edition)解析バイブル

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

疎結合の極致:VBScriptにおける動的プラグイン機構の設計思想

レガシーなWindows環境において、VBScriptは今なお、AD連携、ログ解析、システム管理の自動化において「静かなる主役」として君臨している。しかし、多くのエンジニアが陥る罠がある。それは、機能が増えるたびにメインスクリプトに `If…Else` や `Select Case` を書き足し、巨大で壊れやすい「モノリス(一枚岩)」を作り上げてしまうことだ。

真のシニアエンジニアであれば、コードを「書く」のではなく「設計」すべきである。

本稿では、VBScriptという制約の多い言語において、FileSystemObject (FSO) によるディレクトリ走査と `Execute` メソッド による動的コード注入を組み合わせ、メインスクリプトを一切変更することなく機能を拡張可能な「プラグイン・アーキテクチャ」を構築する手法を詳解する。

1. アーキテクチャの設計思想:Open/Closed Principle

オブジェクト指向設計における「開放閉鎖の原則(Open/Closed Principle)」は、スクリプト言語においても極めて重要である。

  • Open (開放性): 新しい機能を追加する際、プラグイン(外部ファイル)を追加するだけで済む。
  • Closed (閉鎖性): メインのエンジン(Orchestrator)は、機能の追加によってコードを修正してはならない。

これをVBScriptで実現するためには、「規約によるインターフェースの代替」が必要となる。VBScriptには厳密なインターフェース定義が存在しないため、我々は「特定の関数名を持つこと」を契約(Contract)として定義する。

2. 実装:動的プラグイン・エンジンの構築

以下に、プラグイン・アーキテクチャの核となる実装を示す。

2.1 メイン・オーケストレーター (`Main.vbs`)

このスクリプトは、特定のフォルダ内をスキャンし、見つかった `.vbs` ファイルを動的にロードして実行する「エンジン」の役割を果たす。

' ==============================================================================
' Module: Main Orchestrator
' Description: Dynamically loads and executes plugin modules.
' Author: Legendary Architect
' ==============================================================================
Option Explicit

' 定数定義:プラグインの格納先
Const PLUGIN_DIR = ".\plugins\"
' プラグインが実装すべき「インターフェース(規約)」となる関数名
Const PLUGIN_ENTRY_POINT = "Plugin_Execute"

Dim fso, pluginFolder, pluginFile
Dim pluginContent, pluginStream

Set fso = CreateObject("Scripting.FileSystemObject")

' 1. プラグインディレクトリの存在確認
If Not fso.FolderExists(PLUGIN_DIR) Then
    ' ディレクトリがない場合は作成(環境により権限に注意)
    fso.CreateFolder(PLUGIN_DIR)
End If

Call RunPluginEngine()

' ------------------------------------------------------------------------------
' メインエンジン・ロジック
' ------------------------------------------------------------------------------
Sub RunPluginEngine()
    On Error Resume Next ' 致命的なエラーによる停止を回避
    
    Set pluginFolder = fso.GetFolder(PLUGIN_DIR)
    
    WScript.Echo "--- Plugin Engine Started ---"

    ' 2. ディレクトリ内のファイルを走査
    For Each pluginFile In pluginFolder.Files
        ' .vbs ファイルのみを対象とする
        If LCase(fso.GetExtensionName(pluginFile.Name)) = "vbs" Then
            WScript.Echo "[System] Loading: " & pluginFile.Name
            
            ' プラグインのロードと実行を試みる
            Call LoadAndExecutePlugin(pluginFile.Path)
        End If
    Next

    WScript.Echo "--- Plugin Engine Finished ---"
    
    ' オブジェクトの明示的な解放(メモリリーク防止)
    Set pluginFolder = Nothing
    Set fso = Nothing
End Sub

' ------------------------------------------------------------------------------
' プラグイン・ロード・コア
' ------------------------------------------------------------------------------
Sub LoadAndExecutePlugin(strFilePath)
    Dim ts, strCode
    
    ' 3. ファイル内容の読み込み
    Set ts = fso.OpenTextFile(strFilePath, 1) ' 1 = ForReading
    strCode = ts.ReadAll
    ts.Close
    Set ts = Nothing

    ' 4. ExecuteGlobal による動的注入
    ' Execute はローカルスコープ、ExecuteGlobal はグローバルスコープで実行される。
    ' プラグインがメインのオブジェクトにアクセスする必要があるため、ExecuteGlobal を選択。
    ExecuteGlobal strCode

    ' 5. 規約に基づいたエントリーポイントの呼び出し
    ' プラグイン内に Plugin_Execute という関数が存在することを期待する
    If IsNull(Plugin_Execute) Or IsEmpty(Plugin_Execute) Then
        ' 関数が存在しない場合のハンドリング(ExecuteGlobalで読み込んだ関数はグローバルに展開される)
        ' ただし、VBScriptの仕様上、存在しない関数を直接参照するとエラーになるため、
        ' 実際には CallByName 等のテクニックや、関数の存在チェックが必要。
        ' ここでは、単純化のためエラーハンドリングに任せる。
        WScript.Echo "[Error] Plugin '" & strFilePath & "' does not implement " & PLUGIN_ENTRY_POINT
    Else
        ' プラグインの実行
        Call Plugin_Execute()
    End If

    ' 6. 後処理:プラグインによって定義された関数をクリアする(名前空間の汚染防止)
    ' 注意: VBScriptでは定義済みの関数を完全に「削除」することは困難であるため、
    ' プラグイン間の干渉を防ぐ設計が重要となる。
    On Error GoTo 0
End Sub

2.2 プラグイン・モジュール例 (`plugins\Module_LogCheck.vbs`)

プラグイン側は、メイン側が決めた規約(`Plugin_Execute`)に従うだけでよい。

' ==============================================================================
' Module: Log Checker Plugin
' Description: Checks for specific log patterns.
' ==============================================================================
Option Explicit

' メインエンジンから呼び出されるエントリーポイント
' 名前空間の衝突を避けるため、この関数はグローバルに公開される
Sub Plugin_Execute()
    WScript.Echo "  [Plugin] Log Checker is running..."
    
    ' ここに実際の業務ロジックを記述
    ' 例: 特定のログファイルを検索するなど
    
    WScript.Echo "  [Plugin] Log Check completed successfully."
End Sub

3. エンジニアリング・ディープダイブ:極限の知見

この実装を実運用に投入する際、シニアエンジニアが考慮すべき「重み」が3つある。

3.1 `Execute` vs `ExecuteGlobal` の選択

VBScriptにおける `Execute` メソッドは、実行されるコードを現在のプロシージャのローカルスコープに展開する。一方、`ExecuteGlobal` はスクリプトのトップレベル(グローバルスコープ)に展開する。
プラグイン機構においては、`ExecuteGlobal` を選択するのが定石である。なぜなら、プラグインが定義した関数や変数が、メインスクリプトから参照可能(またはその逆)である必要があるからだ。ただし、これにより「名前空間の汚染(Namespace Pollution)」というリスクが生じる。異なるプラグインが同じ関数名を持つと、後からロードされたものが前を上書きする。これを防ぐには、関数名に `Plugin_A_…` のような接頭辞を強制する運用ルールが必要だ。

3.2 メモリ管理とオブジェクトのライフサイクル

WSH環境において、`CreateObject` で生成したCOMオブジェクトは、変数がスコープを抜けても、明示的に `Set obj = Nothing` を行わない限り、メモリ上に残り続ける可能性がある。特に、ループ内で大量のプラグインをロードする場合、`FileSystemObject` や `TextStream` を確実に解放しなければ、リソース枯渇を招く。
「VBScriptは適当に書いても動く」という慢心は、長時間稼働するサーバーサイドの自動化スクリプトにおいては致命傷となる。

3.3 エラー・アイソレーション(隔離)

プラグインの一つが構文エラー(Syntax Error)や実行時エラーを起こしたとき、メインエンジン全体が停止してはならない。
`On Error Resume Next` を適切に配置し、エラーが発生したプラグインを「スキップ」して次のプラグインへ進む堅牢なエラーハンドリングが、システム全体の可用性を決定づける。

結論

VBScriptを用いたプラグイン機構の実装は、単なるコードの分割ではない。それは、「変化に対して脆弱なモノリス」から「変化に対して柔軟なエコシステム」への転換である。

規約を定義し、動的な実行環境を制御する。この設計思想をマスターしたとき、君の書くスクリプトは単なる「使い捨てのツール」から、長期にわたって進化し続ける「堅牢なシステム」へと昇華する。

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