Блог

Я пытаюсь найти «лучший» способ проверить согласованность между данными в URL-адресе запроса и данными в теле запроса.

Например, допустим, у нас есть эта конечная точка PUT:

 https://host:port/foo/bar/{carId}
 

где я могу передать объект Car как тело:

 class Car {
   string CarId { get; set; }
   string Brand { get; set; }
   int MaxSpeed { get; set; }
   ...
}
 

Теперь в моем контроллере у меня есть что-то вроде этого:

 [HttpPut("foo/bar/{carId}")]
public async Task updateCar([FromRoute] string carId, [FromBody] Car car) {
    ...
}
 

И я хочу быть уверен, что carId в маршруте соответствует CarId свойству в теле.

Каков «лучший» способ добиться этого? Конечно, я мог бы просто проверить с if помощью контроллера в теле, но поскольку это задача проверки (или, по крайней мере, я так думаю), я хотел бы иметь эту логику в моем уровне проверки.

Пока что личные идеи

Хорошо, вопрос исчерпан, здесь я просто изложу некоторые идеи, которые я пробовал или хочу попробовать.

У меня есть пользовательский фильтр действий для проверки проверки, и я пытаюсь поиграть с ним, чтобы посмотреть, смогу ли я что-то там сделать, или добавить другой пользовательский фильтр действий только там, где я хочу проверить согласованность, но это не выглядит многообещающим.

На данный момент я видел, что в фильтре действий у меня есть доступ к параметрам метода контроллера через context.ActionArguments свойство, но я не знаю, как проверить, были ли эти аргументы «связанными аргументами» (а именно имели некоторый [FromXXX] атрибут). Если бы я мог это сделать, возможно, я мог бы проверить, есть ли аргументы с тем же именем (или со свойством с тем же именем), а затем сравнить их значения. Но это кажется очень громоздким и непоследовательным.

Я читал о пользовательских связующих, но я все еще царапаю поверхность (я надеюсь узнать что-то еще в ближайшие несколько часов): могут ли они быть возможным решением?

Вы должны сделать это так:

 [AttributeUsage(AttributeTargets.Property)]
public class VerifyWithRouteParams : Attribute
{
   public string ParamName
   {
      get
      {
        return paramName;
      }
   }

   private readonly string paramName;

   public VerifyWithRouteParams(string paramName)
   {
       this.paramName = paramName;
   }
}
 

Предположим, у вас есть модель автомобиля, которая передается через тело:

 public class Car
{
    [VerifyWithRouteParams("carId")]
    public string CarId { set; get; }

    public string AnotherParam {set; get;}
}
 

У вас должен быть фильтр по умолчанию:

 public class RouteBodyVerificationActionFilter : IActionFilter
{
    public void OnActionExecuted(ActionExecutedContext context)
    {
    }

    public void OnActionExecuting(ActionExecutingContext context)
    {
        // do something before the action executes
        if (context.ActionArguments != null amp;amp; context.ActionArguments.Count > 0)
        {
            foreach (var arg in context.ActionArguments)
            {
                if (arg.Value == null) continue;

                bool isThereAnyObjectInArgumentsWithVerificationAttribute = arg.Value
                .GetType()
                .GetProperties()
                .Any(
                        x => x.GetCustomAttributes(typeof(VerifyWithRouteParams), false).Any()
                    );

                if (isThereAnyObjectInArgumentsWithVerificationAttribute)
                {
                    foreach (var prop in arg.Value.GetType().GetProperties())
                    {
                        var verificationAttr = prop.GetCustomAttributes(typeof(VerifyWithRouteParams), false).FirstOrDefault() as VerifyWithRouteParams;
                        if (null == verificationAttr) continue;

                        string routeArgumentName = verificationAttr.ParamName;
                        context.ActionArguments.TryGetValue(routeArgumentName, out var routeArgumentValue);

                        if (null == routeArgumentValue)
                        {
                            context.ModelState.AddModelError("invalid argument value", routeArgumentName);
                        }

                        if (routeArgumentValue?.Equals(prop.GetValue(arg.Value)) != true)
                        {

                            context.ModelState.AddModelError("invalid argument value", routeArgumentName);
                        }
                    }
                }
            }
        }
    }
}
 

Затем вы должны добавить фильтр по умолчанию в автозагрузке:

 services.AddControllers(cfg =>
{
    cfg.Filters.Add<RouteBodyVerificationActionFilter>();
});
 

Затем вы можете проверить это с помощью ошибок проверки модели в контроллере:

 if (!ModelState.IsValid)
{
   return Content("invalid model");
}