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

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

密結合という名の「技術的負債」を断て:VBScriptによる動的プラグイン機構の設計思想

業務自動化の現場において、多くのエンジニアが陥る致命的な罠がある。それは、「一つの巨大なスクリプトファイル(God Script)に、すべてのロジックを詰め込む」という設計ミスだ。

要件が変わるたびに、数百、数千行のコードの隙間に、条件分岐(If-Then-Else)を継ぎ足していく。その結果、コードはスパゲッティ化し、一箇所の修正が予期せぬ場所でバグを引き起こす。これが「技術的負債」の正体である。

真にプロフェッショナルなツールとは、「本体(Core)は変化せず、機能(Plugin)を追加・削除するだけで振る舞いを変えられる」設計を持たねばならない。

本稿では、VBScriptの極めて限定的な機能である `FileSystemObject` と `Execute` メソッドを組み合わせ、疎結合な「プラグインアーキテクチャ」を構築するための、極限の知見を伝授する。

1. アーキテクチャの根幹:なぜ `Execute` なのか?

VBScriptには、JavaやC#のような動的なクラスロード機構は存在しない。しかし、我々には `Execute` メソッドという「禁断の果実」がある。

`Execute` メソッドは、文字列として渡されたスクリプトコードを、現在の実行コンテキスト内で即座に評価・実行する。これを利用すれば、外部ファイルに記述された関数やサブプロシージャを、あたかもメインスクリプト内に最初から記述されていたかのように呼び出すことが可能になる。

設計の三原則

1. 発見 (Discovery): `FileSystemObject` を使い、特定のディレクトリ内にある `.vbs` ファイルを走査する。
2. 注入 (Injection): `Execute` を使い、ファイルの内容をメモリ上の実行コンテキストへ展開する。
3. 規約 (Convention): プラグイン側には「特定の名前を持つ関数」を実装させる。これがインターフェースの代わりとなる。

2. 致命的な落とし穴:名前空間の汚染とスコープ

`Execute` メソッドを使用する際、初心者が必ず犯すミスがある。それは「名前空間(Namespace)の衝突」だ。

`Execute` で読み込まれたコードは、メインスクリプトと同じスコープに展開される。もしプラグイン内で `Dim strPath` と宣言し、メインスクリプトでも `Dim strPath` を使っていた場合、実行時に「名前が重複しています」というエラーで即死する。

これを回避するための「鉄の掟」:

  • プラグイン内での変数宣言(Dim)を極限まで避けること。
  • 変数はすべて、プラグインの「引数」として渡されるコンテキストオブジェクト(Dictionary等)に格納すること。
  • プラグインのロジックは、必ず関数(Function)またはサブプロシージャ(Sub)の中にカプセル化すること。

3. 実装:プロダクション・グレードのプラグイン・エンジン

以下に、そのまま実務に投入できるレベルの、堅牢なメインスクリプトの設計例を示す。

【メインスクリプト】 `MainEngine.vbs`

' ==============================================================================
' Module: MainEngine.vbs
' Description: プラグインを動的にロードして実行するコアエンジン
' Author: Legendary Chief Architect
' ==============================================================================
Option Explicit

' 定数定義
Const PLUGIN_DIR = ".\plugins\"
Const PLUGIN_EXT = ".vbs"

' メイン処理
Call Main()

Sub Main()
    Dim fso, pluginFolder, pluginFile
    Dim pluginContent, pluginContext
    Dim errMessage

    Set fso = CreateObject("Scripting.FileSystemObject")

    ' 1. プラグインディレクトリの存在確認
    If Not fso.FolderExists(PLUGIN_DIR) Then
        fso.CreateFolder(PLUGIN_DIR)
    End If

    Set pluginFolder = fso.GetFolder(PLUGIN_DIR)

    WScript.Echo "--- Automation Engine Started ---"

    ' 2. プラグインの走査
    For Each pluginFile In pluginFolder.Files
        If LCase(fso.GetExtensionName(pluginFile.Name)) = "vbs" Then
            
            WScript.Echo "Loading Plugin: " & pluginFile.Name

            ' エラーハンドリング:プラグイン単体の失敗が全体を止めないようにする
            On Error Resume Next
            
            ' 3. ファイル内容の読み込み
            pluginContent = fso.OpenTextFile(pluginFile.Path, 1).ReadAll
            
            ' 4. コードの注入 (Execute)
            ' 注意: Executeにより、プラグイン内の関数が現在のスコープに展開される
            Execute(pluginContent)

            ' 5. プラグインの実行(規約に基づき "RunPlugin" を呼び出す)
            ' 引数としてコンテキスト(Dictionary)を渡すことで、変数の衝突を防ぐ
            Set pluginContext = CreateObject("Scripting.Dictionary")
            pluginContext.Add "PluginName", pluginFile.Name
            pluginContext.Add "Timestamp", Now()

            ' 【重要】プラグインのインターフェース呼び出し
            Call RunPlugin(pluginContext)

            ' 6. エラーチェック
            If Err.Number <> 0 Then
                errMessage = Err.Description
                Err.Clear
                WScript.Echo " [ERROR] Plugin '" & pluginFile.Name & "' failed: " & errMessage
            Else
                WScript.Echo " [SUCCESS] Plugin '" & pluginFile.Name & "' completed."
            End If
            
            On Error GoTo 0 ' エラーハンドリングを元に戻す
        End If
    Next

    WScript.Echo "--- All Tasks Completed ---"
    Set fso = Nothing
End Sub

【プラグイン例】 `plugins\LogModule.vbs`

' ==============================================================================
' Module: LogModule.vbs (Plugin)
' Description: 実行ログをテキストファイルに出力する機能
' Requirement: MainEngineから "RunPlugin(context)" を呼び出されること
' ==============================================================================
Option Explicit

' プラグインのメインエントリポイント
' 引数 context: Scripting.Dictionary オブジェクト
Sub RunPlugin(context)
    ' 変数宣言は最小限にし、context経由でデータをやり取りする
    Dim logMsg, fso, logFile
    Set fso = CreateObject("Scripting.FileSystemObject")
    
    logMsg = "[" & context("Timestamp") & "] Plugin: " & context("PluginName") & " executed."
    
    ' ログファイルへの書き出し(実務ではパスをcontext経由で受け取るとより良い)
    Set logFile = fso.OpenTextFile("execution_log.txt", 8, True)
    logFile.WriteLine logMsg
    logFile.Close
    
    Set fso = Nothing
End Sub

4. 運用における極限の注意点

このアーキテクチャを実運用(プロダクション)に投入する場合、以下の3点を必ず考慮せよ。

① データベース連携時のトランザクション管理

プラグイン内でデータベース(ADO等)を操作する場合、メインエンジン側でトランザクションを制御するのは困難だ。各プラグインは「自身の操作は自身の責任で完結させる(Atomicな操作)」、あるいは「コンテキスト経由でConnectionオブジェクトを共有し、呼び出し元でCommit/Rollbackを行う」といった、明確な設計指針が必要になる。

② セキュリティ・リスクの認識

`Execute` は、渡された文字列を「何でも」実行する。もし `plugins` フォルダに悪意のあるスクリプトが置かれた場合、システムは全権限を奪われる。

  • 対策: プラグインフォルダのアクセス権限(ACL)を厳格に管理し、実行ユーザー以外が書き込みできないように設定せよ。

③ パフォーマンスの重み

`Execute` は実行時にスクリプトを解析するため、ループ内で頻繁に呼び出すとオーバーヘッドが生じる。しかし、業務自動化ツールの性質上、多くの場合「ファイル走査 > スクリプト解析」のコストであるため、実用上の問題になることは稀だ。ただし、数千個のプラグインをロードするような設計は避けるべきである。

結論

「すべてを一つのファイルに書く」という誘惑に打ち勝て。
`FileSystemObject` による発見と `Execute` による注入、そして「関数名による規約」を用いた疎結合な設計。これこそが、VBScriptという制約の多い言語において、メンテナンス性と拡張性を両立させる唯一の道である。

優れたエンジニアは、コードを書く時間よりも、「コードがどう変化するか」を考える時間に比重を置くものである。

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