【譯】使用VS2010和MVC2.0增強驗證功能

MVC2.0的RTM版本終于在2010年3月11日推出，借此，我也為我的Contact Manager application增加一些新的特性。盡管本篇文章主要關注使用DataAnnotations來對model進行驗證，但我也會對最新版本特性進行簡單的接觸。

在開始之前，我不得不說明我已經安裝了VS 2010 RC1,并使用它将老版本轉換為ASP.Net 4.0（老版本可以點選這裡下載下傳）

大多數情況下，當你接收到來自使用者從form表單post來的資訊後，你的驗證代碼往往會檢查相應的值是否存在，資料類型是否正确以及資料的範圍是否正确。至少，你應該保證每當一個函數接受使用者輸入時，就應該執行相應的驗證邏輯。這意味着有些時候在整個程式中的不同位置，你會對同一個或者相似的值進行多次驗證。比如說你想限制使用者的姓氏不大于20個字元，那這樣的驗證需要在程式的好幾個部分實作。直到Jan Vennegoor of Hesselink的出現（荷蘭球隊的一名球員，目前為doomed Hull City FC效力）,在他的薪水還沒有随着他服役的球隊被降級以前，他來到你的網站想購買一個價值50，000英鎊的耳環，他以他22個字元長度的姓氏注冊，但他發現他的姓氏不在允許的範圍之内時，他很氣憤的離開你的網站并且給web master留下不滿的評論。很明顯，你可不想讓類似的情況出現，是以你不得不在你的程式中找到所有驗證姓氏長度的相關代碼，并一一修正以便能接受更長的姓氏……

如果将驗證代碼放到一個集中的地方時，那類似上面所說的改變會不會變得更簡單些？Model中的DataAnnotations正是為此而來，在MVC2.0中，這一特性被包含在内。

DataAnnotations作為.net Framework的一部分已經有一段時間了，但是MVC2.0中增加了ModelMetaData類,這是儲存MetaData的容器，預設會使用同樣也是新增類的DataAnnotationsMetaDataProvider類。因為傳入的值會由Action方法接受model binding作為比對傳入參數和action的參數而介入，在MVC2.0中，預設的model binder使用DataAnnotationsMetaDataProvider來擷取metadata中model binder嘗試比對的對象，如果驗證用的metadata存在，則其會通過對對象的屬性和傳入的值比較來進驗證，這類meta由你通過使用标簽(Attribute)修飾屬性來實作。

下面例子中我通過原程式中添加聯系人這一過程來描述使用DataAnnotatioins的方法，這裡我們使用自定義ViewModel，名為：ContactPersonViewModel。通過Contact.Add()這個action方法來添加聯系人，代碼如下：

using System;

using System.Collections.Generic;

using System.Web.Mvc;

using System.ComponentModel;

namespace ContactManagerMVC.Views.ViewModels

{

public class ContactPersonViewModel

{

public int Id { get; set; }

public string FirstName { get; set; }

public string MiddleName { get; set; }

public string LastName { get; set; }

public DateTime DateOfBirth { get; set; }

public IEnumerable<SelectListItem> Type { get; set; }

}

下面，我在為屬性添加一些标簽(Attribute):

using System.ComponentModel.DataAnnotations;

using ContactManagerMVC.Attributes;

[Required(ErrorMessage = "Please provide a First Name!")]

[StringLength(25, ErrorMessage = "First name must be less than 25 characters!")]

[DisplayName("First Name")]

[DisplayName("Middle Name")]

[Required(ErrorMessage = "Please provide a Last Name!")]

[StringLength(25, ErrorMessage = "Last name must be less than 25 characters!")]

[DisplayName("Last Name")]

[Required(ErrorMessage = "You must provide a Date Of Birth!")]

[BeforeTodaysDate(ErrorMessage = "You can't add someone who hasn't been born yet!")]

[DisplayName("Date Of Birth")]

public DateTime? DateOfBirth { get; set; }

上面标簽的絕大多數标簽都是在System.ComponentModel.Annotations命名空間内，隻有RequiredAttribute标簽不在此命名空間内，這個标簽聲明此值必須是一個有效值，并且包含ErrorMessage屬性。這個屬性可以讓你傳入自定義錯誤資訊。StringLengthAttribute标簽指定了屬性可以接受的最小值和最大值範圍。當和RequiredAttribute标簽結合使用時，隻需要設定可以接受的最大值。DisplayNameAttribute用于設定屬性如何顯示.

上面标簽中BeforeTodaysDateAttribute标簽并不是.net Framework所提供，這是一個自定義标簽，用于檢測日期是否比目前的日期要早，你可以看到ErrorMessage值被設定。這個标簽用于防止任何被添加到聯系人清單的聯系人還未出生-.-!!,下面是這個标簽的代碼:

namespace ContactManagerMVC.Attributes

public class BeforeTodaysDateAttribute : ValidationAttribute

public override bool IsValid(object value)

{

if (value == null)

{

return true;

}

DateTime result;

if (DateTime.TryParse(value.ToString(), out result))

if (result < DateTime.Now)

{

return true;

}

return false;

}

很簡單是吧，這個類繼承了ValidationAttribute并重寫了IsValid()虛方法，如果未提供值，或是值小于目前日期(DateTime.Now)，則傳回True.

利用标簽(Attribute)的方式讓在一個集中的地方應用驗證規則變得簡單，現在，隻要ContactPersonViewModel在程式中被用到了，則驗證規則同時也會被應用到。這常常如此(http://www.asp.net/learn/mvc/tutorial-39-cs.aspx)，但現在DefaultModelBinder内的DataAnnotations被支援，下面來看新版本的Add Partial View：

<%@ Control Language="C#" Inherits="System.Web.Mvc.ViewUserControl<ContactPersonViewModel>" %>

$(function() {

$('#DateOfBirth').datepicker({ dateFormat: 'yy/mm/dd' });

});

$('#save').click(function () {

$.ajax({

type: "POST",

url: $("#AddContact").attr('action'),

data: $("#AddContact").serialize(),

dataType: "text/plain",

success: function (response) {

if (response == "Saved") {

window.location = "/";

}else {

$("#details").html(response);

}

});

</script>

<% using (Html.BeginForm("Add", "Contact", FormMethod.Post, new { id = "AddContact" }))

{%>

<table>

<tr>

<td class="LabelCell"><%= Html.LabelFor(m => m.FirstName)%> </td>

<td><%= Html.TextBox(m => m.FirstName)%>

<%= Html.ValidationMessageFor(m => m.FirstName)%></td>

</tr>

<td class="LabelCell"><%= Html.LabelFor(m => m.MiddleName)%> </td>

<td><%= Html.TextBox(m => m.MiddleName)%></td>

<td class="LabelCell"><%= Html.LabelFor(m => m.LastName)%> </td>

<td><%= Html.TextBox(m => m.LastName)%>

<%= Html.ValidationMessageFor(m => m.LastName)%></td>

<td class="LabelCell"><%= Html.LabelFor(m => m.DateOfBirth)%> </td>

<td><%= Html.TextBox(m => m.DateOfBirth)%>

<%= Html.ValidationMessageFor(m => m.DateOfBirth)%></td>

</td>

</table>

<% } %>

可以看出，這裡使用新的強類型Html Helper.對前面項目修改的兩處是利用了jQuery代碼。第一處是添加聯系人的Partial View是通過AJax送出，如果驗證失敗，則添加的form會再次被顯示，如果驗證通過，新的聯系人被添加到清單中，頁面會重新整理繼而顯示更新後包含新聯系人的清單。下面來看如果不輸入任何日期時點選Save按鈕的效果：

由于下面幾種原因，原來的Action方法需要被修正。首先修改action方法使其接受ContactPersonViewModel而不是ContactPerson作為參數，這是因為相關的驗證規則應用于ContactPersonViewModel,如果不将參數類型改變，那model binder依然能将傳入的值和ContactPerson的屬性相比對，但所有的驗證規則就不複存在了。第二個改變是檢查ModelState的IsValid屬性是否有效，否則整個驗證就變得毫無意義.

[AcceptVerbs(HttpVerbs.Post)]

public ActionResult Add([Bind(Exclude = "Id, Type")]ContactPersonViewModel person)

if (ModelState.IsValid)

var p = new ContactPerson

FirstName = person.FirstName,

MiddleName = person.MiddleName,

LastName = person.LastName,

Type = Request.Form["Type"].ParseEnum<PersonType>()

};

if (person.DateOfBirth != null)

p.DateOfBirth = (DateTime)person.DateOfBirth;

ContactPersonManager.Save(p);

return Content("Saved");

var personTypes = Enum.GetValues(typeof(PersonType))

.Cast<PersonType>()

.Select(p => new

ID = p,

Name = p.ToString()

});

person.Type = new SelectList(personTypes, "ID", "Name");

return PartialView(person);

在model綁定過程中，我去掉了id和Type屬性，因為在把聯系人添加到資料庫以前并不會存在id屬性，而去掉Type屬性是因為在ViewModel中它的類型是SelectList,但在BLL層中ContactPerson對象中卻是枚舉類型，如果ModelState的IsValid屬性為True（注：既驗證通過）,則ViewModel的屬性會和ContactPerson對象的屬性進行比對，如果IsValid不為True,資料會回傳到View中顯示驗證失敗的相關資訊。

上面代碼中我們注意到了Request.Form[“Type”]這個string類型的ParseEnum<T>擴充方法，這也是為什麼我去掉Type屬性，隻有這樣它才會被轉換為适當的類型。擴充方法的原型（在我的Google Analytics 文中）如下：

public static T ParseEnum<T>(this string token)

return (T)Enum.Parse(typeof(T), token);

edit這個action方法也是如此，除了對DateOfBirth進行編輯那部分：

<tr>

<td class="LabelCell"><%= Html.LabelFor(m => m.DateOfBirth)%> </td>

<td><%= Html.EditorFor(m => m.DateOfBirth)%>

<%= Html.ValidationMessageFor(m => m.DateOfBirth)%></td>

</tr>

這裡我并沒有使用TextBoxFor<T>擴充方法，而是使用了EditorFor<T>方法，預設情況下，DateTime類型都以hh:mm:ss這樣的方式顯示，但我并不喜歡這種格式，是以我建立了一個格式化顯示時間日期的模闆，在View/Shared目錄下，我添加了一個名為EditorTemplates(這也是MVC中應有命名方式，因為MVC會自動搜尋這個位置)并在此目錄下添加一個名為DateTime的Partial View,這也是MVC的慣例，如圖：

而DateTime.ascx的代碼如下：

<%@ Control Language="C#" Inherits="System.Web.Mvc.ViewUserControl<System.DateTime?>" %>

<%= Html.TextBox("", Model.HasValue ? Model.Value.ToShortDateString() : string.Empty) %>

雖然隻有短短兩行代碼，但是可以讓時間日期如果為空時，什麼都不顯示，而如果時間存在，則以ShortDate的格式顯示。

總結

本篇文章研究了ASP.Net MVC 2.0中利用DataAnnotations來進行驗證，現在這已經是.net framework的一部分。文中還簡單的接觸了新版本中的一些特性，包括強類型的HTML Helper以及模闆。本篇文章的代碼使用VS 2010RC1建立的，是以代碼不能在VWD 和 VS的環境中調試。

聯系人程式在添加了額外的驗證功能後進一步更新，但離完成還遙遙無期，在未來的文章中，我會繼續更新這個程式。

代碼可以點選這裡下載下傳

------------------------------

原文連結:Validating the Contact Manager with MVC 2.0 And VS 2010

translated byCareySon

本文轉自CareySon部落格園部落格，原文連結http://www.cnblogs.com/CareySon/archive/2010/04/07/1706512.html如需轉載請自行聯系原作者

【譯】使用VS2010和MVC2.0增強驗證功能

繼續閱讀

vue （vue2.0）使用總結(從大體結構總結)

無元件上傳圖檔到資料庫中，最完整解決方案

vue搭建過程及出現問題

【MySQL資料庫】資料庫索引事務1.索引2.事務

/\B(?=(?:\d{3})+$)/g 一條令人費解的正規表達式

neo4j之cypher使用文檔

C經典書籍筆記——C陷阱與缺陷②(文法陷阱之優先級)一、錯誤案列二、優先級規律

适用于JavaScript的ECMAScript 2020規範向前發展

NOSQL安全攻擊

mybatis_入門程式Mybatis入門

JS生成uuid的四種方法

線性表之順序表的實作

登入plsql 報錯 the account is locked --使用者被鎖

C++判斷素數、求最大公約數代碼判斷一個數是否為素數求兩個數的最大公約數

SequoiaDB巨杉資料庫C++驅動概述

layui多任務上傳添加進度條