c# – 私有静态只读字段上的代码约定和失败

我班上有一个私有静态只读字段：

public class MyClass
{
    // ISSUE #1 -- requires unproven: path != null
    private static readonly DirectoryInfo MyDirectory =
        new DirectoryInfo(Settings.Default.MyDirectoryPath);

    protected virtual void SomeMethod()
    {
        if (MyDirectory.Exists)
        {
            // ISSUE #2 -- requires unproven: !string.IsNullOrEmpty(path)
            var catalog = new DirectoryCatalog(MyDirectory.FullName);
        }
    }
}

对于问题#1,我使用空合并运算符来默认一些魔术字符串并修复它,但我真的不喜欢这个解决方案.我希望有更好的解决方案.

对于问题#2,我唯一能想到的是使用Contract.Assumes,因为如果我尝试使用Contract.Requires(MyDirectory.Exists ||！String.IsNullOrEmpty(MyDirectory.FullName));它抱怨可见性(在受保护方法的需求中使用的私有字段).

解决方法:

问题#1是Settings.Default.MyDirectoryPath的结果,是Visual Studio生成的代码,没有任何合同.此问题不仅限于空字符串.许多API现在都有合同要求说TimeSpan是非负的,但直接在API中使用设置将生成代码合同警告.

解决此问题的方法是将设置包装在具有契约的方法中.例如.：

String GetMyDirectoryPath() {
  Contract.Ensures(Contract.Result<String>() != null);
  var myDirectoryPath = Settings.Default.MyDirectoryPath;
  Contract.Assume(myDirectoryPath != null);
  return myDirectoryPath;
}

请注意Contract.Assume如何真正执行您的设置验证(代码合同无法验证,因为它由外部配置文件控制).如果它是一个预期非负的TimeSpan,您可以使用Contract.Assume进行验证,从而导致ContractException或其他方法使用您自己的异常.

添加这个额外的层有点单调乏味但是因为设置是在应用程序之外定义的,所以需要在某个时刻对运行时进行验证,就像您必须验证交互式用户输入一样.

问题#2可能是因为DirectoryInfo没有定义任何合同.最简单的方法是使用Contract.Assume.这将声明您认为DirectoryInfo的预期行为,但运行时检查仍将到位以确保您的信念正确(前提是您将检查保留在代码中).

var path = MyDirectory.FullName;
Contract.Assume(!string.IsNullOrEmpty(path));
var catalog = new DirectoryCatalog(path);

标签：c,settings,code-contracts,contracts,requires
来源： https://codeday.me/bug/20190704/1375439.html