不使用ccrewrite时(例如,该项目是由未安装CC的其他开发人员构建的),
是Contract.Requires<T>(cond)
被静默剥离还是仍然导致与if (!cond) { throw new T() }
等效的行为? (我不在乎这是另一个方法调用还是两个方法调用,但是应该“始终检查”。)
我问是因为Contract.Requires<T>
的行为似乎不同于Contract.Requires
,但是我不确定“如何”或“何时”。
目标是替换公共合同上的结构
if (x != null) throw new ArgumentNullException();
与CC兼容的版本,在构建步骤中不执行CC重写时仍会引发异常。
尽管上述带有
EndContractBlock
的方法确实适用于“自定义参数验证”(即,传统合同模式),但我想在项目中使用“标准合同要求”。我相信可能是等效的,因为在“自定义参数验证”模式下,我无法使用
Requires<T>
;如果始终进行的检查没有同等的条件,则了解为什么会很好。我很好地失去了
Requires
,Ensures
,并且当CC重写未完成时留下了非传统的不变契约方法和接口契约,因为我对它们进行静态分析非常重视-但我需要这些始终存在的边界检查来争取保留CC。
最佳答案
请参阅Code Contracts manual。它绝对告诉您所有您需要了解的各种形式的代码合同检查的工作原理,以及在使用每种表单时需要设置哪些选项的信息。Contract.Requires(bool cond)
和Contract.Requires<TException>(bool cond)
有什么区别?
要回答第一个问题,请参阅手册中的2.1前提条件。简而言之,这是区别:Contract.Requires(bool cond)
如果条件评估为Contract.ContractException
,这将引发私有false
异常。您不能捕获此异常(因为从您的角度来看它是私有的),这是为了阻止捕获和处理该异常,从而使合同几乎一文不值。Contract.Requires<TException>(bool cond)
如果条件计算为false
,将抛出指定的TException
。您必须在所有版本上都运行合同工具才能使用此表单。
关于ccrewrite
具体来说,在第20页上的第5节“使用指南”中,它告诉您代码合同可以使用的所有不同形式的合同,它们如何工作以及每种合同的构建要求。
我将简要总结一下,但是请下载并阅读手册。很好,尽管还没有完成,但您必须做大量实验才能了解如何有效使用代码协定。另外,如果您可以使用PluralSight,John Sonmez会开设一个名为Code Contracts的课程,这是一门很好的入门课程。 Michael Perry开设了很棒的课程,称为Provable Code。
发布代码不需要合同检查
如果您不需要在已发布的代码中进行合同检查,则:
随处使用Contract.Requires
仅在调试版本上启用运行时检查。
发布的代码需要进行代码合同检查
如果需要对发布的代码进行合同检查,则有两个选择:
使用代码合同的“本机”前提条件:
在要抛出特定异常的公共API方法(例如,库用户将调用的方法)上使用Contract.Requires<TException>
。 ArgumentException
。
对于非公共API方法或您不想引发特定异常的公共API方法,请使用Contract.Requires
。
在所有版本上启用运行时检查。
确保您启用了仅发出前提条件且仅在装配体的公共表面上发出选项的选项,例如仅库使用者可以调用的那些方法。
使用“旧版”合同检查:
这是您公开API方法上的旧式if (cond) { throw new Exception(...) }
保护块
使用手动继承对派生类型强制执行合同。 (使用选项1时,“代码合同”可以从基类执行合同的自动继承,从而帮助您避免违反Liskov替代原则。)
确保在所有Contracts.EndContractBlock()
块之后放置if (cond) { throw new Exception(...) }
行,以便“代码合同”知道这些是您的合同。
在非公开API方法上,您可以随意在合同中使用Contract.Requires
。
仅在调试版本上启用运行时检查。
关于上述注意事项:调试版本始终启用合同检查。如果您团队中的其他开发人员将构建此库,则他们还需要安装代码合同。
从第5.1.3节:强制项目按合同进行构建:
如果您使用的是方案2(Requires⟨Exn⟩),并使其他开发人员可以使用源代码,则可能要提醒他们他们需要使用工具来构建源代码。如果是这样,则可以在导入CSharp或VisualBasic目标之后,将以下代码段插入到项目文件的末尾:
<PropertyGroup>
<CompileDependsOn>$(CompileDependsOn);CheckForCodeContracts</CompileDependsOn>
</PropertyGroup>
<Target Name="CheckForCodeContracts"
Condition="'$(CodeContractsImported)' != 'true'">
<Error Text="Project requires Code Contracts: http://msdn.microsoft.com/en-us/devlabs/dd491992.aspx" />
</Target>
另外,请参见第6.1节:组装模式,其中告诉您自定义参数验证与标准合同要求之间的区别。本节非常清楚,合同重写器(
ccrewrite
)始终在Debug版本上运行。
关于c# - 不使用ccrewrite,“Contract.Requires <T>”的行为如何?这与“要求”有所不同吗?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/27825005/