CA1819：属性不应返回数组 - 正确的替代方案是什么？

Question

我之前遇到过这个 FxCop 规则，并且并不真正满足于如何解决违规问题（线程1，线程2）。我现在有另一个案例，我需要纠正违反 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，因为列表支持索引并且与数组非常相似，但我不确定这是否会减慢算法速度，或者 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

将 array[] 更改为 IEnumerable：

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