C#：例如集合的封装

Question

我想知道其中哪一个被认为是最干净或最好使用的以及为什么。

其中一个公开乘客列表，允许用户添加和删除等。另一个隐藏列表，只允许用户枚举它们并使用特殊方法添加。

示例 1

class Bus
{
    public IEnumerable<Person> Passengers { get { return passengers; } }
    private List<Passengers> passengers;

    public Bus()
    {
        passengers = new List<Passenger>();
    }

    public void AddPassenger(Passenger passenger)
    {
        passengers.Add(passenger);
    }
}

var bus = new Bus1();
bus.AddPassenger(new Passenger());
foreach(var passenger in bus.Passengers)
    Console.WriteLine(passenger);

示例 2

class Bus
{
    public List<Person> Passengers { get; private set; }

    public Bus()
    {
        Passengers = new List<Passenger>();
    }
}

var bus = new Bus();
bus.Passengers.Add(new Passenger());
foreach(var passenger in bus.Passengers)
    Console.WriteLine(passenger);

我想说的第一个类封装得更好。 在这种情况下，这可能是更好的方法（因为您可能应该确保公交车上还有剩余空间等）。 但我想在某些情况下第二类也可能有用？ 就像班级并不真正关心该列表会发生什么一样，只要它有一个列表即可。 你怎么认为？

Answer 1

在示例一中，可以改变您的集合。

请考虑以下事项：

var passengers = (List<Passenger>)bus.Passengers;

// Now I have control of the list!
passengers.Add(...);
passengers.Remove(...);

要解决此问题，您可以考虑如下：

class Bus
{
  private List<Passenger> passengers;

  // Never expose the original collection
  public IEnumerable<Passenger> Passengers
  {
     get { return passengers.Select(p => p); }  
  }

  // Or expose the original collection as read only
  public ReadOnlyCollection<Passenger> ReadOnlyPassengers
  {
     get { return passengers.AsReadOnly(); }
  }

  public void AddPassenger(Passenger passenger)
  {
     passengers.Add(passenger);
  }
 }

Answer 2

在大多数情况下，我认为示例 2 是可以接受的，前提是基础类型是可扩展的和/或公开某种形式的 onAdded/onRemoved 事件，以便您的内部类可以响应对集合的任何更改。

在这种情况下，List不合适，因为类无法知道是否添加了某些内容。 相反，您应该使用 Collection，因为 Collection类有几个可以重写的虚拟成员（Insert、Remove、Set、Clear），并添加事件触发器来通知包装类。

（您还必须意识到该类的用户可以在父类不知情的情况下修改列表/集合中的项目，因此请确保您不依赖于未更改的项目 - 除非它们显然是不可变的- 或者如果需要，您可以提供 onChanged 样式事件。）

Answer 3

通过 FxCop 运行各自的示例，这应该会提示您暴露 List 的风险

Answer 4

我想说这一切都取决于你的情况。 我通常会选择选项 2，因为它是最简单的，除非您出于业务原因需要对其添加更严格的控制。

Answer 5

选项 2 是最简单的，但它允许其他类向集合添加/删除元素，这可能很危险。

我认为一个好的启发是考虑包装方法的作用。 如果您的 AddPassenger （或 Remove 或其他）方法只是将调用中继到集合，那么我会选择更简单的版本。 如果您必须在插入元素之前检查它们，那么选项 1 基本上是不可避免的。 如果您必须跟踪插入/删除的元素，则可以采用任一方法。 使用选项 2，您必须在集合上注册事件才能获取通知，而使用选项 1，您必须为要使用的列表上的每个操作创建包装器（例如，如果您想要插入和添加），所以我猜这取决于。