Immutable コレクションは現状いろんな使いにくさがあって悪名高いわけですが。
今日は「リスト パターンの回に出した [] リテラルの話」と絡むので、特に ImmutableArray とかに対してコレクション初期化子が使えないという話をします。
クイズ
以下のようなコード。
using System.Collections.Immutable;
ImmutableArray<int> a = new() { 1, 2 };
foreach (var x in a)
{
Console.WriteLine(x);
}
どういう結果になるでしょう？
- 1, 2, 3 が表示される
- 何も表示されない
foreachのところで例外が出るnewのところで例外が出る- コンパイルできない
ちなみに、C# ライブ配信中に参加者みんな間違えてました。
答え
new のところで例外です。
しかもぬるぽ。
Unhandled exception. System.NullReferenceException: Object reference not set to an instance of an object. at System.Collections.Immutable.ImmutableArray`1.get_Length() at System.Collections.Immutable.ImmutableArray`1.Add(T item) at Program.$(String[] args) in C:\source\repos\ConsoleApp1\ConsoleApp1\Program.cs:line 4
そして、どうしてこうなるかの説明にも何段階かの変形が必要という…
とりあえず、foreach のところは無罪というか、その行までたどり着かないのでいったん削除。
(ちなみに、もしたどり着けた場合、foreach でも例外が出ます。)
using System.Collections.Immutable;
ImmutableArray<int> a = new() { 1, 2 };
コレクション初期化子は、以下のように、new() の後に Add メソッドを呼ぶという展開のされ方になります。
using System.Collections.Immutable;
ImmutableArray<int> a = new();
a.Add(1); // ぬるぽるのはこの行になる。
a.Add(2);
まあ、この時点ですでに問題の原因が分かってくる頃かと思いますが、一応もう1段。
ImmutableArray は構造体で、C# 10.0 より前には構造体に引数なしコンストラクターがなかったので、これは以下のコードと同じ意味になります。
using System.Collections.Immutable;
ImmutableArray<int> a = default;
a.Add(1); // ぬるぽるのはこの行。
a.Add(2);
構造体の default は「全ビットを0にする」みたいな扱いで、
参照型の場合には null が入ります。
要するに、実質以下のコードと同じような挙動になります。
// 実質これと同じ結果
using System.Collections.Immutable;
ImmutableArray<int> a = ImmutableArray.Create<int>(items: null);
a.Add(1); // ぬるぽる原因は items: null なせい。
a.Add(2);
ちなみに、「既存の構造体に引数なしコンストラクターを足すのは破壊的変更」なので、破壊的変更を極力割けて通っている .NET 的に、追加されることはないと思います。なのでたぶん、ImmutableArray<T> がこんな変な挙動から解放される未来もないと思われます。
また、以下のようにぬるぽ回避コードを入れても、おそらくほとんどの人にとって所望の結果にはならないと思います。
using System.Collections.Immutable;
// ぬるぽ回避
ImmutableArray<int> a = ImmutableArray.Create(Array.Empty<int>());
a.Add(1); // 無事通過。
a.Add(2);
// ただし、a の中身は Empty のまま。
// まあ、immutable ですからね。初期状態から変わるはずないですよね。
foreach (var x in a)
{
Console.WriteLine(x);
}
ええ、immutable ですから。
Add は「元の配列に1要素 append した新しい配列を作って返す」という仕様。
自身の書き換えはしません。
課題
2つの問題が重なってこんなことになっています。
- コレクション初期化子に適さないのに、C# の構文上はコレクション初期化子が使える条件を満たしてしまっている
defaultが不正な状態になる構造体を作ってしまっている
と言うことで、また日を改めて書くと思うんですが、それぞれ以下のような解決策が考えられています。
- 今後追加予定の新構文の
[]リテラルでは、ImmutableArrayでも使えるような展開の仕方をする - 基本的に
default禁止なアノテーション(null 許容参照型の構造体版)を作る