勝手に項目が追加される問題

Dictionaryを使って開発・デバッグしていると、急に想定しないエラーが出るようになった。

具体的には、Dictionaryを宣言した直後、

 Dim dict As Scripting.Dictionary
 Set dict = New Scripting.Dictionary

（↑の段階で）まだ何もAddしていないのにdict.Items(0)が存在している。Valueは空。

いやいや何でやねん。

　

何故!?ありえない話し!!

追加していないものが勝手に追加されるなんて普通に考えればあり得ない話。

「バグか？」と思ったが、どうもありえる話らしい。

• vba - Scripting.Dictionary adding items without using Dictionary.Add - BUG? - Stack Overflow

原因は一言でいえば、「デバッグのウォッチ式にdict.Item(key)を追加したままだったから」。

確かに直前にデバッグ実行したときにこのウォッチ式は追加したが、何が悪いというのだろうか。

　

Item(key)をウォッチ式に追加したら何が悪いのか

まず、ItemプロパティはDictionaryオブジェクトのアクセサのようなものだが、実はgetterだけでなくsetterとしても作用する。

Item プロパティ
Dictionary オブジェクト内の指定した_キー_の_アイテム_を設定または取得します。 コレクションについては、指定した key に基づいて item を取得します。 値の取得と設定が可能です。

Item プロパティ (Dictionary オブジェクト) | Microsoft Docs

つまりどういうことかといえば、dict.Item("AA")でアクセスした際、

• dict内にKey:"AA"が存在していれば（当然ながら）Key:"AA"に対応するItemの内容を返してくれるが、
• dict内にKey:"AA"が存在していない場合、dictに新たな項目（Key:"AA"、Item:""）を作成する

ということらしいのだ。

注釈
item を変更するときに key がない場合は、指定した newitem で新しい key が作成されます。 既存の項目を返そうとしたときに key がない場合は、新しい key が作成され、対応する項目は空のままになります。

Item プロパティ (Dictionary オブジェクト) | Microsoft Docs

ウォッチ式にdict.Item("AA")がずっと残っていたことにより、VBAコードを実行するたびにウォッチ式を表示するためdict.Item("AA")へアクセスが発生する。

でもまだdictは空なのでKey:"AA"は見つからず、結果として空のItem("AA")が追加されてしまっていた、ということになる。

何でこんな仕様にしたの？なんで？

　

クソデカ落とし穴マジでよして

VBAは常に開発で使うものではなく、スポットで（しかもしばしば重要度が低い...わりに工数が想定以上にかかる）部分の開発に使われるため、なかなか知識のアップデートが起きにくい。

とはいえ古いやり方しか知らないと、Excelマクロにありがちな「動くには動くけど遅すぎる」などの問題にぶち当たるため、新しい方法を模索しないわけにもいかない。

そして、やむなく慣れないやり方を採用するとこういう落とし穴にはまるわけだ。南無三。

VBAを触る際は「当然こう動くはずだろう」を捨てないといけないのは経験上分かっていたのだが、まさかこのレベルで注意が必要だとは思わなかった。まだまだ精進が足りない。

　

【追記】この現象はC#のDictionaryでも起きる様子

コメントで教えていただきました。

確かにMicrosoftの資料を見るとC#のDictionary.Itemにもgetterとsetterがある。

public TValue this[TKey key] { get; set; }

説明にもVBA同様の記載がある。

You can also use the Item[] property to add new elements by setting the value of a key that does not exist in the Dictionary<TKey,TValue>. When you set the property value, if the key is in the Dictionary<TKey,TValue>, the value associated with that key is replaced by the assigned value. If the key is not in the Dictionary<TKey,TValue>, the key and value are added to the dictionary. In contrast, the Add method does not modify existing elements.

（機械翻訳が酷いので英語ページを参照した）

Dictionaryに存在しないKeyをItem[]に設定することで要素を追加することが可能。既にキーが存在した場合は上書きし、存在しなければ追加する。

一方でAddは既存の要素を上書きしない。既に存在するキーを指定するとArgumentExceptionをスローする。とのこと。

　

デバッガの使い方には注意が必要

Dictionaryの仕様がトリッキーであったことは確かだが、ある意味ではデバッガ（ウォッチ式）の使い方が悪かったともいえる。両方が積み重なったコンボ技というか。

他の例ではC言語でgdbを使ってデバッグする際、条件付きブレークポイントを作成するのに

"b func if variable==1"としなければいけないところ

"b func if variable=1"としてしまい、関数funcが呼び出される度にvariableに1が代入されてしまう、みたいなアクシデントもあった。

言語仕様の把握とともに、デバッガの使い方についてももっと勉強しないといけない・・・。