【実務・中級編】【上級】Visioのステンシル読み込みを「非同期処理」で実装し、UIのフリーズを回避する – Visio VBA解析バイブル

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

Visio VBAを掌握する極限の知見:ステンシル読み込みにおける「非同期パラダイム」への転換

業務自動化の現場において、ユーザーから最も嫌われる挙動は何か?
それは、処理の成否ではなく、「ツールが応答なし(フリーズ)になること」だ。

特に、数MBを超える巨大なカスタムステンシル(.vssx)や、ネットワークドライブ上の共有ステンシルをロードする際、多くの開発者は単純に `Application.Documents.Open` を呼び出し、その完了を待つ。その結果、VisioのUIスレッドはロックされ、ユーザーは「落ちた」と判断してタスクマネージャーでプロセスを強制終了させる。これが、プロフェッショナルなツールと、単なる「マクロ」を分ける決定的な境界線だ。

本稿では、VBAの限界である「シングルスレッド・モデル」をいかにしてハックし、UIの応答性を維持したまま重いステンシル操作を実現するか。その設計思想と実装パターンを伝授する。

1. なぜ `DoEvents` は「禁忌」なのか

初心者は、ループの中で `DoEvents` を呼び出し、UIに制御を戻そうとする。

' 避けるべきアンチパターン
For Each master In stencil.Masters
    ' 何らかの重い処理
    DoEvents ' これでUIは動くが...
Next master

これは、設計レベルでは「極めて脆弱なコード」だ。`DoEvents` は、実行中のスタックを一時停止してOSに制御を戻すが、その隙にユーザーがボタンを連打したり、別のメニュー操作を行ったりすることを許容してしまう。これが「リエントランシー(再入可能性)問題」だ。

リエントランシーが発生すると、変数の状態が破壊され、予期せぬメモリリークや、最悪の場合、Visio自体のクラッシュを招く。プロフェッショナルなアーキテクトは、`DoEvents` に頼るのではなく、「状態遷移(State Machine)」による制御を選択する。

2. 設計思想:ステートマシンによる擬似非同期処理

VBA単体で真のマルチスレッドを実現することは不可能だ。しかし、「一連の重い処理を細かなタスクに分割し、一回のリクエストごとに制御を戻す」という設計パターンを用いることで、ユーザーには非同期処理のように見せかけることができる。

これを実現するためのコンポーネントは以下の3点だ。

1. Task Queue (タスクキュー): 実行すべき操作(ステンシルのロード、マスターの抽出など)を格納するリスト。
2. State Machine (状態遷移エンジン): 現在どの工程にいるかを管理するクラス。
3. Timer-based Scheduler (タイマー制御): `Application.OnTime` を活用し、一定間隔でタスクを一つずつ消化する。

3. 実装:プロダクション・クオリティの非同期ロード・エンジン

以下に、ステンシルのロードとマスターの解析を、UIをフリーズさせずに実行するためのクラスモジュール構成を示す。

Class Module: `clsAsyncStencilLoader`

このクラスは、一気に処理を行わず、タスクを「小分け」にして実行する。

' =================================================================
' Class: clsAsyncStencilLoader
' Description: ステンシルロードを分割実行し、UIフリーズを回避する
' =================================================================
Option Explicit

Private Enum TaskState
    tsIdle
    tsLoadingStencil
    tsProcessingMasters
    tsCompleted
    tsError
End Enum

Private m_State As TaskState
Private m_StencilPath As String
Private m_TargetStencil As Visio.Document
Private m_MasterIndex As Long
Private m_MasterCount As Long
Private m_CurrentMasters As Collection

' イベント通知用(呼び出し側で受取)
Public Event OnProgress(ByVal Percent As Double, ByVal Status As String)
Public Event OnComplete(ByVal Success As Boolean)

''' <summary>
''' 非同期ロードの開始
''' </summary>
Public Sub StartAsyncLoad(ByVal filePath As String)
    If Dir(filePath) = "" Then
        m_State = tsError
        Err.Raise 53, , "File not found: " & filePath
    End If
    
    m_StencilPath = filePath
    m_State = tsLoadingStencil
    m_MasterIndex = 0
    Set m_CurrentMasters = New Collection
    
    ' 初回実行をスケジュール
    ScheduleNextStep
End Sub

''' <summary>
''' 状態遷移エンジン:メインのロジック
''' </summary>
Private Sub ProcessNextStep()
    On Error GoTo ErrorHandler

    Select Case m_State
        Case tsLoadingStencil
            ' ステップ1: ステンシルのオープン(ここが最大の重み)
            ' 注意: Open自体は一瞬止まるが、その直後に制御を戻す設計にする
            Set m_TargetStencil = Visio.Documents.OpenEx(m_StencilPath, visOpenDocked)
            
            ' マスターのリストをメモリ上にキャッシュ(重いI/Oを分離)
            Dim m As Visio.Master
            For Each m In m_TargetStencil.Masters
                m_CurrentMasters.Add m
            Next m
            
            m_MasterCount = m_CurrentMasters.Count
            m_MasterIndex = 1
            m_State = tsProcessingMasters
            
            ' プログレス更新
            RaiseEvent OnProgress(10, "Stencil Loaded. Processing Masters...")
            ScheduleNextStep

        Case tsProcessingMasters
            ' ステップ2: マスターの個別処理(分割実行)
            If m_MasterIndex <= m_MasterCount Then
                ' ここで個々のマスターに対する重い処理(プロパティ解析など)を行う
                Dim currentMaster As Visio.Master
                Set currentMaster = m_CurrentMasters(m_MasterIndex)
                
                ' --- [擬似的な重い処理の代わり] ---
                Debug.Print "Processing: " & currentMaster.Name
                ' ---------------------------------
                
                m_MasterIndex = m_MasterIndex + 1
                
                ' 進捗率の計算
                Dim progress As Double
                progress = 10 + (CDbl(m_MasterIndex) / m_MasterCount * 90)
                RaiseEvent OnProgress(progress, "Analyzing: " & currentMaster.Name)
                
                ' 次のタスクを予約(ここで制御をVisioに戻す)
                ScheduleNextStep
            Else
                m_State = tsCompleted
                RaiseEvent OnComplete True
            End If

        Case tsCompleted
            m_State = tsIdle
    End Select
    
    Exit Sub

ErrorHandler:
    m_State = tsError
    RaiseEvent OnComplete False
    MsgBox "Critical Error: " & Err.Description, vbCritical
End Sub

Private Sub ScheduleNextStep()
    ' Application.OnTime を使い、1秒後に次のステップを実行する
    ' これにより、VisioのUIスレッドが「空き時間」を得る
    Application.OnTime Now + TimeValue("00:00:01"), "Module_Callback_Handler"
End Sub

' プロパティ
Public Property Get State() As TaskState: State = m_State: End Property

Standard Module: `Module_AsyncBridge`

`Application.OnTime` は標準モジュールのパブリック関数しか呼べないため、ブリッジとなるハンドラが必要だ。

' =================================================================
' Module: Module_AsyncBridge
' Description: Application.OnTime からクラスへ制御を戻すブリッジ
' =================================================================
Option Explicit

Public g_Loader As clsAsyncStencilLoader

' Application.OnTime から呼ばれる
Public Sub Module_Callback_Handler()
    If Not g_Loader Is Nothing Then
        ' クラス内部の非公開メソッドを叩くための公開用ラッパーが必要な場合は
        ' ここで処理を呼び出す。今回は設計上、クラス内のロジックを
        ' 外部から叩けるようにするか、クラスに公開メソッドを作る。
        ' ここでは簡易的に、クラスの進捗を促す仕組みとする。
        g_Loader.ExecuteNextStep ' ※クラスにこのPublicメソッドを追加しておくこと
    End If
End Sub

*(注: 実装の簡略化のため、`ExecuteNextStep` というPublicメソッドを `clsAsyncStencilLoader` 内に作成し、`ProcessNextStep` を呼び出すようにしてください)*

4. アーキテクトの視点:堅牢性を高めるための注意点

この設計を実務(プロダクション環境)に投入する際、以下の3点を必ず考慮せよ。

① 外部リソースとの競合(File/DB Lock)

ステンシルがネットワーク共有フォルダにある場合、`OpenEx` 中にネットワークが瞬断されると、ステートマシンは `tsError` に遷移する。このとき、「中途半端に開いたドキュメントを確実に閉じる(Clean up)」 ロジックを `ErrorHandler` 内に実装しなければ、次回の実行時に「ファイルが使用中です」というエラーで自滅する。

② リエントランシーの完全封殺

ユーザーが「ロード中に別のボタンを押す」ことを防ぐため、ロード中はUI上のコントロールを `Enabled = False` にするか、モーダルなプログレスバーを表示して、ユーザーの入力を物理的に遮断する設計を組み合わせることが、真のプロフェッショナルだ。

③ 真の非同期が必要な場合(VB.NET / COM Interop)

もし、ステンシルの解析自体が数分かかるような計算負荷の高いものであれば、VBAの限界を認めるべきだ。その場合は、VB.NETで「Worker Service」を作成し、COM Interop経由でVisioから呼び出す。
VB.NET側で `Task.Run` を使用してバックグラウンドスレッドで計算を行い、完了後にVisioのオブジェクトを操作する。これこそが、大規模エンタープライズ・ソリューションにおける正解である。

結論

VBAにおける「非同期」とは、スレッドを増やすことではなく、「いかに細かくタスクを切り出し、OSに制御を譲る時間を計画的に作るか」 という、時間管理の設計である。

`DoEvents` という魔法に逃げるな。ステートマシンを構築せよ。それが、ユーザーに信頼される「道具」を作る唯一の道だ。

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