ASP.NET Core 模型绑定

落日映苍穹つ 2024-04-23 20:24 67阅读 0赞

## ?介绍 ##

在C\#中，特别是在ASP.NET Core中，模型绑定是一个将HTTP请求中的数据映射到C\#对象的过程。它使得开发者能够方便地从请求中提取数据，而无需手动解析请求体、查询字符串、路由数据等。ASP.NET Core提供了多种特性（Attributes）来指定模型绑定的来源。以下是一些常用的模型绑定特性及其区别：

**\[FromRoute\]**

*  适用于：路由模板中的参数。
 *  描述：从路由模板中绑定数据到模型对象。
 *  示例：对于路由模板`api/items/{id}`，你可以使用`[FromRoute]`来绑定`id`参数。

**\[FromQuery\]**

*  适用于：查询字符串中的数据。
 *  描述：从URL的查询字符串中绑定数据到模型对象。
 *  示例：对于URL `https://example.com/api/items?page=1&size=10`，你可以使用`[FromQuery]`来绑定`page`和`size`参数。

**\[FromHeader\]**

*  适用于：HTTP请求头中的数据。
 *  描述：从HTTP请求头中绑定数据到模型对象或单个属性。
 *  示例：可以用来绑定如`Authorization`、`Content-Type`等请求头。

**\[FromBody\]**

*  适用于：POST、PUT等请求的请求体数据。
 *  描述：将请求体中的数据绑定到模型对象。通常用于JSON或XML格式的数据。
 *  注意事项：在一个动作方法中，通常只能有一个参数使用`[FromBody]`，因为请求体只能被读取一次。

**\[FromForm\]**

*  适用于：表单提交的数据。。
 *  描述：在ASP.NET Core Web API中，`[FromForm]`特性用于从HTTP请求的表单数据中绑定数据到模型对象。这通常用于处理`multipart/form-data`类型的请求，比如文件上传同时携带其他表单字段的场景。
 *  示例：假设你有一个Web API端点，用于接收用户上传的图片以及其他相关信息，你可以使用`[FromForm]`来绑定表单数据。

**\[FromServices\]**

*  适用于：依赖注入的服务。
 *  描述：不是直接从请求中绑定数据，而是从依赖注入容器中获取服务实例。
 *  示例：常用于注入如`ILogger`、`DbContext`等服务。

**\[ModelBinder\]**

*  适用于：自定义模型绑定逻辑。
 *  描述：允许你创建自定义的模型绑定逻辑。你可以通过实现`IModelBinder`接口或继承`IModelBinderProvider`来创建自定义的模型绑定器。

## ?演示 ##

下面我们对上面提到的模型绑定特性对常用的几个进行使用演示

因为在Get请求中不能有body，因此我们先在get方法中演示前面三种模型绑定特性**\[FromRoute\]、\[FromQuery\] 和 \[FromHeader\]** 。

简单来说**\[FromRoute\]**就是从数据路由中获取值，**\[FromQuery\]** 从查询字符串中获取值，**\[FromHeader\]** 从HTTP标头中获取值

### ?**FromRoute、****FromQuery、****FromHeader** ###

新建一个asp.net core项目，在controller中使用这三个标签

using Microsoft.AspNetCore.Mvc;
    
    namespace testWebApi.Controller;
    
    [ApiController]
    [Route("api/[controller]")]
    public class TestController:ControllerBase
    {
        [HttpGet]
        [Route("Getoption/{id}")]
        public IActionResult Getoption([FromRoute]int id,[FromQuery] string query,[FromHeader] string header)
        {
            return Ok($@"route:{id},query:{query},header:{header}");
        }
    }

启动项目，我们在swagger中请求测试一下

![a4b1995fcfc748ec8f4e7f02b6f08307.png][]

F12在网络请求情况中可以得知，route和query都在请求URL中，而header顾名思义，在我们的请求头中。

![c8c3afe101af4b85950ac31998a08f98.png][]

### ?FromForm ###

接下来我们在controller中增加一个post请求的方法，使用FromForm形似绑定数据

[HttpPost]
        [Route("testForm")]
        public IActionResult TestForm([FromForm] int id, [FromForm] string name)
        {
            return Ok(@$"Id:{id}， Name：{name}");
        }

这里我们使用postman演示一下

![9d6ea3ca10624a539e9c98d2d25a8561.png][]

#### ?文件上传 ####

FromForm我们通常用于文件上传，如下将参数类型改为IFormFile

[HttpPost]
        [Route("upload")]
        public IActionResult UploadFile([FromBody] IFormFile file)
        {
            return Ok();
        }

在postman中上传文件测试一下，注意这里的key要和参数名（这里是 file）对应上

![d0e01f9a16ca4910969561b1865dbb01.png][]

在file实例中我们可以看到他的文件名称，类型等信息。

![4f2c6f00504449fa8b13d94690b1e8b8.png][]

### ?FromBody ###

要注意的是，在一个动作方法中，通常只能有一个参数使用`[FromBody]`，因为请求体只能被读取一次。

[HttpPost]
        [Route("testBody")]
        public IActionResult TestBody([FromBody] string name)
        {
            return Ok(name);
        }

post请求的方法体我们一般是使用json数据格式。

![25d03451f8794507a40d8117f145e7d4.png][]

#### ?对象模式绑定 ####

因为请求体只能读取一次，要获取多个数据我们一般采用对象模式来进行模型绑定，首先创建一个Dto

public class Student
    {
        public int Id { get; set; }
        
        public string? Name { get; set; }
    }

然后在方法参数中将Dto设置为参数

[HttpPost]
        [Route("testBody")]
        public IActionResult TestBody([FromBody] Student student)
        {
            return Ok(@$"Id:{student.Id}， Name：{student.Name}");
        }

请求测试！

![d00c26c51cfd4652899b73643cab0621.png][]

注意我们的数据一定要遵守JSON数据的格式，如果对JSON数据格式不熟悉我们可以通过下面的在线JSON校验格式工具进行数据的检查。

[在线JSON校验格式化工具（Be JSON）][JSON_Be JSON]

![5120d7366bdd46dbb59fbd6189a98436.png][]

![13ca5f5389214e119063ef0ea8ce923e.png][]

事实上在上面说的的query,route,form,body,header这五种来源都可以使用这种对象现实来进行数据绑定，但是一般数据比较多的话我们通常选择将它放到post请求的body中

### ?模型验证 ###

在使用对象模式进行模型绑定时，可以像如下通过一些标签来对我们要绑定的数据进行校验，如添加 \[Required\] 将这个参数设置为非空，然后 \[Range(1,100)\]设置我们的id取值只能在1-100之间，同时通过ErrorMessage（可选）来自定义我们的错误提示。

public class Student
    {
        [Required]
        [Range(1,100,ErrorMessage = "只能传1-100的值！")]
        public int Id { get; set; }
        
        public string? Name { get; set; }
    }

![990bc54b07254ee8bbb5d3e43b026c40.png][]

这些都是.netCore内置的验证特性，以下是一些内置验证特性：

*  [\[ValidateNever\]][ValidateNever]：指示应将某一属性或参数排除在验证外。
 *  [\[CreditCard\]][CreditCard]：验证属性是否有信用卡格式。 需要 [jQuery Validation 附加方法][jQuery Validation]。
 *  [\[Compare\]][Compare]：验证模型中的两个属性是否匹配。
 *  [\[EmailAddress\]][EmailAddress]：验证属性是否有电子邮件格式。
 *  [\[Phone\]][Phone]：验证属性是否有电话号码格式。
 *  [\[Range\]][Range]：验证属性值是否在指定范围内。
 *  [\[RegularExpression\]][RegularExpression]：验证属性值是否与指定的正则表达式匹配。
 *  [\[Required\]][Required]：验证字段是否不为 null。 请参阅 [\[Required\] 属性][Required_]，获取关于该特性的行为的详细信息。
 *  [\[StringLength\]][StringLength]：验证字符串属性值是否未超过指定长度限制。
 *  [\[Url\]][Url]：验证属性是否有 URL 格式。
 *  [\[Remote\]][Remote]：通过调用服务器上的操作方法，验证客户端上的输入。 请参阅 [\[Remote\] 属性][Remote_]，获取关于该特性的行为的详细信息。

关于更详细的其他内置验证特性，我们可以在官方文档中进行查阅?

[ASP.NET Core MVC 中的模型验证 | Microsoft Learn][ASP.NET Core MVC _ _ Microsoft Learn]

[a4b1995fcfc748ec8f4e7f02b6f08307.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/9614ca916eda42028aada8d16899e8ee.png
[c8c3afe101af4b85950ac31998a08f98.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/58ba94be276c4c68bf89bae9a7a0d9ac.png
[9d6ea3ca10624a539e9c98d2d25a8561.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/cf0bdb8df3854c95951077e399273da6.png
[d0e01f9a16ca4910969561b1865dbb01.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/99c3417968d3409882282a4266624e92.png
[4f2c6f00504449fa8b13d94690b1e8b8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/077b9f4606234f959be5d0955b6c7b58.png
[25d03451f8794507a40d8117f145e7d4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/35f0fa4570434acf96a8f0a7ccb46b47.png
[d00c26c51cfd4652899b73643cab0621.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/b0be8caa90b24f92bc09463fd69659bb.png
[JSON_Be JSON]: https://www.bejson.com/
[5120d7366bdd46dbb59fbd6189a98436.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/7897f5d2397e4fae84a52528c9b49ff3.png
[13ca5f5389214e119063ef0ea8ce923e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/6eac726d3cdc4199aaa3bb7a0a2decbf.png
[990bc54b07254ee8bbb5d3e43b026c40.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/d38939ff46694e4183d060f5ef17a72c.png
[ValidateNever]: https://learn.microsoft.com/zh-cn/dotnet/api/microsoft.aspnetcore.mvc.modelbinding.validation.validateneverattribute
[CreditCard]: https://learn.microsoft.com/zh-cn/dotnet/api/system.componentmodel.dataannotations.creditcardattribute
[jQuery Validation]: https://cdnjs.cloudflare.com/ajax/libs/jquery-validate/1.19.1/additional-methods.js
[Compare]: https://learn.microsoft.com/zh-cn/dotnet/api/system.componentmodel.dataannotations.compareattribute
[EmailAddress]: https://learn.microsoft.com/zh-cn/dotnet/api/system.componentmodel.dataannotations.emailaddressattribute
[Phone]: https://learn.microsoft.com/zh-cn/dotnet/api/system.componentmodel.dataannotations.phoneattribute
[Range]: https://learn.microsoft.com/zh-cn/dotnet/api/system.componentmodel.dataannotations.rangeattribute
[RegularExpression]: https://learn.microsoft.com/zh-cn/dotnet/api/system.componentmodel.dataannotations.regularexpressionattribute
[Required]: https://learn.microsoft.com/zh-cn/dotnet/api/system.componentmodel.dataannotations.requiredattribute
[Required_]: https://learn.microsoft.com/zh-cn/aspnet/core/mvc/models/validation?view=aspnetcore-8.0#non-nullable-reference-types-and-required-attribute
[StringLength]: https://learn.microsoft.com/zh-cn/dotnet/api/system.componentmodel.dataannotations.stringlengthattribute
[Url]: https://learn.microsoft.com/zh-cn/dotnet/api/system.componentmodel.dataannotations.urlattribute
[Remote]: https://learn.microsoft.com/zh-cn/dotnet/api/microsoft.aspnetcore.mvc.remoteattribute
[Remote_]: https://learn.microsoft.com/zh-cn/aspnet/core/mvc/models/validation?view=aspnetcore-8.0#remote-attribute
[ASP.NET Core MVC _ _ Microsoft Learn]: https://learn.microsoft.com/zh-cn/aspnet/core/mvc/models/validation?view=aspnetcore-8.0