接口契約混淆靜態檢查

Question

假設以下簡單的代碼：

public class Foo // : IFoo 
{ 
    private string _field; 

    public string Property 
    { 
     get { return _field; } 
    } 

    private void SetField() 
    { 
     _field = " foo "; 
    } 

    private string Method() 
    { 
     SetField(); 
     return Property.Trim(); 
    } 
} 

的靜態檢查是能證明Property將不爲空時Method使用它。現在

，我介紹一個接口與合同一起和靜態檢查開始抱怨：「可能調用空引用‘this.Property’的方法

這是一個錯誤還是我失去了一些東西？

---

與接口的代碼如下所示：

public class Foo : IFoo 
{ 
    private string _field; 

    public string Property 
    { 
     get { return _field; } 
    } 

    private void SetField() 
    { 
     _field = " foo "; 
    } 

    private string Method() 
    { 
     SetField(); 
     return Property.Trim(); 
    } 
} 

[ContractClass(typeof(IFooContract))] 
public interface IFoo 
{ 
    string Property { get; } 
} 

[ContractClassFor(typeof(IFoo))] 
public abstract class IFooContract : IFoo 
{ 
    public string Property 
    { 
     get { throw new System.NotImplementedException(); } 
    } 
} 

我的設置都像第是：

我得到以下輸出：

[...] 
C:\{path}\CC2.cs(11,19): message : CodeContracts: Suggested ensures: Contract.Ensures(Contract.Result<System.String>() == this._field); 
C:\{path}\CC2.cs(16,13): message : CodeContracts: Suggested ensures: Contract.Ensures(this._field != null); 
C:\{path}\CC2.cs(21,13): message : CodeContracts: Suggested ensures: Contract.Ensures(Contract.Result<System.String>() != null); 
C:\{path}\CC2.cs(21,13): message : CodeContracts: Suggested ensures: Contract.Ensures(this._field != null); 
C:\{path}\CC2.cs(21,13): message : CodeContracts: Suggested ensures: Contract.Ensures(this.Property.Trim() != null); 
C:\{path}\CC2.cs(21,13): message : CodeContracts: Suggested ensures: Contract.Ensures(Contract.Result<System.String>() == this.Property.Trim()); 
[...] 
C:\{path}\CC3.cs(33,13): warning : CodeContracts: Possibly calling a method on a null reference 'this.Property' 
[...] 

我使用Visual Studio 2010旗艦版和.NET 4的目標框架。

Answer 1

如果問題僅表現爲類內代碼 - 這是在我的例子的情況下 - 務實的解決方案很簡單：

使用，而不是屬性的支持字段：

public class Foo : IFoo 
{ 
    private string _field; 

    public string Property 
    { 
     get { return _field; } 
    } 

    private void SetField() 
    { 
     _field = " foo "; 
    } 

    private string Method() 
    { 
     SetField(); 
     return _field.Trim(); 
    } 
} 

Answer 2

不是一個答案，而是對問題的一些想法。這不是那個接口合同，它混淆了代碼合同。我已經設法通過一個簡單的例子來重現這一點，沒有ContractClass的界面。只需將第二個示例更改爲簡單

//Foo's declaration 

public interface IFoo 
{ 
    string Property { get; } 
} 

而且您將得到相同的錯誤。即使在屬性字段中添加Contract.Assume(_field != null);也不能解決此問題（它將修復它將此Assume添加到SetField方法）。我沒有設法用Invariants抑制空引用異常警告。唯一有效的方法是相當難看的解決方案，您必須爲接口合同提供後置條件，並在代碼合同的屬性字段中提供assume的提示。完整的代碼如下所示

public class Foo : IFoo 
{ 
    private string _field; 

    public string Property 
    { 
     get 
     { 
      Contract.Assume(_field != null); 
      return _field; 
     } 
    } 

    private void SetField() 
    { 
     _field = " foo "; 

    } 

    private string Method() 
    { 
     SetField(); 
     return Property.Trim(); 
    } 
} 

---

[ContractClass(typeof(IFooContract))] 
public interface IFoo 
{ 
    string Property { get; } 
} 

[ContractClassFor(typeof(IFoo))] 
public abstract class IFooContract : IFoo 
{ 
    public string Property 
    { 
     get 
     { 
      Contract.Ensures(Contract.Result<string>() != null); 
      throw new NotImplementedException(); 
     } 
    } 
} 

編輯： 作爲_field可以爲空，我建議使用這種方法的機身給予提示，分析儀，使其不會與空理會參考警告。

private string Method() 
{ 
    SetField(); 
    Contract.Assume(Property != null); 
    return Property.Trim(); 
} 

p.s.正如John Sonmez在pluralsight training regarding Code contracts上所說的那樣「靜態分析是一項複雜而神祕的任務，如果沒有提示啓動Assume方法調用的分析器，那麼這個任務幾乎無法解決。