接口契约混淆静态检查

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方法调用的分析器，那么这个任务几乎无法解决。