【実務・中級編】【上級】Visioアドイン開発:ステンシル管理クラスの設計とメモリリーク対策 – Visio VBA解析バイブル

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

Beyond the Script: Visio COMアドインにおけるステンシル管理の極意 —— メモリリークとリソースロックを根絶する設計論

プロフェッショナルな業務自動化の世界において、「動くコード」を書くことは最低条件に過ぎない。我々のようなアーキテクトに求められるのは、「数時間、あるいは数日間、バックグラウンドで稼働し続けても、決してリソースを食いつぶさず、ファイルロックによる致命的なエラーを引き起こさない堅牢なシステム」を設計することだ。

特にVisioのCOMアドインや大規模なVBAツール開発において、多くの開発者が陥る罠がある。それが「ステンシル(Stencil)とマスターシェイプ(Master)のライフサイクル管理」の失敗だ。

本記事では、単なるオブジェクト操作の解説は一切行わない。ステンシル操作におけるメモリリークのメカニズムを解明し、プロダクション環境に耐えうる「ステンシル管理クラス」の設計思想を伝授する。

1. なぜあなたのコードは「ゾンビ・オブジェクト」を生むのか

Visio VBAにおける`Document`(ステンシル)や`Master`オブジェクトは、背後でCOM(Component Object Model)リソースを消費している。

一般的なプログラマはこう書く。

' 典型的な「悪い」例
Sub BadExample()
    Dim stencil As Visio.Document
    Set stencil = Visio.Documents.Open("C:\Templates\MyStencil.vssx")
    ' 何らかの処理...
    ' 関数が終われば消えるだろう、という甘い期待
End Sub

このコードには、致命的な欠陥が2つある。

第一の欠陥:参照カウントの不備

VBAの変数がスコープを抜けても、COMオブジェクトの参照カウントがゼロにならないケースがある。特に、エラーハンドリングが不適切であったり、オブジェクトを他のコレクションに格納したままにしたりすると、メモリ上に「実体のない幽霊(ゾンビ・オブジェクト)」が残り続ける。これが累積し、アドインのメモリ使用量が膨張していく。

第二の欠陥:ファイルロックの残留

これが実務上最も厄介だ。ステンシルを`Open`した際、そのオブジェクトがメモリに居座り続けると、OSレベルでファイルが「使用中」としてロックされる。その結果、次にプログラムが同じファイルを更新しようとした際、あるいはユーザーが手動でファイルを移動・削除しようとした際に、「ファイルは別のプロセスによって使用されているため、操作を完了できません」という、自動化の命取りとなるエラーが噴出するのだ。

2. 堅牢な設計思想:ステンシル・マネージャー・パターンの採用

これらの問題を回避するためには、個別のプロシージャで直接ステンシルを操作してはならない。「ステンシル管理専用のクラス(Manager Class)」を導入し、オブジェクトの生成から破棄までを一元管理する設計を採用すべきだ。

設計の要諦は以下の3点である。

1. カプセル化: ステンシルオブジェクトへの直接アクセスを禁止し、マネージャー経由でのみ操作させる。
2. 決定論的な破棄 (Deterministic Cleanup): `Class_Terminate` を活用し、クラスが破棄される瞬間に確実にリソースを解放する。
3. エラー耐性: 予期せぬエラーが発生しても、必ず `Close` プロセスを通るようにガードを固める。

3. 実装例:`clsStencilManager` クラス

以下に、プロダクションレベルで使用可能なステンシル管理クラスの設計例を示す。これをクラスモジュールとして実装せよ。

' Class Module: clsStencilManager
Option Explicit

' 内部保持するステンシルコレクション(複数のステンシルを管理可能にする)
Private pStencils As Collection
Private pApplication As Visio.Application

' 初期化
Private Sub Class_Initialize()
    Set pStencils = New Collection
    Set pApplication = Visio.Application
End Sub

' ステンシルのロード
' @param filePath: ステンシルのフルパス
' @return: 成功すればDocumentオブジェクト、失敗すればNothing
Public Function LoadStencil(ByVal filePath As String) As Visio.Document
    Dim doc As Visio.Document
    
    On Error GoTo ErrorHandler
    
    ' すでに開いているかチェックするロジックをここに入れるのがプロの仕事だ
    ' 今回は簡略化のため直接Openを行う
    Set doc = pApplication.Documents.Open(filePath)
    
    ' 管理用コレクションに追加
    pStencils.Add doc, filePath
    
    Set LoadStencil = doc
    Exit Function

ErrorHandler:
    Debug.Print "Error loading stencil: " & filePath & " - " & Err.Description
    Set LoadStencil = Nothing
End Function

' マスターシェイプの取得
' @param stencilPath: ステンシルのパス
' @param masterName: マスターの名前
Public Function GetMaster(ByVal stencilPath As String, ByVal masterName As String) As Visio.Master
    Dim doc As Visio.Document
    Dim master As Visio.Master
    
    On Error GoTo ErrorHandler
    
    ' 管理下のコレクションからドキュメントを探す
    Set doc = pStencils(stencilPath)
    Set master = doc.Masters(masterName)
    
    Set GetMaster = master
    Exit Function

ErrorHandler:
    Set GetMaster = Nothing
End Function

' すべてのステンシルを安全に閉じる(メモリ解放の核心)
Public Sub DisposeAll()
    Dim i As Long
    Dim doc As Visio.Document
    
    On Error Resume Next ' クリーンアップ中のエラーは無視して進める
    
    ' コレクションを逆順に回してクローズしていく
    For i = pStencils.Count To 1 Step -1
        Set doc = pStencils(i)
        If Not doc Is Nothing Then
            ' ファイルを保存せずに閉じる(要件に応じてSave trueに変更せよ)
            doc.Close
            Set doc = Nothing
        End If
        pStencils.Remove i
    Next i
    
    Set pStencils = Nothing
    Debug.Print "All stencils have been disposed safely."
End Sub

' クラスが破棄される際に自動的に実行される
Private Sub Class_Terminate()
    ' 開発者がDisposeAllを呼び忘れても、メモリリークを防ぐための最終防衛ライン
    Call DisposeAll
End Sub

標準モジュールからの呼び出し例

' Standard Module
Option Explicit

Sub ProfessionalAutomationProcess()
    ' マネージャーのインスタンス化
    Dim stencilMgr As clsStencilManager
    Set stencilMgr = New clsStencilManager
    
    Dim targetStencil As String
    targetStencil = "C:\Templates\NetworkShapes.vssx"
    
    ' 1. ステンシルをロード
    Dim doc As Visio.Document
    Set doc = stencilMgr.LoadStencil(targetStencil)
    
    If doc Is Nothing Then
        MsgBox "ステンシルの読み込みに失敗しました。パスを確認してください。", vbCritical
        Exit Sub
    End If
    
    ' 2. マスターシェイプを取得して描画
    Dim master As Visio.Master
    Set master = stencilMgr.GetMaster(targetStencil, "Router")
    
    If Not master Is Nothing Then
        ' ページに対してマスターをドロップする処理
        ActivePage.Drop master, 1, 1
    Else
        MsgBox "マスターが見つかりません。", vbExclamation
    End If

    ' 3. 後処理
    ' スコープを抜ける際にClass_Terminateが走り、DisposeAllが実行される。
    ' ただし、明示的に呼ぶのが最も確実で、リソース解放のタイミングを制御できる。
    stencilMgr.DisposeAll
    Set stencilMgr = Nothing
End Sub

4. アーキテクトからのアドバイス:データベース・ファイル連携における注意点

もし、あなたのツールがデータベース(SQL ServerやAccess)から形状情報を取得し、それをステンシル経由で描画するような高度なもの(例:インフラ構成図の自動生成)である場合、以下のルールを徹底せよ。

1. Transactionの分離: データベースのトランザクションとVisioの操作を同一のスコープに混ぜるな。Visioの操作(特にファイルI/O)はデータベースのトランザクションに比べて極めて遅い。Visioの操作中にDBロックを保持し続けると、システム全体のデッドロックを引き起こす。
2. 読み込み専用モードの活用: ステンシルがテンプレートとしてのみ使用される場合、可能な限り `ReadOnly` モードで開く設計にせよ。これにより、書き込み権限エラーによる例外を回避できる。
3. パスの正規化: ステンシルのパスを扱う際は、常に `FileSystemObject` 等を用いて絶対パスに変換し、相対パスによる「見失い」を防げ。

結論

Visio VBAにおける「プロフェッショナル」とは、単に複雑なロジックを書ける者のことではない。リソースのライフサイクルを完全に支配し、システムの予測可能性を担保できる者のことだ。

今回提示した `clsStencilManager` のような管理クラスをテンプレートとして持ち、あらゆる自動化プロジェクトの基盤とせよ。それが、バグのない、そして信頼されるエンジニアへの第一歩である。

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