如何构建流畅的嵌套防护 API

Question

我正在构建一个简单的 Guard API 以防止将非法参数传递给函数等。

我有以下代码：

public static class Guard
{
    public static GuardArgument<T> Ensure<T>(T value, string argumentName)
    {
        return new GuardArgument<T>(value, argumentName);
    }
}

public class GuardArgument<T>
{
    public GuardArgument(T value, string argumentName)
    {
        Value = value;
        Name = Name;
    }

    public T Value { get; private set; }
    public string Name { get; private set; }
}

// Example extension for validity checks
public static GuardArgument<T> IsNotNull<T>(this GuardArgument<T> guardArgument, string errorMessage)
{
    if (guardArgument.Value == null)
    {
        throw new ArgumentNullException(guardArgument.Name, errorMessage);
    }

    return guardArgument;
}     

目前，代码可以以类似的方式使用（注意这只是一个愚蠢的例子）：

void DummyMethod(int? someObject) {

    Guard.Ensure(someObject, "someObject")
       .IsNotNull()
       .IsGreaterThan(0)
       .IsLessThan(10);
}

这一切都很好。我现在想要做的是扩展 API 以通过以下方式在检查中包含子属性：

Guard.Ensure(someObject, "someObject")
    .IsNotNull()
    .Property(
        (x => x.ChildProp1, "childProp1")
           .IsNotNull()
           .IsGreaterThan(10)
     )
     .Property(
        (x => x.ChildProp2, "childProp2")
           .IsNotNull()
           .IsLessThan(10)
     );

显然，新的.Property 方法需要返回父GuardArgument 才能链接。此外，子属性需要能够使用现有的检查方法（IsNotNull() 等）以避免代码重复。

我不知道如何构造 lambda/Property 函数参数或 .Property 方法的位置 - 即它应该是 GuardArgument 或其他地方的属性，或者即使有更好的结构到 API。

Answer 1

以下函数允许使用与您想要的类似的语法。

public static GuardArgument<T> Property<T, TProp>(this GuardArgument<T> guardArgument, Func<T, TProp> getProperty, string propertyName, Action<GuardArgument<TProp>> validate)
{
    GuardArgument<TProp> propertyGuardArgument = new GuardArgument<TProp>(getProperty(guardArgument.Value), propertyName);

    validate(propertyGuardArgument);

    return guardArgument;
}

该函数为所选属性创建一个新的 GuardArgument，然后将其传递给 Action 参数，以便您根据需要进行验证。

这也允许无限链接属性，虽然我不确定这是否特别可读。

用法：

Guard.Ensure(someObject, "someObject")
     .IsNotNull()
     .Property(x => x.ChildProp1, "childProp1", childProp1 =>
         childProp1.IsNotNull()
                   .IsLessThan(10)
                   .Property(y => y.InnerChildProperty, "innerChildProperty", innerChildProperty =>
                       innerChildProperty.IsNotNull()
                    )
     )
     .Property(x => x.ChildProp2, "childProp2", childProp2 =>
         childProp2.IsNotNull()
                   .IsGreaterThan(10)
     );

Answer 2

我认为将属性检查放在父对象检查链中没有任何好处。所以我建议为父对象创建一个链，为每个属性创建另一个链。这更具可读性：

  Guard.Ensure(a, "a")
    .IsNotNull("a is null");
  Guard.Ensure(a.p0, "a.p0")
    .IsGreaterThan(10);
  Guard.Ensure(a.p1, "a.p1")
    .IsGreaterThan(5);

Answer 3

我认为你在这里重新发明了一个轮子。安装此扩展程序 - Code Contracts，这里是 docs 如何使用它。

除了类似于您的基于代码的断言，即：

 public int[] Bar(){
   Contract.Ensures( Contract.ForAll(0, Contract.Result<int[]>().Length, index => Contract.Result<int[]>()[index] > 0));

 ....
 }

或

 Contract.Requires<ArgumentNullException>( x.Value.NestedObject != null, ”x.Value.NestedObject” );

但也有用于检查接口、良好的前置条件和后置条件等的属性和广泛的功能集。看看吧！