ASP.NET Core 模型驗證的一個小小坑

今天在我們的一個項目中遇到一個 asp.net core 模型驗證（model validation）的小問題。當模型屬性的類型是 bool ，而提交上來的該屬性值是 null ，asp.net core 在模型綁定時會使用該屬性的默認值（這很好），但是除此之外 asp.net core 做了一個額外的小動作， 會觸發模型驗證失敗（ModelState.IsValid 為 false），下面用示例代碼看一下。

示例 Controller 代碼

public class SignInModel
{
    public bool IsRemember { get; set; }
}

public class AccountController : Controller
{
    public IActionResult SignIn([FromForm]SignInModel model)
    {
        Console.WriteLine(ModelState.IsValid);

        if(!ModelState.IsValid)
        {
            var errors = ModelState.Select(s => new
            {
                s.Key,
                Value = string.Join("\n", s.Value.Errors.Select(e => e.ErrorMessage))
            });
            Console.WriteLine(JsonConvert.SerializeObject(errors));
        }

        Console.WriteLine("model.IsRemember:" + model.IsRemember);
        return Ok();
    }
}

用 curl 發請求的命令

$ curl -s -i -X POST -d 'isremember=' -H "Content-Type: application/x-www-form-urlencoded" localhost:5000/account/signin

dotnet run 控制台顯示的信息

False
[{"Key":"IsRemember","Value":"The value '' is invalid."}]
model.IsRemember:False

這個小動作讓人始料不及，因為我們沒有對 IsRemember 屬性添加驗證規則，卻觸發了模型驗證失敗，造成用戶的整個提交請求失敗。如果你使用 asp.net core 模型驗證，需要小心這個小小坑。

注：遇到這個問題的項目用的是 asp.net core 3.0 preview 6