ASP.NET Core 中的模型绑定

admin

2021-06-03

本文作者：梁桐铭- 微软最有价值专家(Microsoft MVP)
本文出自《从零开始学 ASP.NET Core 与 EntityFramework Core》目录
视频课程效果更佳：跨平台开发实战掌握 ASP.NET Core 与 EntityFramework Core

在本节课中，我们将通过示例来学习 ASP.NET Core 中的模型绑定。

什么是模型绑定

模型绑定是将 HTTP 请求中的数据映射到控制器操作方法上对应的参数。
操作方法中的参数可以是简单类型，如整数，字符串等，也可以是复杂类型，如 Customer，Employee，Order 等。
模型绑定很棒，有了它我们节约大量的时间，因为没有它我们必须编写大量自定义代码来将请求数据映射到操作方法参数，这不仅无聊乏味而且容易出错。。

ASP.NET Core 中的模型绑定简单例子

当 HTTP 请求到达我们的 MVC 应用程序时，它是处理传入请求的 Controller 操作方法。假设我们要查看 ID 为 2 的学生详细信息。为此，我们向以下 URL 发出 GET 请求

http://localhost:13380/home/details/2

我们的应用程序默认路由模板规则({controller = Home}/{action = Index}/{id?})路由将此请求发送到 HomeController 的 Details(int? id)操作方法上。


  public IActionResult Details(int? id)
        {
           //实例化HomeDetailsViewModel并存储Student详细信息和PageTitle
            HomeDetailsViewModel homeDetailsViewModel = new HomeDetailsViewModel()
            {
                Student = _studentRepository.GetStudent(id??1),
                PageTitle = "学生详细信息"
            };
            return View(homeDetailsViewModel);
        }

参考以上代码：我们将请求 URL 中 id 值为 2 的参数映射到操作方法Details(int? id) 的中。这样 MVC 会将请求中的数据绑定到操作方法中对应的参数上。

请注意，在上面的示例中，默认路由模板中的参数名称为id，而 Details(int? id)操作方法中的参数名称也为 id。因此，Http 请求的(http://localhost:13380/home/details/2 )URL 中 id 值为 2 ,将被映射到操作方法为Details(int? id)中 Id 参数。

另外一个示例

http://localhost:13380/home/details/2?name=pragim

参考以下Details()操作方法处理上述请求 URL 并将 Id 值 2 映射到 id 参数，将值 pragim 映射到 name 参数中

public string Details(int? id, string name)
{
    return "id = " + id.Value.ToString() + " 并且 名字 = " + name;
}

HTTP 请求数据

要将请求数据绑定到控制器操作方法上对应的参数，模型绑定将按以下指定的顺序在以下位置查找来自 HTTP 请求中的数据。

Form values (表单中值)
Route values(路由中的值)
Query strings(查询字符串)

模型绑定复杂类型的参数

模型绑定也适用于复杂类型，如Customer，Student，Order，Employee等。

参考以下"创建学生表单"信息：创建员工

当上述表单发布到服务器时，表单中的值将映射到Create()操作方法中Student对象中的对应的参数信息。参考下面的代码：

public RedirectToActionResult Create(Student student)
{
    Student newStudent = _studentRepository.Add(student);
    return RedirectToAction("Details", new { id = newStudent.Id });
}

ASP.NET Core 中的模型绑定器将来自 Post 请求中的表单值绑定到Create()操作方法中Student对象的属性。
input标签中name属性为Name的值，将映射到Student对象中的Name属性。
类似的，input标签中name属性为Email的值,也同样会被映射到Student对象中的Email属性
主修科目 Major 也是同样的原理。

在 IStudentRepository 接口中添加 Add() 方法

参考一下代码


 public  interface IStudentRepository
    {

        Student GetStudent(int id);


        IEnumerable<Student> GetAllStudents();

        Student Add(Student student);

    }

MockStudentRepository 类中实现 Add() 方法

我们需要在MockStudentRepository中实现 Add()方法，填写上业务逻辑，参考一下代码：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace StudentManagement.Models
{
    public class MockStudentRepository : IStudentRepository
    {
        private List<Student> _studentList;


        public MockStudentRepository()
        {

            _studentList = new List<Student>()
            {
            new Student() { Id = 1, Name = "张三", Major = MajorEnum.FirstGrade, Email = "Tony-zhang@52abp.com" },
            new Student() { Id = 2, Name = "李四", Major = MajorEnum.SecondGrade, Email = "lisi@52abp.com" },
            new Student() { Id = 3, Name = "王二麻子", Major = MajorEnum.GradeThree, Email = "wang@52abp.com" },
            };


        }

        public Student Add(Student student)
        {
            student.Id = _studentList.Max(s => s.Id) + 1;
            _studentList.Add(student);
            return student;
        }

        public IEnumerable<Student> GetAllStudents()
        {
            return _studentList;

        }

        public Student GetStudent(int id)
        {
            return    _studentList.FirstOrDefault(a => a.Id == id);
        }
    }
}

HttpGet 与 HttpPost

目前在HomeController中我们有以下 2 个Create()操作方法。

 public ViewResult Create()
        {
            return View();
        }

        public RedirectToActionResult Create(Student student)
        {
            Student newStudent = _studentRepository.Add(student);
            return RedirectToAction("Details", new { id = newStudent.Id });
        }

如果我们通过 url 访问http://localhost:13380/home/Create那么我们会受到如下错误 : AmbiguousActionException: Multiple actions matched. The following actions matched route data and had all constraints satisfied: 或者参考下图

这是因为 ASP.NET Core 不知道要执行哪个操作方法。我们希望第一个 Create()操作方法响应 GET 请求，第二个 Create()操作方法响应 POST 请求。那么我们需要告诉 ASP.NET Core 使用 HttpGet 和 HttpPost 属性修饰 Create()操作方法，如下所示。

[HttpGet]
public ViewResult Create()
{
    return View();
}

[HttpPost]
public RedirectToActionResult Create(Student student)
{
 Student newStudent = _studentRepository.Add(student);
return RedirectToAction("Details", new { id = newStudent.Id });
}

响应 POST 请求的Create()操作方法将新学生信息添加到StudentRepository中，并将用户重定向到 Details()操作方法中，向其传递新创建的学生的 ID。

如果在重定向时，如果返回的是 NullReferenceException异常信息，请确保使用 AddSingleton()方法而不是AddTransient()方法。你可以在 Startup.cs 文件的 ConfigureServices()方法中注册 IStudentRepository 服务。

 public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc();
            services.AddSingleton<IStudentRepository, MockStudentRepository>();
//其他代码
        }

我们将在即将发布的内容中讨论导致此错误的原因以及依赖注入组件中的AddSingleton()，AddTransient()和 AddScoped()方法之间的区别。