概述

上单元介绍 DTO 时，我们已经简单讲解了模型绑定，本节学习一些模型绑定的实践和进阶知识。

从 URL 中提取数据

在 ASP.NET 或 Java Server Pages（JSP）这些较老的 Web 开发架构中，我们必须手动读取 HTTP Header、URL、HTTP Query String 和 Form Body 以提取用户通过 HTTP 请求发送的数据。这是一项繁琐的工作，且每次 HTML 元素更改名称时，读取数据的服务器端代码也必须做相应地更改。

对于 action 方法，我们将 HTTP 请求视为模型绑定的数据源。下表展示了如何从 HTTP 请求中提取数据：

在 ASP.NET Core 中，模型绑定的功能就是自动执行提取解析的工作，以便将 HTTP 请求中包含的数据映射到 Action 参数。

运作的理念很简单，大致如下：

• 对于简单类型（int、double、string 等）Action 参数，模型绑定引擎以不区分大小写的方式通过参数的名称查询所有数据部分。如果存在匹配的键值对或可以从 URL 字符串中提取值，则将值提取出来分配给参数

• 对于复杂类型（Product、Movie 类等）Action 参数，模型绑定引擎以不区分大小写的方式通过参数的属性名称查询所有数据部分。如果存在匹配的键值对或可以从 URL 字符串中提取值，则将该值提取出来分配给参数的属性

由于 HTTP 请求中的所有值都是字符串类型，因此模型绑定将为我们执行类型转换。例如，键值对 price = 99.99 通过模型绑定引擎被映射到 Action 的 double price 参数后，price 参数将被赋值为 double 类型的 99.99。

如果类型转换失败会发生什么？例如假设键值对是 price = ABC，由于类型转换失败，price 参数将被赋值 0.0（double 类型的默认值）。

示例

下面用一个示例来讲解数据提取。

假设我们的 Web 程序运行在 http://localhost:5000，默认的路由模板是 {controller=Home}/{action=Index}/{id?}。

领域模型 Product 如下所示：

public class Product 
{
    public int ID { get; set; }
    public string Name { get; set; }
    public double Price { get; set; }
    public string MadeIn { get; set; }
    public bool IsAvailable { get; set; }
    public string Description { get; set; }
}

ProductController：

public class ProductController : Controller 
{
    [HttpPost]
    public IActionResult Create(Product product) 
    {
        // business logic ...
        return View(product);
    }
}

当浏览器向 URL http://localhost:5000/product/create/101?isavailable=false&madein=USA 提交 HTTP POST 请求时，表单体中的数据为：

name = Autopilot Car
price = 99999.99

Create 的 product 参数引用指向由模型绑定创建的 Product 类的实例。它的属性值为：

这是一个比较极端的例子，在实际项目中，我们很少将对象的值分发到这么多部分。

在 Web 程序中传输数据的简单原则是：

• 对于 HTTP GET 请求，使用 URL 字符串或 query string 传输数据

• 对于 HTTP POST 请求，使用表单传输数据

• 仅在必要时将数据分发到不同的部分

• 可以通过使用 [FromQuery]、[FromForm]、[FromRoute] 和 [FromHeader] 标注 Action，限制数据源

总结

模型绑定提取数据的步骤：

1. 通过 URL Route 确定目标 Action

2. 确定 Action 后，明确 Action 的各个参数及参数类型

3. 模型绑定将 HTTP 请求里面的数据作为数据源

4. 对于 Action 中的简单类型参数：

   1. 模型绑定拿着参数名，通过名称匹配等方式去数据源里面找匹配项

   2. 模型绑定找到匹配项后，将值提取出来，进行类型转换

   3. 模型绑定将转换后的值给到 Action 的参数

5. 对于 Action 中的复杂类型参数：

   1. 模型绑定根据该复杂类型创建一个对象

   2. 模型绑定遍历该对象的各个属性，获得属性名

   3. 模型绑定拿着属性名，通过名称匹配等方式去数据源里面找匹配项

   4. 模型绑定找到匹配项后，将值提取出来，进行类型转换

   5. 转换完后将属性值赋给该对象

   6. 最后将该对象给到 Action 的参数

自定义模型绑定器

虽然模型绑定可以将 HTTP 请求中的数据映射到 Action 参数，但如果 Action 参数的类型过于复杂，则模型绑定引擎将无法创建该对象。

例如，假设我们的领域模型类如下：

public class Player 
{
    public string Name { get; set; }
    public int Rank { get; set; }
}
public class Game 
{
    public string City { get; set; }
    public Player Player1 { get; set; }
    public Player Player2 { get; set; }
}

从表单提交过来的键值对：

p1Name=Superman
p1Rank=101
p2Name=Ironman
p2Rank=202
gameCity=Seattle

模型绑定引擎应该如何构建 Game 对象？

在这种情况下，我们需要一个自定义模型绑定器。自定义模型绑定器是实现了 IModelBinder 接口的类。绑定 Game 对象的自定义模型绑定器如下所示：

public class GameModelBinder : IModelBinder 
{
    public Task BindModelAsync(ModelBindingContext bindingContext) 
    {
        var game = new Game();
        game.Player1 = new Player();
        game.Player2 = new Player();
        game.City = bindingContext.HttpContext.Request.Form["gameCity"];
        game.Player1.Name = bindingContext.HttpContext.Request.Form["p1Name"];
        game.Player1.Rank = int.Parse(bindingContext.HttpContext.Request.Form["p1Rank"]);
        game.Player2.Name = bindingContext.HttpContext.Request.Form["p2Name"];
        game.Player2.Rank = int.Parse(bindingContext.HttpContext.Request.Form["p2Rank"]);
        bindingContext.Result = ModelBindingResult.Success(game); // set the model binding result
        return TaskCache.CompletedTask;
    }
}

注：此处为了保持演示代码的简洁，省略了大量数据验证、corner cases 和异常处理的代码。在实际项目中，自定义模型绑定器不会这么简单。

有两种方法可以使用 GameModelBinder。

1. 使用 [ModelBinder(BinderType = typeof(GameModelBinder))] 标注 Game 类。除非你能保证 Game 对象始终是从表单体构建的，否则不建议你使用此方法

2. 使用 [ModelBinder(BinderType = typeof(GameModelBinder))] 标注 Action 参数：

   public class GameController : Controller 
   {
    public IActionResult Create([ModelBinder(BinderType = typeof(GameModelBinder))]Game game) 
    {
        // business logic ...
        return View(game);
    }
   }

我们可以通过在 Action 中设置断点并使用 Postman 发送 HTTP POST请求，来触发 Action 并观察参数的值。
下面是截图供参考：

启发

通过此处演示的自定义模型绑定器和 Docs 的自定义模型类绑定，我们不难推测出 ASP.NET Core 模型绑定大致的实现机制：

1. 根据属性名去 bindingContext 中查找对应项

2. 找到的项提取出来，并进行类型转换

3. 用这些属性构建模型绑定的结果，并装到 bindingContext.Result 里面返回去

模型验证

模型验证是为了避免“脏数据”进入我们的业务逻辑或数据库。

脏数据指数据不一致或错误。例如，Product 对象缺少 Name 属性，密码长度太短，或者 Student 对象的年龄为负。脏数据通常来自用户输入，但并非总是如此。我们有很多方法可以防止用户通过脏数据影响我们的应用程序或业务逻辑。

避免脏数据的方式：

因为客户端验证不在本课程的范畴，且我们已经在之前的课程中介绍了路由参数约束，所以这里我们只关注模型验证。

MVC 支持从 ValidationAttribute 派生的任何特性进行验证。可以在 System.ComponentModel.DataAnnotations 命名空间中找到许多有用的验证属性。下面列出一些常用的以供参考：

验证特性示例：

public class Book 
{
    [Required, Key]
    public int ISBN { get; set; }
    [Required, StringLength(100)]
    public string Title { get; set; }
    [Required, DataType(DataType.Date)]
    public DateTime PublishDate { get; set; }
    [Required, MaxLength(1000)]
    public string Description { get; set; }
    [Required, Range(0, 999.99)]
    public decimal Price { get; set; }
    [Url]
    public bool SamplePage { get; set; }
    [EmailAddress]
    public string AuthorEmail { get; set; }
    [Phone]
    public string AuthorPhone { get; set; }
}

模型绑定时，一旦违反一个或多个模型验证规则，ModelState.IsValid 的值将为 false。基于此，我们可以控制程序流程：

public class BookController : Controller 
{    
    public IActionResult Create(Book book) 
    {
        if (ModelState.IsValid == true) 
        {
            // business logic ...
        } 
        else 
        {
            // let user re-input the data
        }
    }
    ...
}