具有默认值的对象初始值设定项内的集合初始值设定项

Question

我只是偶然发现了以下问题：

class Settings
{
    // Let's set some default value: { 1 }
    public ICollection<int> AllowedIds = new List<int>() { 1 };
}

static void Main(string[] args)
{
    var s = new Settings
    {
        AllowedIds = { 1, 2 }
    };

    Console.WriteLine(string.Join(", ", s.AllowedIds)); // prints 1, 1, 2
}

我明白为什么会这样：AllowedIds = { 1, 2 } 不是一个赋值，而是一个对象初始化器中的集合初始化器，也就是说，它是一个AllowedIds.Add(1); AllowedIds.Add(2)的隐式调用。

不过，对我来说这是一个陷阱，因为它看起来像一个作业（因为它使用了=）。

作为一名 API/库开发人员（假设我是开发 Settings 类的人）想要遵守 principle of least surprise，我可以做些什么来阻止我的库的消费者不会掉进那个陷阱？

---

脚注：

• 在这种特殊情况下，我可以使用ISet/HashSet<int> 而不是ICollection/List（因为重复对AllowedIds 没有意义），这将产生1, 2 的预期结果。尽管如此，初始化AllowedIds = { 2 } 会产生1, 2 的反直觉结果。

• 我在C# github repo上找到了一个相关的讨论，基本上得出的结论是，是的，这个语法很混乱，但它是一个旧特性（2006年引入），我们不能改变它而不向后打破兼容性。

Answer 1

如果您不希望 Settings 类的用户添加到 AllowedIds，为什么将其公开为 ICollection<int>（其中包含 Add 方法并表示意图加入）？

AllowedIds = { 1, 2 } 在您的代码中起作用的原因是因为 C# 使用鸭子类型来输入 call the Add method on the collection。如果排除编译器找到Add 方法的可能性，AllowedIds = { 1, 2 } 行就会出现编译错误，从而防止陷阱。

你可以这样做：

class Settings
{
    // Let's set some default value: { 1 }
    public IEnumerable<int> AllowedIds { get; set; } = new List<int> { 1 };
}

static void Main(string[] args)
{
    var s = new Settings
    {
        AllowedIds = new List<int> { 1, 2 }
    };

    Console.WriteLine(string.Join(", ", s.AllowedIds)); // prints 1, 2
}

这样你仍然允许调用者使用setter设置一个新的集合，同时防止你提到的陷阱。