ASP.NET沒有魔法_ASP.NET MVC模型驗證的示例分析

這篇文章主要介紹了ASP.NET沒有魔法_ASP.NET MVC模型驗證的示例分析，具有一定借鑒價值，感興趣的朋友可以參考下，希望大家閱讀完這篇文章之后大有收獲，下面讓小編帶著大家一起了解一下。

在注冊用戶時可以通過代碼的形式限制用戶名及密碼的格式，如果不符合要求那么就無法完成操作，如下圖：

該功能的原理是Identity基于的Entity Framework組件在添加用戶之前對用戶提交數據進行校驗后給出的錯誤信息。　　

數據校驗功能在每一個軟件系統中都是非常必要的，為了避免用戶輸入無效或非法數據導致的系統錯誤，需要在數據進行處理或持久化之前對其進行驗證確保數據的正確、有效性。

本文將從以下幾點來介紹ASP.NET MVC中的模型驗證機制：　　

● 輸入驗證

● .NET 的驗證簡介

● ASP.NET MVC的后端模型驗證

● ASP.NET MVC的客戶端模型驗證

● 關于ASP.NET MVC的客戶端驗證

● 自定義ASP.NET MVC中的模型驗證

輸入驗證

輸入驗證的目的就是用來判斷一個變量是否能夠滿足規定的要求，這里既然提到了“判斷”那么使用程序來實現時最直接的方式就是通過判斷語句來完成，如：

但是在.Net中是否有一種統一的方式來實現數據的驗證呢？否則每次通過判斷語句來寫驗證代碼既不能重用又影響閱讀。

.NET 的驗證簡介

在.Net中提供了一種基于特性的數據類型標記(DataAnnotations)、驗證機制。

1、數據類型的標記：

.Net中有一個名為system.componentmodel.dataannotations的類庫，里面包含了很多特性(Attribute)。這些特性用于標記.Net類型中的屬性的數據類型信息。比如數據長度、格式、能否為空等等。　　

下圖為該類庫中的部分類型，從中可以看到如信用卡、郵件地址、最大/最小長度等特性類型：

數據標記特性(Data Annotation attributes)有三種類型，分別是：　　

● 驗證特性：用于執行驗證規則，如郵箱地址、數據類型、數據長度、數字區間、正則表達式等驗證特性。

● 展示特性：用于指定被標記的類型或屬性如何在UI上展示。

● 模型關系特性：用于指定類成員與其它類型的關系，如外鍵特性等。

下圖是通過特性對一個實體類型的name屬性進行標記的結果，從標記的名稱可以輕易看出該name屬性是必填的并且最大長度為30，展示的名稱為“名稱”。

但需要注意的是system.componentmodel.dataannotations所提供的特性僅僅是一種描述，它不會因為你限制了一個字符串的長度就無法給它賦值超出限制的字符串，它必須手動調用驗證方法或者在ASP.NET MVC、EF中使用。(可參考：https://stackoverflow.com/questions/6496705/how-do-data-annotations-work) 　　

關于dataannotations提供的特性類型可參考：https://msdn.microsoft.com/en-us/library/system.componentmodel.dataannotations.aspx

2、數據類型的驗證

當使用數據特性標記對類型完成標記后，還需要通過專門的驗證類型才可以完成驗證，該類型同樣存在于system.componentmodel.dataannotations程序集中名為Validator，下圖是Validator的定義，從其描述來看該類用于對使用ValidationAttribute特性標記的類型、屬性、方法進行驗證：

3、類型驗證示例

通過一個Console程序來演示如何使用.Net中的數據驗證：　　

首先創建一個Console程序，并添加System.ComponentModel.DataAnnotations程序集的引用，然后編寫以下代碼：

運行后將輸出以下錯誤信息：

添加顯示特性后：

優化了驗證提示信息：

4、自定義驗證方式：

系統內置的數據驗證特性均是繼承至ValidationAttribute類型，下面就通過繼承該類型來實現一個自己的數據驗證方式：　　

首先添加一個繼承ValidationAttribute的類型，并重寫其IsValid方法，該方法中包含數據驗證的邏輯，并設置相應的錯誤信息：

然后在相應的類屬性上應用該特性：

驗證結果：

關于自定義驗證特性可參考：https://msdn.microsoft.com/en-us/library/cc668224.aspx

ASP.NET MVC的模型驗證

ASP.NET MVC中提供了基于特性標記的模型驗證的功能，既只要在用做action參數的類型屬性上添加對應的數據驗證特性，那么ASP.NET MVC在進行模型綁定時就會自動對被標記的屬性進行驗證。驗證的結果通過Controller中的ModelState的IsValid屬性體現。　　

下面就介紹如何在ASP.NET MVC中為Model添加數據驗證：

1.使用特性為Model的屬性進行標記，如必填、密碼類型及屬性間的比較等：

2.在Action代碼中添加ModelState.IsValid判斷，當出現錯誤時，將錯誤信息通過ModelState對象的AddModelError方法攜帶至View中：

3、在View中使用Html.ValidationSummary方法輸出驗證信息：

注：如果View中有用于客戶端驗證的代碼需要先注釋掉@Scripts.Render("~/bundles/jqueryval")，該文件用于客戶端驗證，客戶端驗證在后面介紹。

4、在頁面上使用Html對象根據模型生成對應的html標簽

5、運行程序

輸入空的用戶名和不匹配的兩個密碼，點擊提交后：

顯示驗證未通過：

頁面上輸出的內容：

6、使用display特性來優化屬性名稱的輸出：

執行結果：

ASP.NET MVC的客戶端模型驗證

前面介紹的是ASP.NET MVC服務端的模型驗證，當數據提交到服務器時進行驗證的方式，雖然能夠在業務邏輯之前過濾數據無效的請求，但是仍然需要將請求發送到服務器，當請求過多時這些無效的請求會占用大量的服務器資源，所以如果能夠在客戶端完成相應的驗證，那么對于客戶來說提升了響應速度，而對于服務器來說減少了壓力，ASP.NET MVC就結合Jquery Validation插件提供了瀏覽器端的數據驗證功能。　　

接下來就在上面代碼的基礎上，通過在頁面中引入驗證相關javascript實現在客戶端驗證：　　

1、添加以下代碼，引入驗證相關Js代碼：

2、使用Html對象的ForXXX方法在View上生成Model對應標記的Html代碼：

3、運行效果：

結果與服務端驗證一致，但是點擊注冊按鈕時不再去發送Post請求到服務器，而是通過js代碼在瀏覽器完成的數據驗證。

關于ASP.NET MVC的客戶端驗證Jquery Validation

Jquery Validation是一個Jquery的插件，它提供了強大的表單數據驗證功能，可以簡單快速的為Web應用添加一些常用的數據驗證，如必填、數字、郵箱、電話號碼、正則表達式等常用格式驗證。　　它的驗證功能是通過在表單的標簽中添加一些屬性或設置其類型來完成的，如下圖所示，該代碼來自官方文檔，它提供了長度限制、必填、Email格式、Url格式的驗證：

更多關于Jquery Validation的內容可參考文檔：https://jqueryvalidation.org/documentation/

Unobtrusive Javascript

Unobtrusive Javascript可以譯為非侵入式的Javascript，其目的就是為了分離HTML和Javascript，換句話說HTML中沒有JavaScript代碼，它們只有引用關系。這樣做既可以避免代碼混亂，又可以避免不同瀏覽器之間的兼容問題。　　

而ASP.NET MVC是通過在HTML中的標簽上插入data-val*等屬性，對相應的標簽進行標記，然后引入的js通過讀取這些特殊標記來完成特定的功能，以下是通過Html.TextBoxFor方法生成HTML：

從代碼中可以看到除了input標簽正常的屬性外還生成了data-val為前綴的相關屬性，這些屬性將用于輔助js代碼完成數據驗證。

關于@Scripts.Render("~/bundles/jqueryval")：

首先Scripts對象的Render方法是用于將指定的腳本文件路徑添加到頁面中，而它的參數是一個字符串數組代表腳本文件的路徑。　　

那么~/bundles/jqueryval指向的是哪個文件呢？　　

在ASP.NET MVC中提供了一個bundle的技術，它可以用來合并和壓縮JavaScript和css文件，bundle的配置一般在App_Start目錄下的BundleConfig.cs文件下，從下圖的代碼中就可以看出，~/bundles/jqueryval代表了能夠被jquery.validate*匹配的所有文件：

然后向注冊路由一樣將其注冊到一個全局靜態Bundle列表中：

這樣在UI上就可以使用~/bundles/jqueryval來獲取到與驗證相關的js文件，更多關于UI的內容將在后續文章中介紹。

自定義ASP.NET MVC中的模型驗證

上面介紹了ASP.NET MVC中的模型驗證，其內置了一些常用的驗證方式，但是在實際開發中仍然會出現無法滿足需求的情況，所以在這些情況下就需要根據實際需求來自定義驗證，包括后端驗證與前端驗證。　　

1、添加自定義驗證特性：

上面代碼需要注意以下幾點：　　

● 實現了ValidationAttribute類型并重寫了用于獲取錯誤信息的FormatErrorMessage方法以及用于驗證數據的IsValid方法。　　

● 實現了System.Web.Mvc命名空間下的IClientValidatable接口，該接口是ASP.NET MVC拓展的用于實現客戶端驗證的接口，該接口用于創建并返回一個驗證規則列表，該驗證規則主要包含了錯誤信息、驗證類型、驗證參數三個屬性，其中錯誤信息在默認的信息中添加了“來自客戶端驗證”用于區分服務端驗證。

注：由于客戶端驗證僅僅是ASP.NET MVC中的特性，所以IClientValidatable接口存在與System.Web.Mvc程序集中。

2、拓展Jquery Validation插件，添加一個名為myblog.validate.extension.js的驗證拓展文件，并對Jquery validation添加新的驗證方法(注：方法第一個參數與GetClientValidationRules方法中設置的ValidationType屬性一致)，最后通過jQuery.validator.unobtrusive.adapters添加MVC與Jquery Validation的關聯：

注：添加關聯代碼時需要添加名稱與ValidationType屬性一致的messages及rules。 　　

3、將拓展的js文件引入頁面中：　　

bundleConfig.cs：

頁面代碼：

4、將新添加的特性應用到相應的類型屬性上：

5、執行結果：

感謝你能夠認真閱讀完這篇文章，希望小編分享的“ASP.NET沒有魔法_ASP.NET MVC模型驗證的示例分析”這篇文章對大家有幫助，同時也希望大家多多支持億速云，關注億速云行業資訊頻道，更多相關知識等著你來學習!