【実務・中級編】【中級】ステンシル内のマスターシェイプを「XML形式」にエクスポートして差分管理する – Visio VBA解析バイブル

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

マスターシェイプを「データ」として支配せよ:XMLエクスポートによる差分管理の極意

Visioを単なる「図面作成ツール」と考えているうちは、二流のエンジニアだ。
プロフェッショナルな業務自動化エンジニアにとって、Visioは「構造化されたグラフィカル・データ・モデル」である。

特に、組織の標準化を担う「ステンシル(Stencil)」と、その構成要素である「マスターシェイプ(Master Shape)」の管理は、システム全体の整合性を左右する極めてクリティカルな領域だ。

多くの開発者が陥る罠がある。それは、ステンシルファイル(.vssx)をそのままGitやSVNなどのバージョン管理システムに放り込むことだ。バイナリ、あるいは圧縮されたOOXML形式のファイルを直接比較しても、意味のある差分(どのプロパティが、どう変わったのか)を読み取ることは不可能に近い。

本記事では、マスターシェイプの形状情報とプロパティを「意味のあるXML形式」に抽出し、テキストベースで精密な差分管理を可能にするための、堅牢な設計手法と実装コードを伝授する。

1. なぜ「XMLへの抽出」が必要なのか:設計思想の転換

なぜ、Visioの標準機能や単純なコピーではなく、独自のXMLエクスポートが必要なのか。その理由は「ノイズの排除」と「意味論的な比較(Semantic Diff)」にある。

バイナリ比較の限界

`.vssx`ファイルには、図形の座標だけでなく、レンダリング用のメタデータ、表示状態、あるいは作成日時といった「差分管理に不要な情報」が大量に含まれている。これらをそのまま比較すると、形状が全く変わっていなくても、ファイルを開いただけで膨大な差分が発生する。これは、コードレビューにおける「差分の洪水」と同じで、エンジニアの生産性を著しく低下させる。

解決策:Canonical Schema(標準スキーマ)の定義

我々が目指すべきは、マスターシェイプから「ビジネスロジックに直結するデータ」のみを抽出した、クリーンなXMLを作成することだ。

  • ShapeData(ShapeSheetのセル): 業務上のパラメータ(例:電圧、型番、容量)
  • Geometry(基本構造): 図形の中心座標や、主要な接続点(Connection Points)
  • Metadata: マスター名、カテゴリ、バージョン情報

これらをXMLとして書き出すことで、Git上で `+ ` といった、人間が直感的に理解できる差分として追跡できるようになる。

2. 堅牢な実装のためのアーキテクチャ

実装にあたって、以下の3原則を遵守せよ。これを行わないコードは、実務(プロダクション環境)ではゴミ同然だ。

1. DOM操作の徹底: 文字列連結(`str = str & “…”`)によるXML生成は、メモリ効率が悪く、エンコーディングエラーの温床となる。必ず `MSXML2.DOMDocument` を使用せよ。
2. 例外処理の局所化: ステンシル内の特定のマスターが破損しているだけで、プロセス全体を落とすような設計は許されない。
3. リソースの解放: Visioのオブジェクトモデルはメモリ管理がシビアだ。ループ内でのオブジェクト生成と解放を厳格に行え。

3. プロダクション・コード:マスターシェイプXMLエクスポート・エンジン

以下に、ステンシル内の全マスターシェイプをスキャンし、その「ShapeData(ユーザー定義プロパティ)」をXMLとして出力する、実戦投入レベルのコードを示す。

このコードを利用するには、VBAの参照設定で 「Microsoft XML, v6.0」 にチェックを入れておく必要がある。

Option Explicit

' ==============================================================================
' Module: MasterShapeExporter
' Description: ステンシル内のマスターシェイプを解析し、XML形式でエクスポートする。
' Author: Chief Architect
' ==============================================================================

''' <summary>
''' 指定されたステンシルファイルを解析し、XMLファイルとして保存するメインルーチン
''' </summary>
''' <param name="stencilPath">対象となるステンシルファイルのフルパス</param>
''' <param name="outputPath">出力するXMLファイルのフルパス</param>
Public Sub ExportStencilToXML(ByVal stencilPath As String, ByVal outputPath As String)
    Dim visApp As Visio.Application
    Dim stencil As Visio.Document
    Dim master As Visio.Master
    Dim xmlDoc As MSXML2.DOMDocument60
    Dim rootNode As MSXML2.IXMLDOMElement
    
    On Error GoTo ErrorHandler

    ' Visioアプリケーションの取得(既に起動しているものを使用)
    Set visApp = Visio.Application
    
    ' ステンシルのオープン(読み取り専用)
    Set stencil = visApp.Documents.OpenEx(stencilPath, visOpenReadOnly)
    
    ' XMLドキュメントの初期化
    Set xmlDoc = New MSXML2.DOMDocument60
    Set rootNode = xmlDoc.createElement("StencilExport")
    rootNode.setAttribute "Timestamp", Now()
    rootNode.setAttribute "Source", stencilPath
    xmlDoc.appendChild rootNode

    Debug.Print "Exporting: " & stencil.Name

    ' --- マスターのループ処理 ---
    For Each master In stencil.Masters
        Call ProcessMaster(master, xmlDoc, rootNode)
    Next master

    ' XMLの保存
    xmlDoc.Save outputPath
    MsgBox "エクスポートが完了しました。" & vbCrLf & outputPath, vbInformation

CleanUp:
    ' リソースの解放
    If Not stencil Is Nothing Then stencil.Close
    Set stencil = Nothing
    Set xmlDoc = Nothing
    Exit Sub

ErrorHandler:
    MsgBox "致命的なエラーが発生しました: " & Err.Description, vbCritical
    Resume CleanUp
End Sub

''' <summary>
''' 個別のマスターシェイプを解析し、XMLツリーに追加する
''' </summary>
Private Sub ProcessMaster(ByVal master As Visio.Master, _
                          ByRef xmlDoc As MSXML2.DOMDocument60, _
                          ByRef rootNode As MSXML2.IXMLDOMElement)
    Dim masterNode As MSXML2.IXMLDOMElement
    Dim shape As Visio.Shape
    Dim cell As Visio.Cell
    Dim dataNode As MSXML2.IXMLDOMElement
    Dim cellNode As MSXML2.IXMLDOMElement

    ' マスターノードの作成
    Set masterNode = xmlDoc.createElement("Master")
    masterNode.setAttribute "Name", master.Name
    rootNode.appendChild masterNode

    ' マスターに含まれるシェイプ(図形)をループ
    ' ※マスター内の図形は、Master.Shapesコレクションからアクセスする
    For Each shape In master.Shapes
        Set dataNode = xmlDoc.createElement("Shape")
        dataNode.setAttribute "ID", shape.ID
        dataNode.setAttribute "Name", shape.Name
        masterNode.appendChild dataNode

        ' --- ShapeData (User-defined cells) の抽出 ---
        ' 業務ロジックにおいて最も重要なセクション
        For Each cell In shape.Cells
            ' ShapeData(ユーザー定義プロパティ)のみを対象とする
            ' セル名が "Prop.XXXX" の形式であることを利用
            If InStr(1, cell.Name, "Prop.", vbTextCompare) > 0 Then
                Set cellNode = xmlDoc.createElement("Property")
                cellNode.setAttribute "Name", cell.Name
                cellNode.setAttribute "Value", cell.ResultStr(visNone)
                dataNode.appendChild cellNode
            End If
        Next cell
        
        ' 必要に応じて、ここにジオメトリ(座標)や接続点の抽出ロジックを追加する
    Next shape
End Sub

4. エンジニアが注意すべき「実務の落とし穴」

このコードをベースにツールを拡張する際、以下の3点には細心の注意を払え。

① セル取得のパフォーマンス

`shape.Cells` を全件ループするのは、複雑なシェイプに対しては極めて重い。
実務では、`cell.Name` をチェックする前に、そのシェイプが `shape.CellExists(“Prop.YourProperty”, visExistsAnywhere)` を持っているかを事前に判定するか、あるいは特定のプロパティリストを配列で持っておき、それだけをピンポイントで抜く設計にすべきだ。

② 「値」の型への配慮

`cell.ResultStr(visNone)` は便利だが、浮動小数点の精度や、Visio独自の単位(インチ vs ミリメートル)に注意が必要だ。差分管理の目的が「数値の厳密な比較」であるなら、`cell.Result`(Double型)を取得し、XML上で適切な精度でフォーマットして出力するロジックを組み込め。

③ ファイルI/Oとデータベース連携

もしこのXMLをGitではなく、SQL ServerやPostgreSQLなどのデータベースに格納して「マスターの変更履歴」を管理したい場合は、XMLファイルを介さず、直接 `MSXML2.DOMDocument` の各ノードをデータベースのレコードとして `INSERT` する設計に切り替えろ。中間ファイルを作ることは、常に「ファイル書き込み失敗」というリスクを孕む。

結論:ツールを作るのではない、仕組みを作るのだ

マスターシェイプをXML化するという行為は、単なる「書き出し作業」ではない。
「Visioというブラックボックスの中に閉じ込められた設計資産を、テキストという制御可能な形へ解放する」という、エンジニアリングにおける極めて重要なプロセスだ。

この手法を導入することで、図面変更のレビューは「図面を目視する作業」から「コードの差分を確認する作業」へと進化する。これこそが、業務自動化の真の価値である。

さあ、コードを書き、図面をデータへ昇華させろ。

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