asp.net core MVC 控制器，接收參數，數據綁定

1.參數

HttpRequest

HttpRequest 是用戶請求對象
QueryString
Form
Cookie
Session
Header
實例：

        public IActionResult Index() { QueryString x = Request.QueryString; // ?a=1 string x = Request.Query["a"]; //1 return View(); }

HttpContext

HttpContext 是用戶請求上下文
提供Session屬性獲取Session對象
Session.Set設置
Session.Remove移除
Session.TryGetValue獲取數據

2.數據綁定

2.1.Model Binding

要接收Client 傳送來的數據，可以通過Action 的參數接收，如下：

using Microsoft.AspNetCore.Mvc; namespace MyWebsite.Controllers { public class HomeController : Controller { public IActionResult Index(int id) { return Content($"id: {id}"); } } }

id就是從HTTP Request的內容被Binding的Model參數。
預設的Model Binding會從HTTP Request的三個地方取值(優先順序由上到下)：
如果三者都傳入的話，會依照優先順序取值Form > Route > Query。

• Form
  透過HTTP POST的form取值。如下圖：
  
• Route
  是通過MVC Route URL取值。
  如：http://localhost:5000/Home/Index/2，id取出的值就會是2。
• Query
  是通過URL Query參數取值。
  如：http://localhost:5000/Home/Index?id=1，id取出的值就會是1。

2.2.Attribute Binding

默認綁定方式，使用特性：

[FromBody] 請求體
[FromHeader] headers
[FromQuery] 查詢字符串
[FromRoute] 路由數據
[FromForm] 表單數據
[FromServices] 服務注冊

示例1 FromHeader

前台：

<div style="height:100px"> <input type="button" value="提交帶header參數" onclick="save()" /> </div> <script> function save() { $.ajax({ url: "home/index", beforeSend: function (xhr) { xhr.setRequestHeader("username", "tangsansan"); }, type:"post", success: function(data) { } }); } </script>

后台：

        public IActionResult Index([FromHeader] string username) { QueryString x = Request.QueryString; return View(); }

示例2

public class HomeController : Controller { public IActionResult FirstSample( [FromHeader]string header, [FromForm]string form, [FromRoute]string id, [FromQuery]string query) { return Content($"header: {header}, form: {form}, id: {id}, query: {query}"); } public IActionResult DISample([FromServices] ILogger<HomeController> logger) { return Content($"logger is null: {logger == null}."); } public IActionResult BodySample([FromBody]UserModel model) { return Ok(model); } } // ... public class UserModel { public int Id { get; set; } public string Name { get; set; } public string Email { get; set; } public string PhoneNumber { get; set; } public string Address { get; set; } }

輸出結果

FirstSample輸出結果：

DISample輸出結果：
http://localhost:5000/Home/DISample
BodySample輸出結果：

• JSON
  
• XML
  

3.模型驗證

Model Binding 也可以順便幫忙驗證字段數據，只要在字段的屬性上面帶上Validation Attributes，如下：

using System.ComponentModel.DataAnnotations; // ... public class UserModel { [Required] public int Id { get; set; } [RegularExpression(@"\w+")] [StringLength(20, MinimumLength = 4)] public string Name { get; set; } [EmailAddress] public string Email { get; set; } [Phone] public string PhoneNumber { get; set; } [StringLength(200)] public string Address { get; set; } }

然后在Action 加上判斷：

Controllers\HomeController.cs

using Microsoft.AspNetCore.Mvc; namespace MyWebsite.Controllers { public class HomeController : Controller { // ... public IActionResult BodySample([FromBody]UserModel model) { // 由於 Id 是 int 類型，int 默認為 0 // 雖然帶上了 [Required]，但不是 null 所以算是有值。 if (model.Id < 1) { ModelState.AddModelError("Id", "Id not exist"); } if (ModelState.IsValid) { return Ok(model); } return BadRequest(ModelState); } } }

.NET Core提供了很多的Validation Attributes，可以參考官網 System.ComponentModel.DataAnnotations

自定義Validation Attributes

如果.NET Core提供的Validation Attributes不夠用還可以自己做。
例如上述范例的數據模型多了生日字段，需要驗證年齡：

using System; using System.ComponentModel.DataAnnotations; namespace MyWebsite.Attributes { public class AgeCheckAttribute : ValidationAttribute { public int MinimumAge { get; private set; } public int MaximumAge { get; private set; } public AgeCheckAttribute(int minimumAge, int maximumAge) { MinimumAge = minimumAge; MaximumAge = maximumAge; } protected override ValidationResult IsValid(object value, ValidationContext validationContext) { var date = Convert.ToDateTime(value); if (date.AddYears(MinimumAge) > DateTime.Today || date.AddYears(MaximumAge) < DateTime.Today) { return new ValidationResult(GetErrorMessage(validationContext)); } return ValidationResult.Success; } private string GetErrorMessage(ValidationContext validationContext) { // 有帶 ErrorMessage 的話優先使用 // [AgeCheck(18, 120, ErrorMessage="xxx")] if (!string.IsNullOrEmpty(this.ErrorMessage)) { return this.ErrorMessage; } // 自定義錯誤信息 return $"{validationContext.DisplayName} can't be in future"; } } }

參考:

snailteam，ASP.NET Core 2 學習筆記（九）模型綁定