在 .NET Core 验证期间检查路由和正文数据之间的一致性

Question

我正在尝试寻找“最佳”方式来检查请求 URL 中的数据与请求正文中的数据之间的一致性。

例如，假设我们有这个 PUT 端点：

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

我可以将 Car 对象作为 body 传递：

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 属性匹配。

实现这一目标的“最佳”方法是什么？当然，我可以简单地在 body 控制器中使用 if 进行检查，但由于这是一个验证任务（或者至少我认为是这样），我希望在我的验证层中有这个逻辑。

---

到目前为止的个人想法

好了，问题结束了，这里我就放一些我尝试过或者想尝试的想法。

---

我有一个自定义操作过滤器来检查验证，我正在尝试使用它来看看我是否可以在那里做某事，或者只在我需要的地方添加另一个自定义操作过滤器想检查连贯性，但这看起来不太乐观。

目前我看到在动作过滤器中我可以通过context.ActionArguments 属性访问控制器方法参数，但我不知道如何检查这些参数是否是“绑定参数”（即有一些[FromXXX] 属性）。如果我能做到这一点，也许我可以检查是否有同名的参数（或同名的属性），然后比较它们的值。但这似乎非常麻烦且不一致。

---

我已经阅读了有关自定义活页夹的内容，但我仍处于摸索阶段（我希望在接下来的几个小时内能学到更多东西）：它们是一种可能的解决方案吗？

Answer 1

你应该这样做：

[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 && 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");
}