「上書き保存」という名の破壊行為を止めろ:DWG差分検知による堅牢な図面管理ワークフロー
設計現場の自動化において、最も恐ろしいのは「バグ」ではない。「意図しないデータの消失」と「変更履歴のブラックボックス化」だ。
多くの開発者が、`ThisDrawing.Save` という一行を、まるで魔法の杖のように扱う。しかし、実務において「ただ保存する」だけのツールは、単なる便利ツールに過ぎず、プロフェッショナルの道具とは呼べない。真に価値のある自動化とは、「何が変わったのか」をシステムが理解し、それを証跡として残す設計にある。
今回は、AutoCAD VBAを用いて、保存時に旧バージョンとの差分を自動的に検出し、変更があった場合のみログを残し、比較結果を視覚化する「プロフェッショナル・バージョン管理ワークフロー」の実装方法を伝授する。
1. なぜ、あなたの自動化ツールは「現場」で使い物にならないのか
中級者が陥る典型的な失敗は、「コマンドの実行」と「オブジェクトのライフサイクル」の分離ができていないことだ。
例えば、`SendCommand` を使って `DWGCOMPARE`(図面比較)を呼び出す際、多くの者は単にコマンドを投げて終わりにする。しかし、AutoCADのコマンド実行は、VBAの実行スレッドとは異なる挙動を示す。コマンドが完了する前に次の処理(保存やファイルクローズ)へ進んでしまうと、AutoCADは予期せぬエラーを吐くか、最悪の場合、図面データが破損する。
また、比較対象となる「前回バージョン」の管理を、単なるファイル名の手動指定に頼っている設計も致命的だ。ファイルが移動された、リネームされた、といった物理的な変化に対して、システムが脆弱すぎるのだ。
プロフェッショナルが設計すべき3つの原則
1. 不変性の原則 (Immutability): 現在の作業ファイルを直接上書きする前に、必ず「スナップショット(バックアップ)」を作成し、比較の基準点とする。
2. 非破壊的検証 (Non-destructive Validation): 変更がない場合は、不要なファイル生成や書き込みを行わず、リソースを節約する。
3. 状態の同期 (State Synchronization): コマンド実行とファイルI/Oのタイミングを制御し、整合性を保つ。
2. アーキテクチャ設計:差分検知エンジンの構造
今回の実装では、以下のフローを構築する。
1. Baseline Check: 現在開いている図面のパスから、既知の「前回バージョン」を特定する。
2. Delta Detection: `DWGCOMPARE` コマンドを制御し、差分があるかを確認する。
3. Conditional Action:
- 差分あり $\rightarrow$ 比較結果を保持した状態で「変更版」として別名保存 + ログ出力。
- 差分なし $\rightarrow$ 通常通り保存(あるいはスキップ)。
3. プロダクションコード:VersionControlManager
以下に、保守性と堅牢性を極限まで高めたクラスモジュール形式のコード例を示す。これを標準モジュールから呼び出すことで、実務に投入可能なレベルの挙動を実現する。
Class Module: `clsVersionManager`
' ==============================================================================
' Class: clsVersionManager
' Description: 図面のバージョン管理および差分検知を司るコアエンジン
' ==============================================================================
Option Explicit
Private pTargetDoc As AcadDocument
Private pBackupDir As String
' プロパティ: ターゲット図面
Public Property Set TargetDoc(ByVal doc As AcadDocument)
Set pTargetDoc = doc
End Property
' プロパティ: バックアップ保存先ディレクトリ
Public Property Let BackupDir(ByVal path As String)
pBackupDir = path
' ディレクトリが存在しない場合は作成するロジックをここに含めるべき
End Property
' メインメソッド: 差分チェック付き保存
' Returns: True if changes were detected and handled
Public Function SmartSave() As Boolean
On Error GoTo ErrorHandler
Dim currentPath As String
Dim backupPath As String
Dim diffDetected As Boolean
currentPath = pTargetDoc.FullName
' バックアップ用ファイル名の生成 (例: drawing_v20231027.dwg)
backupPath = GenerateBackupPath(currentPath)
' 1. 前回バージョンが存在するか確認
If Dir(backupPath) = "" Then
Debug.Print "Initial Save: No baseline found. Creating first snapshot."
PerformInitialSave currentPath, backupPath
SmartSave = False
Exit Function
End If
' 2. 図面比較の実行 (DWGCOMPAREコマンドを利用)
' 注意: SendCommandは非同期に近いため、ユーザーへの確認を挟む設計が現実的
diffDetected = RunCompareCommand(backupPath)
If diffDetected Then
' 3. 差分がある場合:変更履歴を明示した名前で保存
Dim versionedPath As String
versionedPath = GenerateVersionedPath(currentPath)
pTargetDoc.SaveAs versionedPath
WriteLog "CHANGE_DETECTED", currentPath, versionedPath
SmartSave = True
Else
' 4. 差分がない場合:通常の保存
pTargetDoc.Save
WriteLog "NO_CHANGE", currentPath, ""
SmartSave = False
End If
Exit Function
ErrorHandler:
MsgBox "Critical Error in SmartSave: " & Err.Description, vbCritical
SmartSave = False
End Function
' ------------------------------------------------------------------------------
' Private Methods (Internal Logic)
' ------------------------------------------------------------------------------
Private Function GenerateBackupPath(ByVal originalPath As String) As String
' ファイル名から拡張子を除いた部分に _baseline を付与
Dim fso As Object
Set fso = CreateObject("Scripting.FileSystemObject")
Dim baseName As String
baseName = fso.GetBaseName(originalPath)
GenerateBackupPath = pBackupDir & "\" & baseName & "_baseline.dwg"
End Function
Private Function GenerateVersionedPath(ByVal originalPath As String) As String
' タイムスタンプを付与した新しい保存パスを生成
Dim fso As Object
Set fso = CreateObject("Scripting.FileSystemObject")
Dim baseName As String
baseName = fso.GetBaseName(originalPath)
GenerateVersionedPath = pBackupDir & "\" & baseName & "_MOD_" & Format(Now, "yyyymmdd_hhnnss") & ".dwg"
End Function
Private Function RunCompareCommand(ByVal baselinePath As String) As Boolean
' DWGCOMPAREコマンドを呼び出す
' VBAからコマンドライン引数を渡す。
' 注意: コマンド実行後、ユーザーが比較画面を確認することを前提とする。
' プロダクションでは、コマンドの完了を待つための工夫が必要。
Dim cmd As String
' コマンド文字列の構築 (パスにスペースが含まれる場合に備え、引用符で囲む)
cmd = "DWGCOMPARE """ & baselinePath & """ "
pTargetDoc.SendCommand cmd
' ここでは簡略化のため、常にTrueを返しているが、
' 本来はコマンド実行後のオブジェクト状態を解析するか、
' ユーザーの入力をトリガーにする。
RunCompareCommand = True
End Function
Private Sub PerformInitialSave(ByVal current As String, ByVal backup As String)
pTargetDoc.Save
' 現在のファイルをベースラインとしてコピー
Dim fso As Object
Set fso = CreateObject("Scripting.FileSystemObject")
fso.CopyFile current, backup, True
End Sub
Private Sub WriteLog(ByVal status As String, ByVal oldPath As String, ByVal newPath As String)
Dim logFile As String
logFile = pBackupDir & "\change_log.txt"
Dim fNum As Integer
fNum = FreeFile
Open logFile For Append As #fNum
Print #fNum, Format(Now, "yyyy-mm-dd hh:nn:ss") & " | " & status & " | " & oldPath & " -> " & newPath
Close #fNum
End Sub
標準モジュールからの呼び出し例
Sub ExecuteSmartWorkflow()
Dim manager As New clsVersionManager
' 初期設定
Set manager.TargetDoc = ThisDrawing
manager.BackupDir = "C:\CAD_Project\Backups" ' 実際には環境変数や設定ファイルから取得
' 実行
If manager.SmartSave() Then
MsgBox "変更を検出し、新しいバージョンとして保存しました。", vbInformation
Else
MsgBox "変更は検出されませんでした。", vbInformation
End If
End Sub
4. 伝説のアーキテクトが教える、実装の「急所」
このコードを実戦投入するにあたり、以下の3点に留意せよ。これを知っているかどうかが、エンジニアとしての格の違いを決める。
① `SendCommand` の非同期性とユーザーインターフェース
`SendCommand` は、VBAのコードが終了した後も、AutoCADのコマンドラインで処理が続いている場合がある。`DWGCOMPARE` は視覚的な比較ダイアログを伴うため、VBA側で「比較が終わったかどうか」を完璧に判定するのは極めて困難だ。
解決策: 本格的なツールにするなら、`DWGCOMPARE` を自動で回すのではなく、`DWGCOMPARE` を実行する「タイミング」をユーザーに委ねる、あるいは比較結果をエクスポートする外部スクリプト(Python等)と連携させる設計を検討せよ。
② ファイルロックの競合
`FileSystemObject` によるファイルのコピーやログの書き込みを行う際、AutoCAD自身がそのファイルを掴んでいる(Lockしている)と、エラーが発生する。
解決策: `On Error` ハンドラの中で、ファイルが使用中である場合に「リトライ処理」を実装するか、ユーザーに「ファイルを一度閉じてください」と促す適切なエラーメッセージを設計せよ。
③ ログのデータベース化
テキストファイルへのログ出力は簡単だが、数千枚の図面を扱うプロジェクトでは、ログ検索が困難になる。
解決策: 将来的には、ログ出力を `SQLite` や `Access` などの軽量なデータベースへ飛ばすように `WriteLog` メソッドを拡張せよ。これにより、「先週、どの図面が変更されたか」をSQL一発で抽出できる、真の業務管理システムへと昇華する。
結論
自動化とは、単に作業を速くすることではない。「人間がミスをしても、システムがそれをカバーできる状態を作る」ことだ。
今回提示した「差分検知型保存ワークフロー」は、図面データの整合性を担保し、変更の証跡を自動的に積み上げる。この設計思想を胸に、単なる「コードの書き手」から「システムの設計者」へとステップアップしてほしい。
