正确公开 List<T>？

Question

我知道我不应该在属性中公开List<T>，但我想知道这样做的正确方法是什么？例如，这样做：

public static class Class1
{
    private readonly static List<string> _list;

    public static IEnumerable<string> List
    {
        get
        {
            return _list;
            //return _list.AsEnumerable<string>(); behaves the same
        }
    }

    static Class1()
    {
        _list = new List<string>();
        _list.Add("One");
        _list.Add("Two");
        _list.Add("Three");
    }
}

将允许我的调用者简单地转换回List<T>：

    private void button1_Click(object sender, EventArgs e)
    {
        var test = Class1.List as List<string>;
        test.Add("Four"); // This really modifies Class1._list, which is bad™
    }

所以如果我想要一个真正不可变的List<T>，我是否总是需要创建一个新列表？例如，这似乎有效（转换后测试为空）：

    public static IEnumerable<string> List
    {
        get
        {
            return new ReadOnlyCollection<string>(_list);
        }
    }

但我担心每次有人尝试访问我的列表时都会克隆我的列表是否会产生性能开销？

Answer 1

将List<T> 暴露为属性实际上并不是万恶之源。特别是如果它允许预期的用法，例如foo.Items.Add(...)。

您可以为AsEnumerable() 编写一个演员安全的替代方案：

public static IEnumerable<T> AsSafeEnumerable<T>(this IEnumerable<T> data) {
    foreach(T item in data) yield return item;
}

但你目前最大的问题是线程安全。作为静态成员，您可能会遇到很大的问题，尤其是在 ASP.NET 之类的东西中。即使ReadOnlyCollection 超过现有列表也会受到此影响：

        List<int> ints = new List<int> { 1, 2, 3 };
        var ro = ints.AsReadOnly();
        Console.WriteLine(ro.Count); // 3
        ints.Add(4);
        Console.WriteLine(ro.Count); // 4

所以简单地用AsReadOnly 包装是不够 足以使您的对象线程安全；它只是防止消费者添加数据（但他们仍然可以在您的其他线程添加数据时枚举它，除非您同步或制作副本）。

Answer 2

使用AsReadOnly() - see MSDN for details

Answer 3

是和否。是的，存在性能开销，因为创建了一个新对象。不，您的列表没有被克隆，它由 ReadOnlyCollection 包装。

Answer 4

如果该类没有其他用途，您可以从 list 继承并覆盖 add 方法并让它抛出异常。

Answer 5

您无需担心克隆的开销：使用 ReadOnlyCollection 包装集合不会克隆它。它只是创建一个包装器；如果底层集合发生变化，只读版本也会发生变化。

如果您担心一遍又一遍地创建新的包装器，可以将其缓存在单独的实例变量中。

Answer 6

我之前问过一个类似的问题：

• Difference between List and Collection (CA1002, Do not expose generic lists)
• Why does DoNotExposeGenericLists recommend that I expose Collection instead of List?

基于此，我建议您在内部使用List<T>，并将其作为Collection<T> 或IList<T> 返回。或者，如果只需要枚举而不是添加或添加类似的东西，IEnumerable<T>。

关于能够将你返回的东西投射到其他东西的问题，我只想说不要打扰。如果人们想以非预期的方式使用您的代码，他们将能够以某种方式使用您的代码。我之前也问过这个问题，我想说唯一明智的做法是公开你的意图，如果人们以不同的方式使用它，那是他们的问题：p 一些相关问题：

• How should I use properties when dealing with List members（尤其是this answer）
• Encapsulation of for example collections

Answer 7

如果您将您的列表公开为 IEnumerable，我不会担心调用者会转换回列表。您已在类的合同中明确指出，此列表中仅允许 IEnumerable 中定义的操作。因此，您已含蓄地声明该列表的实现几乎可以更改为实现 IEnumerable 的任何内容。

Answer 8

当您的枚举处于中途并且集合被修改时，AsEnumerable 和 ReadOnlyCollection 会出现问题。这些东西不是线程安全的。将它们作为数组返回并在调用时缓存它们可能是更好的选择。

例如，

public static String[] List{
   get{
      return _List.ToArray();
   }
} 

//While using ...

String[] values = Class1.List;

foreach(string v in values){
  ...
}

// instead of calling foreach(string v in Class1.List)
// again and again, values in this context will not be
// duplicated, however values are cached instance so 
// immediate changes will not be available, but its
// thread safe
foreach(string v in values){
  ...
}