C# - 代码合约 - 检测到的表达式语句评估潜在的副作用

Question

我刚刚开始在 C# 中使用 CodeContracts，我可能需要一些帮助。我有一个带有静态键列表的类，并且有一个名为 Remove() 的静态方法，用于从该列表中删除一个键。

现在我从合同后置条件中了解到的是，作为类的程序员，我保证当前的公共方法执行特定的操作，在本例中：删除列表的元素。

这是我写的：

    private static List<Keys> m_usedKeys; // private list of keys

    public static void Remove(Keys _key)
    {
        m_usedKeys.Remove(_key);
        Contract.Ensures(!m_usedKeys.Any(x => x == _key));
    }

我在这里试图“确保”的是，Remove() 方法会从列表中真正删除密钥（是的，这可能是一个简单的例子，但我在那里得到了错误。）

当我编写 Contract.Ensures() 行时，VS2010 给出以下错误：

Error   3   Detected expression statement evaluated for potential side-effect in contracts of method 'LibJungleTimer.KeyBind.Remove(System.Windows.Forms.Keys)'. (Did you mean to put the expression into a Requires, Ensures, or Invariant call?)  C:\Users\Joel\Documents\Programmation\JT\JungleTimer\LibJungleTimer\KeyBind.cs  51

我认为此错误表明表达式 m_usedKeys.remove(_key); 有潜在的副作用。事实上，它有一个副作用，它从列表中删除一个键！

如果我尝试写这样的东西：

Contract.Assert(!m_usedKeys.Any(x => x == _key));

那么它编译得很好。我的问题是我做错了什么？难道 CodeContracts 不应该像这样使用来确保后置条件吗？

编辑：是的，我确实是说！m_usedKeys.Any(...);

Answer 1

代码契约工具假定最后一个 Contract.Ensures / Contract.Requires 之前的任何内容都是契约的一部分...因此它认为您对 Remove< 的调用/code> 是合同的一部分，而不是实施的一部分。您必须反转您的代码，以便所有合约代码都在实现之前。

public static void Remove(Keys _key)
{
    Contract.Ensures(m_usedKeys.Any(x => x == _key));        
    m_usedKeys.Remove(_key);
}

顺便说一句，我怀疑您想要 !m_usedKeys.Any(...)...而且我也会对这段代码保持警惕，因为您没有线程保护地方。如果这是一个实例方法，我不会担心，但访问静态（即全局）状态的静态方法通常应该是线程安全的。