代码合约最佳实践

Question

我有几个关于代码契约及其使用最佳实践的问题。假设我们有一个类，具有多个属性（例如见下文）：

class Class1
{
    // Fields
    private string _property1;       //Required for usage
    private List<object> _property2; //Not required for usage

    // Properties
    public string Property1 
    { 
        get
        {
            return this._property1;
        }            
        set
        {
            Contract.Requires(value != null);
            this._property1 = value;
        } 
    }
    public List<object> Property2 
    { 
        get
        {
            return this._property2;
        }
        set
        {
            Contract.Requires(value != null);
            this._property2 = value;
        }
    }

    public Class1(string property1, List<object> property2)
    {
        Contract.Requires(property1 != null);
        Contract.Requires(property2 != null);

        this.Property1 = property1;
        this.Property2 = property2;
    }

    public Class1(string property1)
        : this(property1, new List<object>())
    { }
}

关于我想要实现的目标的一些解释：

（a）property1 是必填字段。 property2 对于对象的正常使用来说并不是明确需要的。

我有以下问题：

1. 我是否应该考虑财产合同2；因为 property2 不是必填字段，所以它应该有合同吗？在 property2 上放置契约是否表明该对象的正常使用实际上需要它；

2. 尽管 property2 没有明确要求，但它不可能为空，因此是在 setter 处定义的契约。在 property2 上定义契约不会减少调用代码中的 null 检查吗？这应该会减少 bug 并提高代码的可维护性 - 这个假设正确吗？

3. 如果是正确的，我如何确保调用代码时property2永远不会为空？我是否使用 Contract.Invariant(property2 != null);或Contract.Ensures(property2 != null)在构造函数中，或Contract.Ensures(property2 != null)在Init()中，或Contract.Ensures(property != null)在setter中？ （即，如果使用 Contract.Ensures(property2 != null)，它放在哪里）？

如果问题看起来很简单，我很抱歉。我只是在寻找对此事的想法，以及你们认为的最佳实践。

Answer 1

这就是我对契约的建议：

    class Class1
    {
        // Fields
        private string _property1;       //Required for usage
        private List<object> _property2; //Not required for usage

        // Properties
        public string Property1
        {
            get
            {
                Contract.Ensures(Contract.Result<string>() != null);
                return this._property1;
            }
            set
            {
                Contract.Requires(value != null);
                this._property1 = value;
            }
        }

        public List<object> Property2
        {
            get
            {
                Contract.Ensures(Contract.Result<List<object>>() != null);
                return this._property2;
            }
            set
            {
                Contract.Requires(value != null);
                this._property2 = value;
            }
        }

        public Class1(string property1, List<object> property2)
        {
            Contract.Requires(property1 != null);
            Contract.Requires(property2 != null);

            this.Property1 = property1;
            this.Property2 = property2;
        }

        public Class1(string property1)
            : this(property1, new List<object>())
        {
            Contract.Requires(property1 != null);
        }

        [ContractInvariantMethod]
        private void ContractInvariants()
        {
            Contract.Invariant(_property1 != null);
            Contract.Invariant(_property2 != null);
        }
    }

属性有其公共行为契约，并且当您向 Class1 添加逻辑时，不变量将捕获您稍后可能引入的任何错误，这些错误可能会修改字段值，从而违反公共契约。或者，如果可以将字段设置为只读（并且删除设置器），则不需要不变量。

Answer 2

我认为这里有很多个人偏好，但我的 2 美分......

1）我会，并且可能会试图调整构造函数以将 property2 作为可选参数：

Class1(string property1, List<object> property2 = new List<object>())      
{      
    Contract.Requires(property1 != null);      
    Contract.Requires(property2 != null);      

    this.Property1 = property1;      
    this.Property2 = property2;      
} 

2）参见 3

3）在我之前很高兴减少调用代码中的空检查，我个人更喜欢

Contract.Ensures(property2 != null) 

在 getter 上看到 a - 我已经看到 VS11 CTP 在定义的工具提示中显示了契约，因此能够看到这一点，我就知​​道我不需要查看对于空值。我会将 Requires 保留在设置器上。

Answer 3

通常，当对象中有一个列表时，您将让该对象负责创建。因此，如果消费者希望添加到列表中，他们必须首先获取它。根据此类的使用情况，这可能是更好的路线。

class Class1
{
    // Fields
    private string _property1;       //Required for usage
    private List<object> _property2 = new List<object>(); //Not required for usage

    // Properties
    public string Property1 
    { 
        get
        {
            return this._property1;
        }            
        set
        {
            Contract.Requires(value != null);
            this._property1 = value;
        } 
    }
    public List<object> Property2 
    { 
        get
        {
            return this._property2;
        }
        //We don't have a setter.
    }

    public Class1(string property1)
    {
        Contract.Requires(property1 != null);

        this.Property1 = property1;
    }
}

Answer 4

1/2：如果您想要强制执行这种行为，那么在 property2 上签订合同是合适的，即它不应该为 null，并且肯定会减少对 null 检查的需要以及围绕 null 的潜在错误。

3：为了回答这个问题，我重写了您的类，如下所示

class Class1
{
    //Properties
    public string Property1 { get; set; }
    public List<object> Property2 { get; set; }

    public Class1(string property1, List<object> property2)
    {
        Contract.Requires(property1 != null);
        Contract.Requires(property2 != null);

        Property1 = property1;
        Property2 = property2;
    }

    public Class1(string property1)
        : this(property1, new List<object>())
    { 
        Contract.Requires(property1 != null);
    }

    [ContractInvariantMethod]
    private void ObjectInvariant()
    {
        Contract.Invariant(Property1 != null);
        Contract.Invariant(Property2 != null);
    }
}

当您的类中有自动实现的属性时，您可以使用Contract.Invariant()。这使得您的财产中的显式合同变得多余，因此现在不需要以下代码。

public string Property1 
{ 
    get
    {
        Contract.Ensures(Contract.Result<string>() != null);
        return this._property1;
    }            
    set
    {
        Contract.Requires(value != null);
        this._property1 = value;
    } 
}

这将照顾到财产保护。为了完全确保该属性永远不会为 null，您将在构造函数中添加 Contract.Requires(property1 != null)。

我知道这个答案迟了三年，但可能对你有用！

来源：http://research.microsoft.com/en-us/projects /contracts/userdoc.pdf