在 FluentValidation for WebApi 2 中访问路由数据

Question

我有一个基本的 C# Web Api 2 控制器，它有一个 POST 方法来创建实体

public HttpResponseMessage Post(UserModel userModel){ ... }

还有一个 PUT 方法来更新所述模型

public HttpResponseMessage Put(int id, UserModel userModel) { ... }

这里是用户模型

public class UserModel
{
    public virtual Name { get; set; }
    public virtual Username { get; set; }
}

对于我的验证器，我想验证该名称未在 Post 上使用 - 很简单。对于 PUT，我需要验证该名称是否未被其他用户使用，但当然该特定用户将具有相同的用户名。

public class UserModelValidator : AbstractValidator<UserModel>
{
    public UserModelValidator()
    {
        RuleFor(user => user.Username)
            .Must(NotDuplicateName).WithMessage("The username is taken");

    }

    private bool NotDuplicateName(string username)
    {
        var isValid = false;

        //Access repository and check to see if username is not in use
        //If it is in use by this user, then it is ok - but user ID is
        //in the route parameter and not in the model.  How do I access?

        return isValid;
    }
}

我正在使用 AutoFac，所以也许有一种方法可以将 HttpRequest 注入验证器并以这种方式获取路由数据。

或者我可以创建一个模型绑定器来查找路线数据并将其添加到模型中？

或者有什么简单的方法吗？

Answer 1

我找到了另一种解决方案，将IActionContextAccessor 注入验证器。有了这个，我可以访问 ROUTE 参数而不需要特殊的模型绑定。

Startup.cs

services.AddHttpContextAccessor();
services.AddSingleton<IActionContextAccessor, ActionContextAccessor>();

UserModelValidator.cs

public class UserModelValidator : AbstractValidator<UserModel>
{
    public UserModelValidator(IActionContextAccessor actionContextAccessor)
    {
        RuleFor(item => item.Username)
            .MustAsync(async (context, username, propertyValidatorContext, cancellationToken) =>
            {
                var userId = (string)actionContextAccessor.ActionContext.RouteData.Values
                .Where(o => o.Key == "userId")
                .Select(o => o.Value)
                .FirstOrDefault();

                return true;
            });
    }
}

Answer 2

最简单的方法当然是将Id 添加到UserModel。不过，您必须对 Post 和 Put 操作添加一些额外的检查。当客户提供Id 时，第一个应该忽略它。第二个可以检查路径中的Id是否与模型中的Id相同。如果没有，则返回BadRequest。

改变的模型：

public class UserModel
{
    public virtual Id { get; set; }
    public virtual Name { get; set; }
    public virtual Username { get; set; }
}

改变方法：

public HttpResponseMessage Post(UserModel userModel)
{
   // ignore provided userModel.Id
}

public HttpResponseMessage Put(int id, UserModel userModel)
{
   if(id != userModel.Id)
   {
       // return bad request response
   }
}

更新

正如您评论的那样，在路线和模型中都有一个 Id 确实允许两者之间存在差异。尊重的 API 使用者可能不会发布带有未对齐 Id 的请求。但是恶意消费者（又名黑客）很可能会这样做。因此，当 Id 不匹配时，您应该返回 BadRequest。

您当然不想使用您提到的 Id 更新 UserModel，否则您最终可能会被用户 2 的详细信息（UserModel 中的那个）覆盖用户 1（url 中的那个） )。