代码合同,空检查和值/引用类型

时间:2011-03-08 18:46:24

标签: c# null code-contracts value-type reference-type

更新帖子:为了避免混淆我现在和未做的事情,我已经彻底编辑了这篇文章,以包含导致此问题的代码的完整示例。为了使这篇文章可读,所有代码都发布在底部。


背景

我正在编写一个流畅的测试界面(我知道它已经完成,但目的的一半是学习它是如何工作的......),我要在其中验证myNumber是否在3和之间10,代码行

myNumber.ShouldBeLessThan(10).And.ShouldBeGreaterThan(10);
myListOfCars.ShouldNotBeNull().And.ShouldBeA<IEnumerable<Car>>();

我认为你可以通过阅读第二行看到它应该验证的内容。当然还有更复杂的测试用例......

为了启用.And语法,我引入了一个名为AndHelper的帮助器类型,它由每个验证方法返回,并且具有返回测试内容的属性And。因此,前一个示例中的.And应返回myNumber,以便我也可以测试另一个条件。

我正在使用代码约定,除其他外,我正在验证某些扩展的this参数是非空的。这是导致我的问题。


我的问题:

在我的代码上运行Code Contract检查时,我收到一堆警告,表示无法验证例如ShouldBeA<T>的非空要求。我试图通过将AndHelper<T>子类化为两个类ReferenceAndHelper<T>StructAndHelper<T>来解决这个问题,而ReferenceAndHelper<T>具有应该保证满足非空要求的合同。但是,这似乎不起作用。

每次我使用其中一个测试扩展时,都会收到两条警告消息。一个说明合同“instance!= null”无法验证,另一个说明位置。第一个指向我使用该方法的行(例如我的第一个示例中的第2行),第二个指向指定合同的行,在我的代码中标有// (1)


我的代码:

请告诉我,这部分帖子很长。我不知道发布大块代码的SO指南(仍然相关),但如果有更好的方法,请赐教。

请注意,本节中的代码不会导致此特定错误,但会对解决方案产生限制。例如,我必须有一个类/结构无知的类型(AndHelper<T>或子类)。

一些测试:

// This test requires that instance != null, and therefore works
// with ReferenceAndHelper<T>
public static ReferenceAndHelper<T> ShouldBeA<T>(this object instance, string message = "")
    where T : class
{
    Contract.Requires<ArgumentNullException>(instance != null); // (1)
    Contract.Ensures(Contract.Result<ReferenceAndHelper<T>>() != null);

    Assert.IsInstanceOf<T>(instance, message.AsNullIfWhitespace() ?? string.Format("ShouldBeA<{0}> failed.", typeof(T).Name));
    return new ReferenceAndHelper<T>((T)instance);
}

// This test should work for both class and struct types T, and therefore
// cannot decide between StructAndHelper<T> and ReferenceAndHelper<T>.
// The base class is used.
public static AndHelper<T> ShouldBeGreaterThan<T>(this T actual, T expected, string message = "")
    where T : IComparable
{
    Contract.Ensures(Contract.Result<AndHelper<T>>() != null);

    (actual.CompareTo(expected) > 0).ShouldBeTrue(message.AsNullIfEmpty() ?? string.Format("ShouldBeGreaterThan failed. {0} is not greater than {1}", actual.ToString(), expected.ToString()));
    return new AndHelper<T>(actual);
}

// This is the test that returns the AndHelper<T> that .And is called on.
// It is, as you can see, in all possible ways specified that this will be a
// ReferenceAndHelper<T>, which has contracts to ensure that the value is not null.
public static ReferenceAndHelper<T> ShouldNotBeNull<T>(this T value, string message = "")
    where T : class
{
    Contract.Requires<ArgumentNullException>(value != null);
    Contract.Ensures(Contract.Result<ReferenceAndHelper<T>>() != null);

    Assert.IsNotNull(value, message.AsNullIfWhitespace() ?? "ShouldNotBeNull failed.");
    return new ReferenceAndHelper<T>(value);
}

AndHelper<T>类:

public class AndHelper<T>
{
    protected readonly T val;

    public AndHelper(T value)
    {
        this.val = value;
    }

    public virtual T And { get { return this.val; } }
}

两个子类ReferenceAndHelper<T>

public class ReferenceAndHelper<T> : AndHelper<T>
    where T : class
{
    public ReferenceAndHelper(T value)
        : base(value)
    {
        Contract.Requires(value != null);
    }

    public override T And
    {
        get
        {
            Contract.Ensures(Contract.Result<T>() != null);
            return val;
        }
    }

    [ContractInvariantMethod]
    void ValueIsNotNullInvariant()
    {
        Contract.Invariant(this.val != null);
    }
}

StructAndHelper<T>

public class StructAndHelper<T> : AndHelper<T>
    where T : struct
{
    public StructAndHelper(T value)
        : base(value)
    {
    }

    public override T And
    {
        get
        {
            return this.val;
        }
    }
}

3 个答案:

答案 0 :(得分:1)

您可以简单地创建一个AndHelper<T>来声明其值不为空的不变量,而不是创建具有不同约束的两个NonNullAndHelper<T>类吗?这只能由辅助函数返回,这些辅助函数可以保证它们的结果非空,这可能是由于需求或其函数的副作用(如IsNotNull)。这应该允许合同证明。

答案 1 :(得分:1)

  

代码合同无法实现   验证和(财产上   AndHelper)永远不会返回null

为什么不呢?除非我误解了你的问题,否则你可以编写类似的代码:

public class AndHelper<T>
{
    protected readonly T val;
    public T And { get { return val; } }

    public AndHelper(T value)
    {
        Contract.Requires(value != null);
        val = value; 
    }

    [ContractInvariantMethod]
    void Invariants()
    {
        Contract.Invariant(And != null);
    }
}

从那里开始,合同检查器将确保And值永远不会为空。

我误解了你的问题吗?

答案 2 :(得分:0)

我知道这是一个老问题,但我看不到可接受的答案,所以我想我会开枪。

不要将AndHelper<T>的两个子类更改为以下AndHelper<T>

public class AndHelper<T>
{
    private readonly T val;

    public AndHelper(T value)
    {
        Contract.Requires(!ReferenceEquals(value, null));

        this.val = value;
    }

    public virtual T And 
    { 
        get 
        { 
            Contract.Ensures(!ReferenceEquals(Contract.Result<T>(), null));

            return this.val; 
        } 
    }

    [ContractInvariantMethod]
    private void ObjectInvariant()
    {
        Contract.Invariant(!ReferenceEquals(val, null));
    }

}

ReferenceEquals(object, object)不会引发泛型类型的警告,但保证它们不为空。