需要 CodeContracts 的建议

Question

嗨，大家好 我是 CC 新手，需要您的建议。我在上一个项目中从 CC 开始。我有一份 WCF 合同，应由第三方执行。我想将代码合同分配给服务合同。假设我有一个 Car 类（服务合约），它是 OperationContract ICar。 ICar 有一个 GetCar() 方法，正如我上面所说，应该由我们的客户实现。我为 Icar 创建一个代码 Contract 类，并在 GetCar 方法中使用 CarContractHelper 类验证合同。我引入了一个帮助程序类，它通过以下方式验证 Car 类：Contract.Ensure(CarContractHelper.Validate(Contract.Result()))。这是解决问题的正确方法吗？或者有什么更好的办法吗？ 我还在它的设置器中验证 Car 类的每个属性成员，您对此有何看法，是必要的还是矫枉过正？ 谢谢 当然，我会标记正确的答案并投票:)

更新

---

@StriplingWarrior 我引入了汽车验证助手来处理重复的合同验证代码。例如：

Contract.Requires(!string.IsNullOrWhiteSpace(car.Id);
Contract.Requires(car.Mileage > 0);

等等。我没有到处编写 Contract.Requires 代码，而是为每个业务对象创建一个辅助类来验证业务对象的合同。这就是我想知道的，如果这是一个正确的方法，或者也许有更好的方法？ 谢谢。

PS 我正在验证它们自己的 setter 中的每个属性，因为不变方法对我不起作用（？），据我所知，当调用类的任何方法时，不变方法都有效，在我的情况下，wcf 合同不起作用没有任何方法。所以我选择验证内部属性设置器。这是一个好方法吗？

Answer 1

我没有对代码契约做太多研究，但这里有一些观察结果：

代码契约的优点之一是能够查看特定方法的契约并了解预期内容。看到 CarContractHelper.Validate(Contract.Result()) 并没有真正告诉我任何信息，所以我必须深入了解（例如）返回值的 CarId 大于零。因此，在某种程度上，我宁愿看到 Contract.Ensure(Contract.Result().CarId > 0)，也许还有一些其他要求。另一方面，我可以看到这会如何创建大量重复的合约代码，如果（例如）您向 Car 类添加了新属性，这些代码将很难管理。

代码契约的另一个潜在优势是能够对您的需求进行编译时检查。例如，考虑以下代码：

var car = _carService.GetCar();
_crashTestUtil.TestCar(car);

如果 TestCar 的合同要求 car.CarId > 0，并且 GetCar() 未能确保情况确实如此，编译器可以警告您这一事实。为了使其与验证帮助器类一起使用，我想您需要确保您的验证帮助器类也使用代码契约方法来进行契约检查。

即使您正在对 Car 类的属性设置器执行检查，我确实认为在此方法返回之前验证所有必需的值是否已设置仍然有意义。

Answer 2

虽然代码契约可以用于此目的，但我个人不会以这种方式使用它。我认为纯粹的验证属于领域层（假设您使用某种领域驱动的方法），并且汽车应该能够在有或没有代码契约的情况下进行验证。

在我看来，如果您的 API 处理无效的汽车或抛出适当的异常，那就更好了。如果您使用代码合约来检查汽车的有效性，您只有 2 个选项：1. 汽车有效 2. 汽车无效，ContractException（或您自己的异常）。

我是代码合同的支持者，但宁愿看到合同更详细。您绝对应该尝试使不变式发挥作用。另一种方法是在您的界面上定义合约。