【上級】Visioアドイン開発:ステンシル管理クラスの設計とメモリリーク対策
こんにちは。Visioでの自動化、楽しんでいますか?
「マクロの記録」を使って、やりたいことが形になる瞬間の喜びは、プログラミングの原点ですよね。でも、もしあなたが「もっと複雑なツールを作りたい」「Visioのアドインとして、ずっと裏側で動き続けるような堅牢な仕組みを作りたい」と考えているなら、今こそ「マクロの記録」という安全な遊び場を卒業する時です。
今日は、プロフェッショナルな開発者が必ず直面する、しかし初学者が最も気づきにくい「恐ろしい落とし穴」についてお話しします。それは、ステンシル(Stencil)操作におけるメモリリークです。
ここをクリアすれば、あなたの作るツールは「動けばいいツール」から「プロが使う信頼のツール」へと進化しますよ。準備はいいですか?
1. なぜ「マクロの記録」では足りないのか?
マクロの記録は、あなたが操作した手順を忠実にコード化してくれます。例えば、ステンシルを開いてシェイプを配置する操作。記録されたコードは、おそらくこんな感じでしょう。
' マクロの記録による典型的なコード
ActiveDocument.Application.Documents.OpenEx "MyStencil.vssx", visOpenDocked
Set myStencil = ActiveDocument.Application.Documents("MyStencil.vssx")
' ... 何かの操作 ...
これ自体は間違いではありません。しかし、このコードを「アドイン(常に起動しているプログラム)」の中で、何度も何度も繰り返すとどうなるでしょうか?
Visioは非常に強力なアプリケーションですが、同時に「オブジェクトの管理」が非常にシビアです。ステンシルを開き、使い、そして放置する……。この「放置」が積み重なると、Visioのメモリ使用量は膨れ上がり、最終的には「Visioが重くなる」「突然落ちる」「ファイルが保存できなくなる」といった、原因不明のトラブルを引き起こします。
これが、プロの世界で避けなければならないメモリリークの正体です。
2. メモリリークの正体:COMオブジェクトの「参照カウント」
Visio VBAが操作しているのは、実はVBAそのものではなく、COM (Component Object Model) というWindowsの技術です。
ステンシルやマスターシェイプは、このCOMの世界の住人です。COMオブジェクトには「参照カウント」という仕組みがあります。
- あなたが `Set myStencil = …` と書いた瞬間、参照カウントが +1 されます。
- Visioは「あ、誰かがこのステンシルを使っているな。勝手に消しちゃダメだ」と判断します。
- あなたが使い終わった後、明示的に「もう使いません」と伝えない限り、参照カウントは 1 のまま残ります。
「使い終わったのに、参照カウントが 0 にならない」。これがメモリリークのメカニズムです。ステンシルがメモリに居座り続けると、その中にあるマスターシェイプ、さらにはシェイプの定義データまでもが、メモリを占有し続けてしまうのです。
3. 解決策:ステンシル管理クラス(Manager Class)の設計
では、どうすればいいのか? 答えはシンプルです。
「ステンシルを開く・使う・閉じる」という一連のライフサイクルを、一つの専用クラスに閉じ込める(カプセル化する)ことです。
単なる関数ではなく、「管理責任を持つクラス」を作るのです。
設計のポイント
1. プライベート変数での保持: ステンシルオブジェクトをクラスの内部に隠します。
2. 確実な破棄(Dispose): クラスが役割を終えたときに、確実に参照を解放するメソッドを用意します。
3. エラーハンドリング: ステンシルが開けなかった場合でも、中途半端な状態を残さないようにします。
4. 実装例:堅牢な `clsStencilManager`
それでは、実際に使えるコードを見てみましょう。VBAのエディタで、新しいクラスモジュールを作成し、名前を `clsStencilManager` に変更してください。
クラスモジュール: `clsStencilManager`
Option Explicit
' =================================================================
' クラス名: clsStencilManager
' 目的: ステンシルのライフサイクル(開く・使う・閉じる)を一元管理し、
' メモリリークを防止する。
' =================================================================
Private pStencil As Visio.Stencil ' ステンシル本体への参照
Private pStencilPath As String ' ステンシルのパス
' --- 初期化メソッド ---
' ステンシルを読み込み、ドッキング状態にする
Public Function Load(ByVal stencilPath As String) As Boolean
On Error GoTo ErrorHandler
pStencilPath = stencilPath
Dim vApp As Visio.Application
Set vApp = Visio.Application
' すでに同じステンシルが開いていないかチェック(二重開き防止)
Dim doc As Visio.Document
For Each doc In vApp.Documents
If doc.Name = pStencilPath Then
Set pStencil = doc.Stencil
Load = True
Exit Function
End If
Next doc
' ステンシルを開く(Docked状態で開くのが一般的)
Dim openedDoc As Visio.Document
Set openedDoc = vApp.Documents.OpenEx(pStencilPath, visOpenDocked)
' ステンシルオブジェクトとして保持
Set pStencil = openedDoc.Stencil
Load = True
Exit Function
ErrorHandler:
Debug.Print "Error in Load: " & Err.Description
Load = False
End Function
' --- マスター取得メソッド ---
' 指定した名前のマスターシェイプを安全に取得する
Public Function GetMaster(ByVal masterName As String) As Visio.Master
On Error Resume Next
If pStencil Is Nothing Then
Set GetMaster = Nothing
Exit Function
End If
' ステンシル内のマスターを返す
Set GetMaster = pStencil.Masters.Item(masterName)
On Error GoTo 0
End Function
' --- 解放メソッド(最重要!) ---
' 参照をクリアし、メモリリークを防ぐ
Public Sub Dispose()
On Error Resume Next
' 1. まずマスターなどの子オブジェクトの参照を切る必要があるが、
' 基本的には親であるStencilの参照をNothingにすることで
' 参照カウントを減らす。
If Not pStencil Is Nothing Then
' ステンシルがドッキングされている場合、閉じたいなら以下を検討
' pStencil.Document.Close
Set pStencil = Nothing
End If
pStencilPath = ""
Debug.Print "Stencil Manager: Resources released."
End Sub
' --- デストラクタ的な役割 ---
' クラスが破棄される際に、念のため解放を試みる
Private Sub Class_Terminate()
Dispose
End Sub
標準モジュールでの使用例
次に、このクラスを実際にどう使うかを見てみましょう。
Option Explicit
' =================================================================
' 標準モジュールでの実行例
' =================================================================
Sub ProfessionalStencilUsage()
Dim mgr As clsStencilManager
Set mgr = New clsStencilManager
Dim targetMaster As Visio.Master
Dim stencilPath As String
' 使用するステンシルのパスを指定
stencilPath = "Basic_Shapes.vssx" ' 環境に合わせて変更してください
Debug.Print "--- プロセス開始 ---"
' 1. ステンシルの読み込み
If mgr.Load(stencilPath) Then
Debug.Print "ステンシルの読み込みに成功しました。"
' 2. マスターシェイプの取得
Set targetMaster = mgr.GetMaster("Rectangle")
If Not targetMaster Is Nothing Then
Debug.Print "マスター 'Rectangle' を取得しました。"
' ここでシェイプの配置などの処理を行う...
Else
Debug.Print "マスターが見つかりませんでした。"
End If
Else
Debug.Print "ステンシルの読み込みに失敗しました。"
End If
' 3. 【極めて重要】使い終わったら必ずDisposeを呼ぶ
' これにより、参照カウントが適切に処理される
mgr.Dispose
Set mgr = Nothing
Debug.Print "--- プロセス終了 ---"
End Sub
5. まとめ:エンジニアとしての視点
いかがでしたか?
「ただ `Open` して `Set` するだけ」のコードと、今回のような「クラスで管理する」コード。一見すると、後者の方が手間がかかっているように見えるかもしれません。
しかし、以下の違いを理解していれば、どちらが「プロの仕事」かは明白です。
- 初心者: 「動いた!よし、次へ行こう」 $\rightarrow$ 数日後にVisioがクラッシュする。
- プロ: 「このオブジェクトの寿命はどこまでか? 確実に解放できるか?」 $\rightarrow$ 数ヶ月間、安定して動き続ける。
今回の学びのポイント
1. COMの参照カウントを意識すること。
2. オブジェクトのライフサイクル(生成 $\rightarrow$ 利用 $\rightarrow$ 破棄)を設計すること。
3. 管理クラス(Manager Class)を作り、`Dispose` メソッドで確実に後始末をすること。
ここをクリアすれば、あなたのVisio VBAスキルは一段上のステージに上がります。ぜひ、自分のプロジェクトにこの設計を取り入れてみてください。応援していますよ!
