Как создать API Fluent Nested Guard

Я создаю простой API-интерфейс Guard для защиты от незаконных параметров, передаваемых в функции и т.д.

У меня есть следующий код:

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() и т.д.), Чтобы избежать дублирования кода.

Я не могу понять, как построить параметры функции лямбда/свойства или где должен располагаться метод .Property, т.е. должен ли он быть свойством в GuardArgument или где-то еще, или даже если есть лучшая структура к API.

Ответы

Ответ 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)
     );

Ответ 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);

Ответ 3

Думаю, вы изобретаете колесо здесь. Установите это расширение - Кодовые контракты и здесь 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" );

Но также имеет атрибуты и обширный набор функций для проверки интерфейсов, приятных предварительных и пост-условий и т.д. проверьте его!