「名前の衝突」を制する者が、Project VBAを制する。――堅牢なカスタムフィールド管理の設計思想
MS Projectの自動化ツールを開発していると、誰もが一度は壁にぶつかる。
それは、「カスタムフィールドの名称重複による実行時エラー」だ。
「よし、新しい管理項目を追加しよう」と意気揚々とコードを走らせた瞬間、`Run-time error ‘438’` や、意図しない既存フィールドの上書きが発生する。これは単なるプログラミングのミスではない。「オブジェクトのスコープ(範囲)」と「状態管理」に対する設計思想の欠如が招く、必然的な結果である。
本記事では、現場で通用する「バグを未然に防ぐ名前空間管理(Namespace Management)」の極意を伝授する。単なるコードの書き方ではない。プロフェッショナルとして、どのように「壊れないシステム」を設計すべきかを語ろう。
1. なぜ、あなたのコードは「衝突」するのか
まず、敵を知ることだ。MS Projectにおけるカスタムフィールドは、そのプロジェクトファイル(.mpp)全体で共有されるグローバルなリソースである。
初心者が書きがちなコードは、以下のようなものだ。
' 【アンチパターン:極めて脆弱な設計】
Sub BadExample()
Dim i As Integer
For i = 1 To 5
' 直接名前を代入しようとする。
' もし既に同じ名前のフィールドが存在していたら、ここでクラッシュするか、既存データを破壊する。
ActiveProject.CustomFields(i).Name = "進捗ステータス"
Next i
End Sub
この設計が致命的な理由は3つある。
1. 存在確認の欠如: すでにその名前のフィールドがあるかどうかを事前に調べていない。
2. 決定論の欠如: 実行するたびに「どのインデックスに何が入るか」が不確定である。
3. 名前空間の無視: ツールが作成したフィールドと、ユーザーが手動で作ったフィールドを区別する術がない。
プロフェッショナルは、フィールドを「ただの変数」とは考えない。それは「プロジェクトという共有メモリに書き込まれる、名前付きのグローバル変数」である。
2. 堅牢な設計:3つの鉄則
バグのないツールを作るために、我々は以下の3つの設計原則を導入しなければならない。
① 名前空間(Namespace)の導入
すべてのカスタムフィールドに、ツール固有のプレフィックス(接頭辞)を付与する。
例えば、`[AutoTool]_` というプレフィックスを付けるだけで、ユーザーが作成したフィールドとの衝突リスクを劇的に下げることができる。
② 存在チェックと衝突回避ロジック
「名前を付ける」前に、「その名前が既に使われていないか」をスキャンする。もし重複していた場合は、`_v1`, `_v2` といったサフィックス(接尾辞)を自動的に付与して、ユニークな名前を生成する。
③ Dictionaryオブジェクトによる高速な検索
フィールドの存在確認をループで行うのは、パフォーマンスの観点から愚策だ。プロジェクト内の全フィールド名を一度 `Scripting.Dictionary` に格納し、メモリ上で $O(1)$ の計算量で検索を行うのが定石である。
3. 実装:プロダクション・グレードのフィールドマネージャー
それでは、実際に現場でそのまま使える、堅牢なロジックを実装しよう。
ここでは、「重複を回避しながら、安全にカスタムフィールドを定義・設定する」ためのクラスライクなモジュールを提供する。
※ `Microsoft Scripting Runtime` を参照設定せずに動くよう、Late Binding(遅延結合)を採用している。これにより、配布時の環境依存トラブルを防いでいる。
Option Explicit
' ==============================================================================
' Module: FieldManager
' Description: MS Projectのカスタムフィールドを安全に管理するためのユーティリティ
' ==============================================================================
''' <summary>
''' 指定された名前空間に基づき、重複しない一意のフィールド名を生成してカスタムフィールドを設定する
''' </summary>
''' <param name="targetName">設定したい本来の名前</param>
''' <param name="prefix">ツール識別用のプレフィックス</param>
''' <param name="fieldType">Task または Resource (文字列で指定)</param>
Public Sub SafeSetCustomField(ByVal targetName As String, _
ByVal prefix As String, _
ByVal fieldType As String)
Dim dict As Object
Set dict = GetExistingFieldNames(fieldType)
' 1. 最終的に使用する名前を決定する(名前空間の適用と重複回避)
Dim finalName As String
finalName = GenerateUniqueName(dict, prefix & targetName)
' 2. フィールドの割り当て
' 未使用のインデックスを探して、安全に名前をセットする
Dim i As Integer
Dim maxFields As Integer
maxFields = 30 ' MS Projectのカスタムフィールド上限(環境により調整)
Dim isAssigned As Boolean
isAssigned = False
For i = 1 To maxFields
' すでにその名前が使われていないか、あるいは空のフィールドを見つける
If ActiveProject.CustomFields(i).Name = finalName Then
' すでに同じ名前が存在する場合(理論上GenerateUniqueNameで回避済みだが念のため)
Debug.Print "Warning: Field already exists: " & finalName
isAssigned = True
Exit For
End If
' 空のフィールド、または名前が一致するものを探すロジック
' ここでは「空のフィールドに新しい名前を付ける」プロセスを行う
If ActiveProject.CustomFields(i).Name = "" Then
ActiveProject.CustomFields(i).Name = finalName
Debug.Print "Success: Assigned '" & finalName & "' to index " & i
isAssigned = True
Exit For
End If
Next i
If Not isAssigned Then
Err.Raise vbObjectError + 513, "FieldManager", "利用可能なカスタムフィールドの枠が不足しています。"
End If
End Sub
''' <summary>
''' プロジェクト内の既存のカスタムフィールド名をDictionaryに格納する
''' </summary>
Private Function GetExistingFieldNames(ByVal fieldType As String) As Object
Dim dict As Object
Set dict = CreateObject("Scripting.Dictionary")
Dim i As Integer
Dim currentName As String
' fieldTypeに基づき、TaskかResourceかを判定してループ
' ここでは簡略化のためTaskを対象とするが、実務では両方に対応させる
For i = 1 To 30
currentName = ActiveProject.CustomFields(i).Name
If currentName <> "" Then
' 重複を許容しないDictionaryに格納
If Not dict.Exists(currentName) Then
dict.Add currentName, i
End If
End If
Next i
Set GetExistingFieldNames = dict
End Function
''' <summary>
''' 名前空間を考慮し、重複があればサフィックスを付与して一意の名前を返す
''' </summary>
Private Function GenerateUniqueName(ByVal dict As Object, ByVal desiredName As String) As String
Dim baseName As String
Dim attempt As Integer
Dim candidateName As String
baseName = desiredName
candidateName = desiredName
attempt = 1
' Dictionary内に名前が存在する限り、サフィックスを増やしていく
Do While dict.Exists(candidateName)
candidateName = baseName & "_v" & attempt
attempt = attempt + 1
Loop
GenerateUniqueName = candidateName
End Function
' ==============================================================================
' Test Execution
' ==============================================================================
Sub Test_FieldAutomation()
On Error GoTo ErrorHandler
Dim myPrefix As String
myPrefix = "[ProjectX]_"
' テスト1: 通常の登録
SafeSetCustomField "Status", myPrefix, "Task"
' テスト2: 同じ名前を再度登録しようとする(重複回避のテスト)
SafeSetCustomField "Status", myPrefix, "Task"
' テスト3: 別の名前を登録
SafeSetCustomField "RiskLevel", myPrefix, "Task"
MsgBox "カスタムフィールドの自動生成が完了しました。", vbInformation
Exit Sub
ErrorHandler:
MsgBox "エラーが発生しました: " & Err.Description, vbCritical
End Sub
4. アーキテクトの視点:実務への応用
このコードは、単に「エラーを出さない」ためのものではない。「データの整合性を守る」ためのものだ。
データベース・外部ファイル連携時の注意点
もし、このカスタムフィールドの情報をExcelやSQL Serverなどの外部データベースと連携させている場合、「名前の不一致」は致命的なデータ欠損を招く。
- 対策: フィールド名を動的に変える設計にするなら、データベース側にも「どのプロジェクトのどのバージョン(`_v1`など)のフィールドを参照するか」を管理するカラムを持たせる必要がある。
パフォーマンスの重み
`ActiveProject.CustomFields(i)` へのアクセスは、COMオブジェクトを介するため、ループ内での過度なアクセスは動作を重くする。
大規模なプロジェクト(数千タスク)を扱うツールでは、最初に全てのフィールド状態をメモリ上の構造体(User Defined TypeやClass)にロードし、そのメモリ上でロジックを完結させてから、最後に一括で書き込む設計を検討せよ。
結論
「動けばいい」というコードは、保守フェーズで必ず牙を剥く。
特にMS Projectのような、ユーザーが自由にオブジェクトを操作できる環境において、名前空間の管理と存在チェックは、エンジニアとしての「礼儀」であり、システムの「生存戦略」である。
この設計思想を胸に、次なる自動化プロジェクトに挑んでほしい。
