IReadOnlyCollection 与 ReadOnlyCollection

Question

关于 SO 已经有几个类似的问题，但我发现没有一个问题真正涉及到这个特定主题，所以就在这里......

我的理解是，应该始终尝试通过具体类返回接口。不会深入探讨其背后的原因，关于这方面的内容已经很多了。

但是对于 IReadOnlyCollection 与 ReadOnlyCollection 的情况，我不确定是否应该遵循该规则。

IReadOnlyCollection 可以轻松转换为 List，这...嗯...打破合同承诺的ReadOnly 方面。

ReadOnlyCollection 但是不能转换为List，但这意味着返回一个具体的类。

从长远来看，这真的重要吗？在我看来，在大多数情况下ReadOnly*/IReadOnly* 对象仅由方法或只读属性返回。

因此，即使用户决定将其转换为其他东西（在 IReadOnly* 对象的情况下）或使用 LINQ 从中创建某种集合（在 ReadOnly* 对象的情况下），暴露ReadOnly*/IReadOnly* 对象的类真的不可能接受它。

那么这里的建议是什么，返回一个IReadOnly* 接口还是一个具体的ReadOnly* 类实例？

Answer 1

微软的指导方针herestate：

✓ 务必使用ReadOnlyCollection，ReadOnlyCollection<T> 的子类，或者在极少数情况下使用IEnumerable<T> 来表示表示只读集合的​​属性或返回值。

所以，基本上，你应该返回ReadOnlyCollection<T>。它在其他情况下指定接口IEnumerable，因此如果它打算使用接口IReadOnlyCollection<T>，它会这样说明。

Answer 2

您绝对应该尝试让您的公共方法返回接口。

如果您担心类的调用者会强制转换和修改您的内部结构，例如在本例中，不应从外部触及类的内部队列：

public class QueueThing
{
    private List<QueueItem> _cantTouchThis;

    public IReadOnlyCollection<QueueItem> GetQueue()
    {
        return _cantTouchThis;
    }
}

然后你可以使用AsReadOnly()返回一个新的ReadOnlyList<T>，来源于私有List<T>：

public class QueueThing
{
    private List<QueueItem> _cantTouchThis;

    public IReadOnlyCollection<QueueItem> GetQueue()
    {
        return _cantTouchThis.AsReadOnly();
    }
}

现在调用者可以随心所欲地转换返回值，他们将无法修改_cantTouchThis 成员（当然，除非他们打算使用反射，但无论如何，所有赌注都已关闭）。

鉴于许多类型都可以实现一个接口，这种方法的用户绝对不应该假设将方法的返回值转换为任何具体类型是安全的。

Answer 3

IReadOnlyCollection<T> 只能转换为 List<T> 如果基础对象属于该类型。例如ReadOnlyCollection<T> 也实现了IReadOnlyCollection<T>。

所以我的建议，返回IReadOnlyCollection<T>，如果你担心调用者会错误地将它转换为不应该的东西，请确保底层类型是ReadOnlyCollection<T>

public IReadOnlyCollection<User> GetUsers()
{
   return new ReadOnlyCollection<User>();
}

但是返回 IReadOnlyCollection<T> 应该足以让函数调用者理解它应该是只读的。
请注意，您永远无法使用ReadOnlyCollection<T> 完全保护您的代码，调用者仍然可以使用反射来访问内部列表并对其进行操作。
在这种情况下，唯一的选择是在列表中创建一个副本并将其返回。