不可变只读引用类型和FXCop 违规：不要声明只读可变引用类型

Question

我一直试图解决这个 FXCop 违规问题“DoNotDeclareReadOnlyMutableReferenceTypes”

MSDN：http://msdn.microsoft.com/en-us/library/ms182302%28VS.80%29.aspx

MSDN 中的代码会导致此违规：

namespace SecurityLibrary
{
    public class MutableReferenceTypes
    {
        static protected readonly StringBuilder SomeStringBuilder;

        static MutableReferenceTypes()
        {
            SomeStringBuilder = new StringBuilder();
        }
    }
}

来自 Jon 的回答 此处和此处，我了解保存对象引用的字段（在本例中为 SomeStringBuilder）是只读的并且不是对象本身（由 new StringBuilder() 创建）

因此，以这个例子为例，一旦字段引用了对象本身，我将如何更改对象本身？我喜欢 Eric Lippert 的示例说明了如何更改只读数组，并且希望看到任何其他可变引用类型的类似内容

Answer 1

您不会更改对象的值。这就是规则的要点。任何声明为只读的字段实际上都应该是只读的。拥有只读可变引用是一个矛盾的说法。如果您可以更改字段“指向”的值，那么它就不再是真正的只读了。将某个对象 A 的所有成员的值分配给由字段表示的某个对象 B 或简单地将 A 分配给该字段（当它们具有相同类型时）之间实际上没有功能差异，但是当该字段时只有其中一个有效被声明为只读，但由于您可以有效地改变字段所表示的值，所以正如已经声明的那样，它并不是真正的只读

Answer 2

只读 表示您无法更改参考帖子-建造。

FXCop 的官方立场是，它建议仅将无法修改的类型声明为readonly。因此，像 string 这样的东西是可以的，因为对象的值无法更改。但是，StringBuilder 的值可以更改，但将其设置为只读只会阻止您在构造函数运行后将该字段分配给不同的 StringBuilder 实例或 null 。

我不同意 FXCop 的这条规则。只要人们明白这只是一种强制措施，引用可能不会在构建后改变，那么就不会有混淆。

请注意，值类型通过 readonly 关键字变得不可变，但引用类型则不然。

namespace SecurityLibrary
{
    public class MutableReferenceTypes
    {
        static protected readonly StringBuilder SomeStringBuilder;

        static MutableReferenceTypes()
        {
            // allowed
            SomeStringBuilder = new StringBuilder();
        }

        void Foo()
        {
            // not allowed
            SomeStringBuilder = new StringBuilder();
        }

        void Bar()
        {
            // allowed but FXCop doesn't like this
            SomeStringBuilder.AppendLine("Bar");
        }
    }
}

Answer 3

由于问题中出现了 MutableReferenceTypes 类，因此您无法真正从任何外部调用者处更改它，因为 SomeStringBuilder 字段是私有的。

然而，类本身可能会改变该字段。目前还没有，但在以后的迭代中可能会。

下面是一个示例方法：

public static void Mutate()
{
    SomeStringBuilder.AppendLine("Foo");
}

调用 Mutate 方法将改变该类，因为 SomeStringBuilder 现在已发生更改。

不变性不仅涉及代码的当前版本，还涉及保护自己免受未来错误的影响。并不是所有类都需要是不可变的，但如果您选择创建不可变类型，保持一致是最安全的。

Answer 4

.Net 有一个此处允许的不可变引用类型列表，StringBuilder 不是其中之一。

抱怨是你正在构造的东西不是不可变的，尽管静态构造函数被调用一次并且类被初始化一次，这就是所有保持不变的，其余的都是可变的。一个线程可能会调用 .Append()，然后另一个线程......您会看到字符串构建器本身如何变化，并且不是真正的只读，因为它不断改变状态/变化。

声明它readonly确实是一个用词不当，因为那里引用的对象本身是不断变化的。

Answer 5

您无法更改引用，但对（可变）对象的任何调用都会更改其状态。

因此，由于 SomeStringBuilder （在本例中）本身是可变的，因此它的内容可能会发生变化，这可能会误导该类的用户，因为它并不是真正的“只读”。

基本上，readonly 不以任何方式保证对象敌人不改变，它只是说引用不改变。