【问题标题】:"Does not contain whitespace" in Code Contracts?代码合同中的“不包含空格”?
【发布时间】:2015-02-13 16:41:16
【问题描述】:

我是 Code Contracts 的新手 - 刚开始尝试弄明白。我刚刚遇到了一些我不确定如何完成的事情:

我有一个可以通过属性公开“获取”的私有只读字段:

private readonly string name;
public string Name
{
    get
    {
        return this.name;
    }
}

此字段不得为空,不得为空,且不得包含任何空格。所以我在构造函数中放入了各种“Requires”来尝试确保这些东西:

public Thing(string name)
{
    Contract.Requires<ArgumentNullException>(
        name != null, 
        "Name must not be null");
    Contract.Requires<ArgumentException>(
        name.Length > 0,
        "Name must have positive length");
    Contract.Requires<ArgumentException>(
        !name.Any(x => char.IsWhiteSpace(x)),
        "Name must not include whitespace");

    this.name = name;
}

输入一些代码来尝试违反这些协定表明静态检查器成功地捕获了“not null”和“not empty”的违规行为,但它没有捕获“不包含空格”的违规行为。我想这并不奇怪?我猜它会在编译时进行某些简单的检查(如“!= null”),但其他更复杂的检查(如 linq 检查空格)除了可能在运行时之外没有完成?

不管怎样,我随后在类中添加了一些不变量来尝试描述这些相同的东西:

[ContractInvariantMethod]
private void ContractInvariants()
{
    Contract.Invariant(this.name != null);
    Contract.Invariant(this.name.Length > 0);
    Contract.Invariant(!this.name.Any(x => char.IsWhiteSpace(x)));
}

这导致我的构造函数(上面引用)出现以下警告(至少,警告级别设置为高):

CodeContracts: invariant unproven: !this.name.Any(x => char.IsWhiteSpace(x))

但构造函数将 this.name 设置为需要相同合约的局部变量的值!

我的 Requires 和/或我的 Invariant 没有按照我的意愿去做吗?有没有办法让他们做我打算让他们做的事情?我是否应该试图让他们做我一开始就打算让他们做的事情?我只是从根本上误解了这里的事情吗?就像我说的,我对此完全陌生。感谢您的指导。

【问题讨论】:

  • Contract.ForAll 可能值得一试,但我自己在这方面取得的成功有限。

标签: c# .net code-contracts


【解决方案1】:

代码合约旨在通过在编译时推理关于要求和确保来证明假设。但是这个问题是无法确定的,因此不可能验证一切(即使使用将在数千年内发明的技术,从根本上 - 证明 - 也是不可能的)。然而,保守算法可以证明部分陈述,并警告程序员它无法证明其他陈述或证明合同将受到损害。

您的不变量有一些问题,您在其中调用 Linq 方法,并且可能 Linq 方法本身不提供(必要的)代码契约来执行合理推理。您不必为所有方法提供合同。系统有时能够推理代码并自行推理。但不总是。例如,数组列表的代码不需要提供Count 始终大于或等于零的指示...

然而,代码契约有一些内置函数可以处理集合,例如 Contract.ForAll 函数:

Contract.Invariant(
    Contract.ForAll(this.name, x => !char.IsWhiteSpace(x))
);

这有更多的机会得到验证,但同样不能保证这会发生很大变化。代码合约既不会被证明,也不会被证明是错误的。

【讨论】:

  • 谢谢。不过,这似乎无济于事(我确实意识到你说不能保证它会)。我将 Requires 和 Invariant 都更改为使用 ForAll,但我仍然得到“未经证实的不变式”。此外,当我故意添加代码以违反要求时,静态检查器仍然不会跳闸。
  • @BobVesterman:您能否提供明确验证约束的场景?从人类的角度来看,有些事情看起来很简单,但系统也会担心异常,...
  • 当然:如果我像这样向其他成员函数添加一些代码:Thing t = new Thing(null);,那么我会收到 CodeContracts 警告,即调用该成员函数将始终导致错误。但是,如果我改为添加 Thing t = new Thing("white space in here");,则不会收到此类警告。
【解决方案2】:

您应该改用Contract.Invariant(!string.IsNullOrWhitespace(value))。它将同时涵盖所有三种情况,并且 CodeContract 引擎可能也能够在编译时支持它。

【讨论】:

  • String.IsNullOrWhitespace 是别的东西:假设你有字符串"Foo Bar":它包含一个空格,但它不是null 它也不只包含空格...
  • 好点,我想我误解了你的问题。在这种情况下,CommuSoft 的回答是正确的。无论哪种方式,您仍应使用 string.IsNullOrEmpty 将您的 null 和 length 合同合并为一个合同。
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2018-07-20
  • 1970-01-01
  • 2021-11-23
  • 1970-01-01
  • 2015-09-01
  • 1970-01-01
相关资源
最近更新 更多