CA1819：属性不应返回数组 - 什么是正确的选择？

Question

我之前遇到过这个 FxCop 规则，对如何解决违规问题并不满意（thread1、thread2）。我现在有另一个案例，我需要更正违反 CA1819 类型的行为。

具体来说，我有一个算法库，可以对曲线 (x,y) 执行一些分析计算，其公共“输入对象”如下所示：

public class InputObject
{
        public double[] X { get; set; }
        public double[] Y { get; set; }
        // + lots of other things well
}

该对象的 X 和 Y 属性在库中的数百个位置使用，通常使用索引。输入对象永远不会被算法改变，但实际上它应该没有关系。此外，.Length 也经常被调用。这是一个数学库，double[] 是其中的一种标准数据类型。无论如何，修复 CA1819 需要相当多的工作。

我考虑过使用List<double>，因为列表支持索引并且与数组非常相似，但我不确定这是否会减慢算法速度，或者 FxCop 是否会对这些列表感到满意。

替换这些double[] 属性的最佳选择是什么？

Answer 1

如果它对外部消费者是只读的，并且消费者不想通过索引访问它，那么最好有一个IEnumerable<> 类型的公共只读属性，并带有方法访问器来添加和删除，这样你就不会必须将您的数组暴露给某人来捣乱。

如果您需要访问索引器，请将其公开为 IList<> 类型的只读属性，并可能返回一个 ReadOnly 实例，其中包含添加和删除方法。

这样您可以保持内部列表的封装，并允许消费者以只读方式访问它

Answer 2

在我看来，FxCop 有时会夸大其词。

这完全取决于您必须做什么，如果您正在编写一个需要安全性和非常干净的代码的复杂系统，您应该返回该数组的只读版本。 也就是说，按照 devdigital 的建议将数组转换为 IEnumerable，或者使用我更喜欢的 Mohamed Abed 的 ImmutableArray 的好主意。

如果您正在编写需要高性能的软件...在 C# 中，没有什么比数组更好的了。 数组在迭代和读取方面的性能要好得多。

如果性能真的很重要，我建议您忽略该警告。 返回一个只读数组仍然是合法的，如果不是太干净的话。

for (int i = 0; i < array.Length; ++i) { k = array[i] + 1; }

这对于 C# 中的大数组来说非常快：它避免了数组边界检查。 它的性能与 C 编译代码的性能非常相似。

我一直希望在 C# 中有一个“只读数组”类型 :) 但没有希望看到它。

Answer 3

正如您的链接所示：

要修复违反此规则的行为，请将属性设为方法或 更改属性以返回集合。

使用诸如List 之类的集合应该不会对性能产生重大影响。

Answer 4

这里最大的问题并不是你的库对值做了什么（这是一个潜在的问题，尽管它更易于管理），而是调用者可能对这些值做了什么。如果您需要将它们视为不可变的，那么您需要确保库使用者在原始分配后无法更改内容。此处的简单解决方法是创建一个接口，该接口公开您的库使用的所有数组成员，然后为实现此接口的数组创建一个不可变的包装类，以在您的InputObject 类中使用。 例如：

public interface IArray<T>
{
    int Length { get; }

    T this[int index] { get; }
}

internal sealed class ImmutableArray<T> : IArray<T>
    where T : struct
{
    private readonly T[] _wrappedArray;

    internal ImmutableArray(IEnumerable<T> data)
    {
        this._wrappedArray = data.ToArray();
    }

    public int Length
    {
        get { return this._wrappedArray.Length; }
    }

    public T this[int index]
    {
        get { return this._wrappedArray[index]; }
    }
}

public class InputObject
{
    private readonly IArray<double> _x;
    private readonly IArray<double> _y;

    public InputObject(double[] x, double[] y)
    {
        this._x = new ImmutableArray<double>(x);
        this._y = new ImmutableArray<double>(y);
    }

    public IArray<double> X
    {
        get { return this._x; }
    }

    public IArray<double> Y
    {
        get { return this._y; }
    }

    //...
}

如果 T 是可变的，则“不可变”数组内容中的元素仍然是可变的，但至少对于 double 类型是安全的。

Answer 5

将数组 [] 更改为 IEnumerable：

public class InputObject
{
    public IEnumerable<double> X { get; set; }
    public IEnumerable<double> Y { get; set; }
    // + lots of other things well
}