將驗證添加到 ASP.NET Core MVC 應用

本節(jié)內容：

• 向 Movie 模型添加了驗證邏輯。
• 確保每當用戶創(chuàng)建或編輯電影時，都會強制執(zhí)行驗證規(guī)則。

堅持 DRY 原則

MVC 的設計原則之一是 DRY（“不要自我重復”）。 ASP.NET Core MVC 支持你僅指定一次功能或行為，然后使它應用到整個應用中。 這可以減少所需編寫的代碼量，并使編寫的代碼更少出錯，更易于測試和維護。

MVC 和 Entity Framework Core Code First 提供的驗證支持是 DRY 原則在實際操作中的極佳示例。可以在一個位置（模型類中）以聲明方式指定驗證規(guī)則，并且在應用中的所有位置強制執(zhí)行。

將驗證規(guī)則添加到電影模型

打開 Movie.cs 文件。 DataAnnotations 提供一組內置驗證特性，可通過聲明方式應用于任何類或屬性。 （它還包含 DataType 等格式特性，這些特性可幫助進行格式設置，但不提供任何驗證。）

更新 Movie 類以使用內置的 Required、StringLength、RegularExpression 和 Range 驗證特性。

C#

public class Movie
{
    public int Id { get; set; }

    [StringLength(60, MinimumLength = 3)]
    [Required]
    public string Title { get; set; }

    [Display(Name = "Release Date")]
    [DataType(DataType.Date)]
    public DateTime ReleaseDate { get; set; }

    [Range(1, 100)]
    [DataType(DataType.Currency)]
    [Column(TypeName = "decimal(18, 2)")]
    public decimal Price { get; set; }

    [RegularExpression(@"^[A-Z]+[a-zA-Z""'\s-]*$")]
    [Required]
    [StringLength(30)]
    public string Genre { get; set; }

    [RegularExpression(@"^[A-Z]+[a-zA-Z0-9""'\s-]*$")]
    [StringLength(5)]
    [Required]
    public string Rating { get; set; }
}

驗證特性指定要對應用這些特性的模型屬性強制執(zhí)行的行為：

• Required 和 MinimumLength 特性表示屬性必須有值；但用戶可輸入空格來滿足此驗證。
• RegularExpression 特性用于限制可輸入的字符。 在上述代碼中，Genre 和 Rating 必須使用純字母（禁用首字母大寫、空格、數(shù)字和特殊字符）。
• Range 特性將值限制在指定范圍內。
• StringLength 特性使你能夠設置字符串屬性的最大長度，以及可選的最小長度。
• 從本質上來說，需要值類型（如 decimal、int、float、DateTime），但不需要 [Required] 特性。

讓 ASP.NET Core 強制自動執(zhí)行驗證規(guī)則有助于提升你的應用的可靠性。 同時它能確保你無法忘記驗證某些內容，并防止你無意中將錯誤數(shù)據(jù)導入數(shù)據(jù)庫。

MVC 中的驗證錯誤 UI

運行應用并導航到電影控制器。

點擊“新建”連接添加新電影的鏈接。 使用無效值填寫表單。 當 jQuery 客戶端驗證檢測到錯誤時，會顯示一條錯誤消息。

 備注

可能無法在小數(shù)字段中輸入十進制逗號。 若要使 jQuery 驗證支持使用逗號（“,”）表示小數(shù)點的的非英語區(qū)域設置，以及支持非美國英語日期格式，必須執(zhí)行使應用全球化的步驟。 有關添加十進制逗號的說明，請參閱 GitHub 問題 4076。

請注意表單如何自動呈現(xiàn)每個包含無效值的字段中相應的驗證錯誤消息。 客戶端（使用 JavaScript 和 jQuery）和服務器端（若用戶禁用 JavaScript）都必定會遇到這些錯誤。

明顯的好處在于不需要在 MoviesController 類或 Create.cshtml 視圖中更改單個代碼行來啟用此驗證 UI。 在本教程前面創(chuàng)建的控制器和視圖會自動選取驗證規(guī)則，這些規(guī)則是通過在 Movie 模型類的屬性上使用驗證特性所指定的。 使用 Edit 操作方法測試驗證后，即已應用相同的驗證。

存在客戶端驗證錯誤時，不會將表單數(shù)據(jù)發(fā)送到服務器。 可通過使用 Fiddler 工具或 F12 開發(fā)人員工具在 HTTP Post 方法中設置斷點來對此進行驗證。

驗證工作原理

你可能想知道在不對控制器或視圖中的代碼進行任何更新的情況下，驗證 UI 是如何生成的。 下列代碼顯示兩種 Create 方法。

C#

// GET: Movies/Create
public IActionResult Create()
{
    return View();
}

// POST: Movies/Create
[HttpPost]
[ValidateAntiForgeryToken]
public async Task<IActionResult> Create(
    [Bind("ID,Title,ReleaseDate,Genre,Price, Rating")] Movie movie)
{
    if (ModelState.IsValid)
    {
        _context.Add(movie);
        await _context.SaveChangesAsync();
        return RedirectToAction("Index");
    }
    return View(movie);
}

第一個 (HTTP GET) Create 操作方法顯示初始的“創(chuàng)建”表單。 第二個 ([HttpPost]) 版本處理表單發(fā)布。 第二個 Create 方法（[HttpPost] 版本）調用 ModelState.IsValid 以檢查電影是否有任何驗證錯誤。 調用此方法將評估已應用于對象的任何驗證特性。 如果對象有驗證錯誤，則 Create 方法會重新顯示此表單。 如果沒有錯誤，此方法則將新電影保存在數(shù)據(jù)庫中。 在我們的電影示例中，在檢測到客戶端上存在驗證錯誤時，表單不會發(fā)布到服務器。當存在客戶端驗證錯誤時，第二個 Create 方法永遠不會被調用。 如果在瀏覽器中禁用 JavaScript，客戶端驗證將被禁用，而你可以測試 HTTP POST Create 方法 ModelState.IsValid 檢測任何驗證錯誤。

可以在 [HttpPost] Create 方法中設置斷點，并驗證方法從未被調用，客戶端驗證在檢測到存在驗證錯誤時不會提交表單數(shù)據(jù)。 如果在瀏覽器中禁用 JavaScript，然后提交錯誤的表單，將觸發(fā)斷點。 在沒有 JavaScript 的情況下仍然可以進行完整的驗證。

以下圖片顯示如何在 FireFox 瀏覽器中禁用 JavaScript。

以下圖片顯示如何在 Chrome 瀏覽器中禁用 JavaScript。

禁用 JavaScript 后，發(fā)布無效數(shù)據(jù)并單步執(zhí)行調試程序。

Create.cshtml 視圖模板的一部分在以下標記中顯示：

HTML

<h4>Movie</h4>
<hr />
<div class="row">
    <div class="col-md-4">
        <form asp-action="Create">
            <div asp-validation-summary="ModelOnly" class="text-danger"></div>
            <div class="form-group">
                <label asp-for="Title" class="control-label"></label>
                <input asp-for="Title" class="form-control" />
                <span asp-validation-for="Title" class="text-danger"></span>
            </div>           
       
        @*Markup removed for brevity.*@

操作方法使用上述標記來顯示初始表單，并在發(fā)生錯誤時重新顯示此表單。

輸入標記幫助程序使用 DataAnnotations 特性，并在客戶端上生成 jQuery 驗證所需的 HTML 特性。驗證標記幫助程序用于顯示驗證錯誤。 有關詳細信息，請參閱驗證。

此方法真正好的一點是：無論是控制器還是 Create 視圖模板都不知道強制實施的實際驗證規(guī)則或顯示的特定錯誤消息。 僅可在 Movie 類中指定驗證規(guī)則和錯誤字符串。 這些相同的驗證規(guī)則自動應用于 Edit 視圖和可能創(chuàng)建用于編輯模型的任何其他視圖模板。

需要更改驗證邏輯時，可以通過將驗證特性添加到模型在同一個位置實現(xiàn)此操作。（在此示例中為 Movie 類）。 無需擔心對應用程序的不同部分所強制執(zhí)行規(guī)則的方式不一致 - 所有驗證邏輯都將定義在一個位置并用于整個應用程序。 這使代碼非常簡潔，并且更易于維護和改進。 這意味著對 DRY 原則的完全遵守。

使用 DataType 特性

打開 Movie.cs 文件并檢查 Movie 類。 除了一組內置的驗證特性，System.ComponentModel.DataAnnotations 命名空間還提供格式特性。 我們已經在發(fā)布日期和價格字段中應用了 DataType 枚舉值。 以下代碼顯示具有適當 DataType 特性的 ReleaseDate 和 Price 屬性。

C#

[Display(Name = "Release Date")]
[DataType(DataType.Date)]
public DateTime ReleaseDate { get; set; }

[Range(1, 100)]
[DataType(DataType.Currency)]
public decimal Price { get; set; }

DataType 屬性僅提供相關提示來幫助視圖引擎設置數(shù)據(jù)格式（并提供元素/屬性，例如向 URL 提供 <a> 和向電子郵件提供 <a href="mailto:EmailAddress.com">）。 可以使用 RegularExpression 特性驗證數(shù)據(jù)的格式。 DataType 屬性用于指定比數(shù)據(jù)庫內部類型更具體的數(shù)據(jù)類型，它們不是驗證屬性。 在此示例中，我們只想跟蹤日期，而不是時間。 DataType 枚舉提供了多種數(shù)據(jù)類型，例如日期、時間、電話號碼、貨幣、電子郵件地址等。 應用程序還可通過 DataType 特性自動提供類型特定的功能。 例如，可以為 DataType.EmailAddress 創(chuàng)建 mailto: 鏈接，并且可以在支持 HTML5 的瀏覽器中為 DataType.Date 提供日期選擇器。 DataType 特性發(fā)出 HTML 5 data-（讀作 data dash）特性供 HTML 5 瀏覽器理解。 DataType 特性不提供任何驗證。

DataType.Date 不指定顯示日期的格式。 默認情況下，數(shù)據(jù)字段根據(jù)基于服務器的 CultureInfo 的默認格式進行顯示。

DisplayFormat 特性用于顯式指定日期格式：

C#

[DisplayFormat(DataFormatString = "{0:yyyy-MM-dd}", ApplyFormatInEditMode = true)]
public DateTime ReleaseDate { get; set; }

ApplyFormatInEditMode 設置指定在文本框中顯示值以進行編輯時也應用格式。 （你可能不想為某些字段執(zhí)行此操作 — 例如對于貨幣值，你可能不希望文本框中的貨幣符號可編輯。）

可以單獨使用 DisplayFormat 特性，但通常建議使用 DataType 特性。 DataType 特性傳達數(shù)據(jù)的語義而不是傳達如何在屏幕上呈現(xiàn)數(shù)據(jù)，并提供 DisplayFormat 不具備的以下優(yōu)勢：

• 瀏覽器可啟用 HTML5 功能（例如顯示日歷控件、區(qū)域設置適用的貨幣符號、電子郵件鏈接等）
• 默認情況下，瀏覽器將根據(jù)區(qū)域設置采用正確的格式呈現(xiàn)數(shù)據(jù)。
• DataType 特性使 MVC 能夠選擇正確的字段模板來呈現(xiàn)數(shù)據(jù)（如果 DisplayFormat 由自身使用，則使用的是字符串模板）。

 備注

jQuery 驗證不適用于 Range 屬性和 DateTime。 例如，以下代碼將始終顯示客戶端驗證錯誤，即便日期在指定的范圍內：

[Range(typeof(DateTime), "1/1/1966", "1/1/2020")]

需要禁用 jQuery 日期驗證才能使用具有 DateTime 的 Range 特性。 通常，在模型中編譯固定日期是不恰當?shù)?，因此不推薦使用 Range 特性和 DateTime。

以下代碼顯示組合在一行上的特性：

C#

public class Movie
{
    public int Id { get; set; }

    [StringLength(60, MinimumLength = 3)]
    public string Title { get; set; }

    [Display(Name = "Release Date"), DataType(DataType.Date)]
    public DateTime ReleaseDate { get; set; }

    [RegularExpression(@"^[A-Z]+[a-zA-Z""'\s-]*$"), Required, StringLength(30)]
    public string Genre { get; set; }

    [Range(1, 100), DataType(DataType.Currency)]
    [Column(TypeName = "decimal(18, 2)")]
    public decimal Price { get; set; }

    [RegularExpression(@"^[A-Z]+[a-zA-Z0-9""'\s-]*$"), StringLength(5)]
    public string Rating { get; set; }
}

在本系列的下一部分中，我們將回顧應用，并對自動生成的 Details 和 Delete 方法進行一些改進。