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

ASP.NET Core MVC的Model Binding會將HTTP Request數據，以映射的方式對應到參數中。基本上跟ASP.NET MVC差不多，但能Binding的來源更多了一些。
本篇將介紹ASP.NET Core的Model Binding。

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
  透過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。

如果三者都傳入的話，會依照優先順序取值Form > Route > Query。

Binding Attributes

除了預設的三種Binding 來源外，還可以通過Model Binding Attributes 從HTTP Request 的其他數據中Binding。有以下6 種：

• [FromHeader]
  從HTTP Header取值。
• [FromForm]
  通過HTTP POST的form取值。
• [FromRoute]
  是通過MVC Route URL取值。
• [FromQuery]
  是通過URL Query參數取值。

• [FromBody]
  從HTTP Body取值，通常用於取JSON, XML。
  ASP.NET Core MVC預設的序列化是使用JSON，如果要傳XML格式做Model Binding的話，要在MVC服務加入XmlSerializerFormatters，如下：

  Startup.cs

// ...
public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc()
            .AddXmlSerializerFormatters();
}

• [FromServices]
  這個比較特別，不是從HTTP Request取值，而是從DI容器取值。
  DI預設是使用Constructor Injection，但Controller可能會因為每個Action用到不一樣的Service導致很多參數，所以也可以在Action注入Service。

范例程序

// ...
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

logger is null: False.

BodySample輸出結果：

• JSON
   

• XML
  

Model 驗證

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";
        }
    }
}

參考

Overview of ASP.NET Core MVC 
Introduction to model validation in ASP.NET Core MVC 
ASP.NET CORE 2.0 MVC MODEL BINDING 
ASP.NET CORE 2.0 MVC MODEL VALIDATION

 

老司機發車啦：https://github.com/SnailDev/SnailDev.NETCore2Learning