Web Api中使用特性进行参数自动校验

参数校验

现代化的应用越来越偏向于使用前后端分离的程序架构，对比传统的前后端高度耦合的应用，前后端分离开发不仅能使开发效率有所提高，而且代码质量也会更有保证。
在传统的WebForms项目中，前端和后台高度耦合，通常来说，一个后台只会对应一个前端所以接口的参数校验既可以在前端做，也可以在后台做，甚至可以交给数据库做(虽然可以这样做，但不推荐)；而在前后端分离的架构中，服务端一般采用Web Api的模式向任意前端提供HTTP接口，这时候服务端就不能完全信任前端提交的数据，必须自己做一次参数校验。

传统方式

你是否在为复杂的参数校验而头疼，你是否已经对写这样的校验代码感到烦躁？

[HttpPost("sign-in")]
public IActionResult SignIn([FromBody] User usr)
{
   
    if (string.IsNullOrWhiteSpace(usr.Name))
    {
   
        return BadRequest("用户姓名不能为空");
    }
    if (string.IsNullOrWhiteSpace(usr.Account) || usr.Account.Length > 10)
    {
   
        return BadRequest("用户账户不能为空且长度不能超过10");
    }
    if (usr.Age < 18)
    {
   
        return BadRequest("未满18岁禁止注册");
    }
    //...
    return Ok();
}

如果你还在用这种传统的方式写参数校验，那么你只在第一层。

使用ValidationAttribute特性

其实在WebApi中我们还可以向数据传输类中的属性添加ValidationAttribute特性来达到参数校验的效果。
以下代码与上文传统方式的校验效果完全一致，而且只需要编写1次，不需要为每个使用User参数的接口都编写一次校验代码。

    public class User
    {
   
        /// <summary>
        /// 姓名
        /// </summary>
        [Required(ErrorMessage = "姓名不能为空")]
        public string Name {
    get; set; }

        /// <summary>
        /// 年龄
        /// </summary>
        [Range(18, 200, ErrorMessage = "未满18岁禁止注册")]
        public int Age {
    get; set; }

        /// <summary>
        /// 用户账号
        /// </summary>
        [NoSpace(ErrorMessage = "用户账号不能包含空格")]
        [StringLength(10, ErrorMessage = "账号最大长度不能超过10")]
        public string Account {
    get; set; }
     }

如果你会使用特性的方式为Controller进行参数校验，那么你已经在第二层了。

其他方式

除了以上两种方式之外还可以使用例如FluentValidation等第三方库进行参数校验。若使用FluentValidation等第三方库确实可以方便优雅地实现非常复杂的参数校验，此部分内容不在本文记录范围内，暂时不作深究。如果你已经能用第三方的参数校验库对项目接口进行参数校验，并且能够优雅地集成到项目中，那么你应该已经在大气层了。

使用特性为Controller进行参数校验

言归正传，如果我们在WebApi中想用为传输类(DTO)属性添加特性的方式进行参数校验，我们需要做什么呢？

ValidationAttribute特性