ASP.NET Core MVC 模型绑定[FromHeader]，[FromQuery]，[FromRoute]，[FromForm],[FromBody]用法场景及原理-iaspnetcore.com

前言
1.Request.url
- 1.1[FromQuery]
  - 控制器有两种方式获取地址栏的参数
    - 方式一：我们最常用的原始写法,逐个获取参数
    - 方式二：用FromQuery,这样可以直接将参数解析到对象，不需逐个赋值了。
- 1.2[FromRoute]
3.Reques.Body
useful links

前言

很多人搞不清FromQuery和FromRoute的区别。本文举例解释一下。

FromRoute - Gets values from route data.
FromQuery - Gets values from the query string.
FromForm - Gets values from posted form fields.
FromBody - Gets values from the request body.
FromHeader - Gets values from HTTP headers.
FromServices

[FromXXX] 是告诉后台的控制器在获取前台页面传递过来的参数是放在请求内容的哪个地方的，从而确定从哪里获取参数信息。

来源：公众号：aspnetcore

从前端发过来的请求，由三个部分组成

Request.url

Request.Header

Reques.Body

参数可能放在这三个地方之一。[FromXXX]即对应了这三处地方。

1.Request.url

1.1[FromQuery]

表示参数来自地址栏。

浏览器的请求方式为在地址栏带参数 http get 方式时，如：

https://search.iaspnetcore.com/Search?pageNumber=1&query=ASP.NET%20Core%20Blazor&FieldId=0&DateTimeRangeId=0&WordCountRangeId=0

控制器有两种方式获取地址栏的参数

方式一：我们最常用的原始写法,逐个获取参数

public class SearchController : Controller
    {
        private readonly IHttpContextAccessor _httpContextAccessor; 
public IActionResult Index()
{
string query = _httpContextAccessor.HttpContext.Request.Query["query"];
            var pageNumber = CommonHelper.StringToInt(_httpContextAccessor.HttpContext.Request.Query["pageNumber"], 0);
            var pageSize = CommonHelper.StringToInt(_httpContextAccessor.HttpContext.Request.Query["pageSize"], 10);
            var filterPrice = CommonHelper.StringToInt(_httpContextAccessor.HttpContext.Request.Query["filterPrice"], 0);
            var filterPrice2 = CommonHelper.StringToInt(_httpContextAccessor.HttpContext.Request.Query["filterPrice2"], 0);
            var dateTimeRange = CommonHelper.StringToInt(_httpContextAccessor.HttpContext.Request.Query["dateTimeRange"], 0);
            var wordCountRange = CommonHelper.StringToInt(_httpContextAccessor.HttpContext.Request.Query["wordCountRange"], 0);

 SearchViewModel viewModel = new SearchViewModel();
viewModel.PageNumber=pageNumber;
...
}
}

方式二：用FromQuery,这样可以直接将参数解析到对象，不需逐个赋值了。

 public class SearchController : Controller
    {
        private readonly IHttpContextAccessor _httpContextAccessor;


        #region Constructor

        /// <summary>
        /// Ctor
        /// </summary>
        /// <param name="httpContext">HTTP context</param>
        public SearchController(IHttpContextAccessor httpContextAccessor)
        {

            this._httpContextAccessor = httpContextAccessor;

        }

        #endregion
       
        public IActionResult Index([FromQuery]SearchViewModel model)
        {
            ViewData["Title"] = model.Query + "文章垂直搜索";

           //model.Query.pageNumber=1  etc

            return View(viewModel);


        }

方式二在Web API中用起来很方便。为什么不用post方式直接提交对象呢？这是因为，post在地址栏没任何信息。用带参数的地址形式，别人复制地址栏就可以转发给别人，才可以为网站带来流量。

1.2[FromRoute]

表示参数在路由（url）中，不是那个带？和&的查询字符串，如：

请求博客文档

https://www.iaspnetcore.com/Blog/BlogPost/594960eb84cd453380655bc9

对应Blog控制器的方法为：

public BlogPost  GetBlogPost([FromRoute]string id)
{
      //id=594960eb84cd453380655bc9
       var blogPost =_this.BlogService.GetBlogPost(id)
....
}

3.Reques.Body

下面两种是参数放在请求体request.body中。同样是将参数放在请求体request.body中，但请求体request.body数据的存放格式有几种。

3.1[FromForm]

表示参数来自请求体request.body，数据格式为表单数据

3.2[FromBody]

表示参数来自请求体request.body中。[FromBody]以json格式存储数据并传递数据，后台将数据采用json方法解析。如：

curl -i -k \
    -H "Content-Type: application/json" \
    -d "{\"name\":\"Plush Squirrel\",\"price\":12.99}" \
    https://localhost:5001/products

1.前台的股票多条件查询菜单

    protected override async Task OnInitializedAsync()
    {
        stockInfoSearchModel = new StockPanKouSearchModel();
        stockInfoSearchModel.StockCode = "";

        //股票信息查询菜单
        stockInfoSearchModel = await Http.GetFromJsonAsync<StockPanKouSearchModel>(GlobalHelper.BaseUrl + "/api/v1/StockDataPhysicalDiskPanKouAggregateAuctionSearch/MenuAsync");

        //获取所有股票信息
        //   forecasts = await StockDataDatabaseService.GetStockInfo();
        stockInfoSearchModel = await StockDataPhysicalDiskWebApiV1Service.GetPanKouAggregateAuctionSearchMenuAsyncAsync();

        this.StateHasChanged();

    }

，因为条件参数太多，把参数放在请求体内(Request.Body)，将参数转换成json的格式后发送到后台api，

 protected async Task SearchAsync()
    {
        //行号索引重置为0
        indexCount = 0;

        //结果数据置0
        forecasts = null;

        //设置为正在加载
        isLoading = true;
        //获取数据
        var response = await Http.PostAsJsonAsync<StockPanKouSearchModel>(GlobalHelper.BaseUrl + "/v1/StockDataPhysicalDiskPanKouAggregateAuctionSearch/SearchAsync", stockInfoSearchModel);

        //数据加载完成
        isLoading = false;



        this.StateHasChanged();


    }

2.后台web api代码，从请求体（request.body）获取数据（即前台发过来的参数），然后赋值到StockPanKouSearchModel变量

   /// <param name="model"></param>
        /// <summary>
        /// 查找结果 https://api.demo.com/api/v1//StockDataPhysicalDiskPankou/SearchAsync
        /// </summary>
        /// <param name="model"></param>
        /// <returns></returns>
        [HttpPost("SearchAsync")]
        public virtual async Task<ActionResult<ApiResponse<SearchResultStockModel>>> SearchAsync([FromBody] StockPanKouSearchModel model)
        {

            string sinfo = "";
            string scode = "";

            int DayNum = model.DayNum;


            Stockso.Models.ApiResponse<SearchResultStockModel> searchResult = new Stockso.Models.ApiResponse<SearchResultStockModel>();


            this._logger.LogInformation($"{DateTime.Now}-用户选择的集合竞价菜单：股票代码：{model.StockCode} 总天数： {model.DayNum.ToString()}\n");
           ....
}

模型绑定的用途

通常情况下，我们在使用 MVC 框架的时候不需要关注模型绑定的相关功能，因为它是集成到 MVC 框架内部的，当我们在浏览器访问一个地址的时候，无论是 GET 还是 POST 访问，在映射到 Action 的过程中 MVC 框架已经自动的进行了对象或者是路由参数的绑定，这其中就是使用的模型绑定。

在 ASP.NET Core MVC 中，模型绑定分为简单模型绑定和复杂模型绑定。简单的模型绑定比如直接从 Form 表单或者 URL 路由数据中获取信息，然后应用到Action方法的各个参数上，复杂模型绑定的话可能就不是简单的转换到参数的值上面了，可能中间还会涉及到一些数据类型转换，模型分解，参数校验等。

下面来看一下模型绑定的一个示例：

假设我们有一个ViewModel对象叫 Person，它的代码如下：

public class Person
{
    public string Name { get; set; }
    
    public int Age { get; set; }
}

在这个 ViewModel 对象中，都是使用的一些很简单的类型，那么我们的 Action 进行如下的定义：


public class PersonController
{
    [HttpPost]
    [Route("~api/person/add")]
    public IActionResult CreatePerson(Person person)
    {
        return Ok(person);
    }
}

在上面的代码中，我们可以向 http://localhost:5000/api/person/add 这个地址发送一个 POST 请求，Body 类型使用普通的 Form ，参数使用上面Person定义的 Name, Age。在 Action 上添加断点，我们就可以看到person变量中的值，然后此 Action 会返回一个被 json 序列化后的结果对象。

这样一个过程，就是模型绑定在实际开发中的一个用途和用法。

是不是看起来很简单呢？但是在内部模型绑定子系统是比较复杂的，由很多部分组成。

模型绑定的一些用法

在 ASP.NET Core MVC 中，支持以下表单类型的模型绑定。

[FromHeader]，[FromQuery]，[FromRoute]，[FromForm]

示例：

public IActionResult CreatePerson([FromForm]Person person)
{
    return Ok(person);
}

这些 [FromXXX] 是告诉模型绑定在解析的过程中从HttpContext中那一部分获取信息。

还有一部分模型绑定框架中定义的一些 Attribute 是用来在模型模型的过程中限制或者忽略一些参数。比如

[BindRequired]，[BindNever]

这两个是用来在模型绑定的过程中添加的一些制约，BindRequired可以应用在类或者属性上，用来限制在绑定的过程中必须需要的一些值。BindNever用来忽略当前参数的绑定。

还有两个 [FromServices], [FromBody]。

[FromServices] 是参数绑定的过程中，告诉模型绑定框架该参数从 DI 容器中获取。

[FromBody] 是参数绑定的过程中，告诉框架该参数是使用配置过的格式化程序从Http Body 中解析。

在[FromBody]中，默认情况下会使用MVC框架内部配置的 JsonInputFormatter 进行反序列化解析，如果你传递的 Body 中的类型是 application/xml，你可以在 ConfigureServices 方法中配置 services.AddMvc().AddXmlSerializerFormatters();进行XML的反序列化。

还有一个 [ModelBinder] 这个可能很多人没用过，这个是应用在 Controller 中的属性上的，用来绑定属性信息。比如

public class Controller
{
    [ModelBinder]
    public string Name { get; set;}
    
    public IActionResult CreatePerson(Person person)
    {
        return Ok(person);
    }
}

在 Action 激活的时候，Controller 的 Name 属性也会具有Action 参数中 person 变量中名字和 Name 相同参数的值。

自定义模型绑定

自定义模型绑定属于 MVC 模型绑定的一些高级知识，在一些特殊情况中我们可能会使用到他们。详情可以参考这篇文章 https://docs.microsoft.com/en-us/aspnet/core/mvc/advanced/custom-model-binding，本文不打算做过多介绍。

MVC 模型绑定(ModelBinding)实现原理

看过我 ASP.NET Core MVC Action 激活这篇文章的同学应该知道，在 Action 激活的过程中会涉及到很多状态，那么模型绑定是在 ActionBegin 这个状态中进行的，同时在 ActionNext 过程中被使用，我就直接接着这篇文章的 Action 执行部分进行讲解了。

首先，模型绑定的入口位于 ControllerActionInvoker 这个类中的一个Next方法里

private Task Next(ref State next, ref Scope scope, ref object state, ref bool isCompleted){
    ......
    
    switch (next)
    {
        case State.ActionBegin:
             BindArgumentsAsync();
             goto case State.ActionNext;
        
        case State.ActionNext:
            _actionExecutingContext = new ActionExecutingContext(_arguments);
    }
    
    ......
}

可以看到在 State.ActionBegin 这个过程中使用了 BindArgumentsAsync() 进行参数绑定，那么整个绑定过程就由此开始。

在 Core MVC 框架模型绑定部分源码中，模型绑定源码分为这几部分：元数据（Metadata），值提供器（ValueProvider），验证者（Validator），绑定器（Binder）。

元数据：元数据相当于模型绑定中的实体对象，用来储存在整个模型绑定子系统中需要的各种必要信息和元数据信息，包括模型参数的元数据和以及绑定信息的元数据等等。

值提供器：值提供器用来提供在运行时模型绑定器可以从中提取值的一个Provider, 默认情况下，值提供器会从以下地方提取各种资源的值：

1、以前绑定的操作参数（当该操作为子操作时）

2、表单字段 (FormValueProvider)

3、路由数据 (RouteValueProvider)

4、查询字符串参数 (QueryStringValueProvider)

5、JQuery 表单数据(JQueryFormValueProvider)

这些 ValueProvider 对象由 CompositeValueProvider 进行统一管理，它是一个集合用来创建或者获取这些 ValueProvider 对象。

验证者：验证者是用来验证Action参数中模型字段的合法性。

它的默认实现是 DefaultObjectValidator，它会根据元数据信息来确定绑定过程中使用的具体 ValudatorProvider 对象，ValudatorProvider 是用来提供IModelValidator接口实例对象的。

在 ASP.NET Core MVC 中有两个类实现了 IModelValidator接口，他们分别是 DataAnnotationsModelValidator 和 ValidatableObjectAdapter。其中 ValidatableObjectAdapter 是一个适配器，用来转换和封装验证结果，所以我们主要看 DataAnnotationsModelValidator。

DataAnnotationsModelValidator 就是用来验证模型类中的各种 Attribute 的，也就是DataAnnotations相关的那些类，比如 [MaxLength]，[Required]，[RegularExpression] 等等。

绑定器：绑定器用来绑定Action参数中的大多数简单和复杂的数据模型，它通过对模型各个属性使用递归逻辑来实现该目标。

针对不同类型的绑定具有不同的绑定器，如：

ArrayModelBinder，SimpleTypeModelBinder，FormFileModelBinder，
FormCollectionModelBinder，ComplexTypeModelBinder，
BodyModelBinder，HeaderModelBinder，DictionaryModelBinder，
ServicesModelBinder，KeyValuePairModelBinder，ByteArrayModelBinder，
CancellationTokenModelBinder，CollectionModelBinder，BinderTypeModelBinder

这些 ModelBinder 对象都具有各自的 Provider 对象，对来返回当前Binder对象的实例对象。

这些 ModelBinder 对象由 ParameterBinder 进行统一管理， ParameterBinder 对象会接收模型的元数据信息（Metadata），绑定器工厂（BinderFactory），验证者（Validator），然后进行最终的模型绑定流程，如下图：

回到总流程

我们回到 ControllerActionInvoker 这个中，BindArgumentsCoreAsync 这个函数中会进行上层的模型绑定，流程如下：

以上总流程的前两步就是 MVC Core 模型绑定系统针对于 Controller 中 Action 参数的绑定，实际上除了针对 Action 参数绑定外，还会对 Controller 中的使用了 [IModelBinder] 特性的进行绑定，那么第三步就是在做这个事情。

至此，模型绑定流程结束。

useful links

Model Binding in ASP.NET Core 5.x

https://docs.microsoft.com/en-us/aspnet/core/mvc/models/model-binding?view=aspnetcore-5.0#frombody-attribute

Table of Contents

前言