不可變的只讀引用類型和FxCop的違規：不申報只讀可變引用類型

Question

我一直在試圖總結我的頭圍繞此的FxCop侵犯「DoNotDeclareReadOnlyMutableReferenceTypes」

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

代碼這將導致此衝突：

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

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

喬恩的回答here和here，據我所知，該領域保持參照對象（在這種情況下， SomeStringBuilder）是隻讀的，而不是對象本身（它由new StringBuilder()創建）

因此，考慮這個例子，一旦字段有引用它，我將如何更改對象本身？我喜歡Eric Lippert's example如何更改只讀數組，並希望看到類似的任何其他可變參考類型

Answer 1

由於MutableReferenceTypes類在問題中提供，因此您無法從任何外部調用者真正改變它，因爲SomeStringBuilder字段是私人的。

但是，該類本身可能會改變該字段。它目前不是，但它可能在以後的迭代中。

下面是一個例子方法：

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

調用發生變異的方法，因爲SomeStringBuilder現在已經改變會產生變異的類。

不變性不僅是關於您的代碼的當前化身，而且還關於保護自己免受未來錯誤的影響。並不是所有的類都必須是不可變的，但如果選擇創建不可變類型，則最安全的做法是保持一致。

Answer 2

.Net有一個不可變參考類型列表允許在這裏，StringBuilder不是其中之一。

抱怨是，你正在構建的是不可改變的，雖然靜態構造函數被調用一次，並且類被初始化一次，這一切都保持不變，其餘都是可變的。一個線程可能會調用.Append()，然後另一個線程...您會看到字符串生成器本身是如何變異的，並不是真的readonly，因爲它會不斷改變狀態/變化。

聲明它readonly確實是一個用詞不當，因爲在那裏引用的對象本身在不斷變化。

Answer 3

您不能更改引用，但（可變）對象上的任何調用都會更改其狀態。

因此，由於SomeStringBuilder（本例中）本身是可變的，所以它的內容可能會改變，這對於類的用戶可能會產生誤導，因爲它不是真正的「只讀」。

基本上，readonly不以任何方式保證對象的敵人沒有改變，它只是說，參考不會改變。

Answer 4

您不會更改對象的值。這是規則的要點。聲明爲只讀的字段應該是隻讀的。有隻讀的可變參考是一個矛盾。如果你可以改變字段「指向」的值，那麼它就不再是隻讀了。將某個對象A的所有成員的值賦值給某個字段所表示的某個對象B，或者簡單地將A賦值給該字段（當它們屬於同一類型時）之間確實沒有功能上的區別，但是隻有其中一個有效時被聲明爲只讀的，但由於您可以有效地改變字段的值，因此已經聲明不是真正只讀的

Answer 5

readonly表示您無法更改參考後構建。

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"); 
     } 
    } 
}