修改引用类型参数的方法不好吗？

Question

我见过这样的方法：

public void Foo(List<string> list)
{
    list.Add("Bar");
}

Is this goodpractice tomodifyparametersinamethod?

这样不是更好吗？

public List<string> Foo(List<string> list)
{
    // Edit
    List<string> newlist = new List<string>(list);
    newlist.Add("Bar");
    return newlist;
}

感觉第一个例子有意想不到的副作用。

Answer 1

在您给出的示例中，第一个对我来说似乎比第二个好得多。 如果我看到一个接受列表并返回列表的方法，我的第一个假设是它返回一个新列表并且不触及给定的列表。 因此，第二种方法具有意想不到的副作用。

只要你的方法命名得当，修改参数就没有什么危险。 考虑一下：

public void Fill<T>(IList<T> list)
{
    // add a bunch of items to list
}

使​​用“Fill”这样的名称，您可以非常确定该方法将修改列表。

Answer 2

坦率地说，在这种情况下，两种方法或多或少都做相同的事情。 两者都会修改传入的 List。

如果目标是通过这种方法使列表不可变，则第二个示例应该复制发送的 List中，然后对新的 List 执行 Add 操作，然后返回该操作。

我不熟悉 C# 也不熟悉 .NET，所以我的猜测是：

public List<string> Foo(List<string> list)
{
    List<string> newList = (List<string>)list.Clone();
    newList.Add("Bar");
    return newList;
}

这样，调用 Foo 方法的方法将获得新创建的 List 返回，传入的原始 List 不会被触及。

这实际上取决于您的规范或 API 的“合同”，因此在可以修改 List 的情况下，我认为使用第一种方法没有问题。

Answer 3

您在两种方法中执行完全相同的操作，只是其中一种方法返回相同的列表。

在我看来，这实际上取决于你在做什么。 只要确保您的文档清楚说明正在发生的事情即可。 如果您喜欢这类事情，请编写前置条件和后置条件。

Answer 4

使用列表作为参数的方法修改列表实际上并不意外。 如果你想要一个只从列表中读取的方法，你可以使用一个只允许读取的接口：

public int GetLongest(IEnumerable<string> list) {
    int len = 0;
    foreach (string s in list) {
        len = Math.Max(len, s.Length);
    }
    return len;
}

通过使用这样的接口，你不仅禁止该方法更改列表，而且它还变得更加灵活，因为它可以使用任何实现该接口的集合，例如字符串数组。

其他一些语言具有 const 关键字，可以将其应用于参数以禁止方法更改它们。 由于 .NET 具有可用于此目的的接口和不可变的字符串，因此实际上不需要 const 参数。

Answer 5

扩展方法的出现使得处理引入副作用的方法变得更加容易。 例如，在您的示例中，说出

public static class Extensions
{
  public static void AddBar(this List<string> list)
  {
     list.Add("Bar");
  }
}

和调用它

mylist.AddBar();

变得更加直观，这使得列表中发生的事情变得更清楚。

正如评论中提到的，这在列表上最有用，因为对列表的修改往往会更加混乱。 对于一个简单的对象，我倾向于只就地修改对象。