只要一直走谊惭，慢點(diǎn)又何妨蝙场。
在使用MVC模式進(jìn)行開發(fā)時(shí)凌停，數(shù)據(jù)注解是經(jīng)常使用的(模型之上操作)，下面是我看書整理的一些常見的用法售滤。
什么是驗(yàn)證罚拟，數(shù)據(jù)注解
驗(yàn)證
從全局來看，發(fā)現(xiàn)邏輯僅是整個(gè)驗(yàn)證的很小的一部分完箩。驗(yàn)證首先需要管理用戶友好(本地化)的與驗(yàn)證邏輯相關(guān)的錯(cuò)誤提示消息赐俗；當(dāng)驗(yàn)證失敗時(shí)，在把這些錯(cuò)誤提示消息呈現(xiàn)給用戶界面上嗜憔，當(dāng)然還要向用戶提供從驗(yàn)證失敗中恢復(fù)的機(jī)制秃励。數(shù)據(jù)注解
注解是一種通用機(jī)制，可以用來向框架注入元數(shù)據(jù)吉捶，同時(shí)夺鲜，框架不只驅(qū)動(dòng)元數(shù)據(jù)的驗(yàn)證，還可以在生成顯示和編輯模型的HTML標(biāo)記時(shí)使用元數(shù)據(jù)呐舔。通俗的說就是模型上面的特定標(biāo)識(shí)符(具有一定意義和作用)币励。
驗(yàn)證注解的使用
數(shù)據(jù)注解定義在一般在命名空間”System.ComponentModel.DataAnnotations”提供了服務(wù)器端驗(yàn)證的功能，在模型屬性上使用時(shí)珊拼，框架也支持客戶端驗(yàn)證食呻。注解后面都是可以添加錯(cuò)誤提示語(yǔ)的,ErrorMessage是每個(gè)驗(yàn)證特性中用來設(shè)置錯(cuò)誤提示消息的參數(shù)，比如:
[Required(ErrorMessage = "不能為空")]
public int Age { get; set; }
-
Required
強(qiáng)調(diào)屬性是必須的澎现，不可為空仅胞。當(dāng)屬性中有一個(gè)是null或空時(shí)，會(huì)引發(fā)一個(gè)驗(yàn)證錯(cuò)誤剑辫。[Required] public int Age { get; set; } -
StringLength
要求必須輸入名字的長(zhǎng)度干旧。參數(shù)可以限制最小的。如下：[StringLength(160,MinimumLength = 3)] public string Name { get; set; } -
RegularExpression
正則表達(dá)式驗(yàn)證妹蔽，比如郵箱等需要驗(yàn)證正則的地方椎眯。很是方便挠将，這樣就減少了服務(wù)端的驗(yàn)證。[RegularExpression(@"^([a-zA-Z0-9_-])+@([a-zA-Z0-9_-])+(.[a-zA-Z0-9_-])+",ErrorMessage = "郵箱輸入有誤编整，重新輸入舔稀。")] public string Email { get; set; } -
Range
用來指定數(shù)值類型值得最小值和最大值。主要為int類型服務(wù)掌测。其余的也可以内贮，需要使用構(gòu)造函數(shù)的重載版本。Type參數(shù)來做赏半。[Range(20,30,ErrorMessage = "年齡不符合要求")] public int Age { get; set; }
[Range(typeof(decimal),"0.00","59.99")]
public decimal Price { get; set; }
-
Compare
確定兩個(gè)模型屬性擁有一樣的值贺归。密碼的驗(yàn)證(輸入兩次，看二者是否一樣断箫。)拂酣，參數(shù)為前面模型的值。[Required(ErrorMessage = "密碼不能為空")] public string Password { get; set; } [Compare("Password")] public string PasswordPalt { get; set; } Remote
此特性利用服務(wù)器端的回調(diào)函數(shù)執(zhí)行客戶端的驗(yàn)證邏輯仲义。通俗的說就是這個(gè)特性可以直接找到某個(gè)控制器的action并且執(zhí)行其中的方法婶熬。
/// <summary>
/// 驗(yàn)證模型中輸入的姓名是否和數(shù)據(jù)庫(kù)中重復(fù)
/// </summary>
/// <returns></returns>
public JsonResult CheckUserName(string username)
{ //數(shù)據(jù)庫(kù)中的相關(guān)驗(yàn)證
return Json(DateTime.Now.ToString(),JsonRequestBehavior.AllowGet);
}
[Remote("CheckUserName", "Admin")]
public string UserName { get; set; }
上面控制器操作會(huì)利用與UserName屬性同名的參數(shù)進(jìn)行驗(yàn)證，同時(shí)返回一個(gè)javascript object Notaion(json)對(duì)象中的布爾類型值(0/1)
-
自定義回復(fù)消息占位符
使用{0}占位符埃撵，來顯示用戶的輸入赵颅，并且形成友好提示。[Range(20,30,ErrorMessage = "年齡{0}不符合要求")] public int Age { get; set; } 服務(wù)端的一些處理(驗(yàn)證與綁定)
ASP.NET MVC的驗(yàn)證特性是由模型綁定器暂刘，模型元數(shù)據(jù)饺谬，模型驗(yàn)證器和模型狀態(tài)組成。
驗(yàn)證和模型綁定
操作方法中添加參數(shù)這里有一個(gè)隱式地執(zhí)行模型綁定谣拣，一般我們都需要這樣寫募寨，這樣也安全，不會(huì)說暴露出來參數(shù)森缠。
利用UpdateModel或TryUpdateModel方法顯式執(zhí)行綁定
這個(gè)實(shí)際項(xiàng)目中使用的很少拔鹰，一般都是通過隱式進(jìn)行轉(zhuǎn)換的。
[HttpPost,ActionName("Create")]
public ActionResult CreatePost(Student model)
{
var model2 = new Student();
UpdateModel(model2);
if (TryUpdateModel(model2))
{
}
return View(model);
}
可以看到參數(shù)中的為隱式轉(zhuǎn)換贵涵，里面的model2為顯式轉(zhuǎn)換列肢。if中的返回的是bool類型。模型綁定器一旦使用新值完成對(duì)模型屬性的更新宾茂，就會(huì)利用當(dāng)前的 模型元數(shù)據(jù)獲得模型的所有驗(yàn)證器瓷马。MVC運(yùn)行時(shí)提供了一個(gè)驗(yàn)證器(DataAnnotationsModelValidator)來與數(shù)據(jù)注解一同工作，這個(gè)模型驗(yàn)證器會(huì)找到所有的驗(yàn)證特性并執(zhí)行它們包含的驗(yàn)證邏輯跨晴，模型綁定器捕獲所有失敗的驗(yàn)證規(guī)則并把它們放入模型狀態(tài)中决采。
編程的一個(gè)重要原則是不能相信用戶的輸入
驗(yàn)證與模型狀態(tài)
模型綁定的副產(chǎn)品是模型狀態(tài)，也就是我們服務(wù)端驗(yàn)證的ModelState,此狀態(tài)中不僅包含用戶的輸入坟奥，也含有每個(gè)相關(guān)屬性的所有錯(cuò)誤(與模型狀態(tài)本身有關(guān)的錯(cuò)誤)树瞭，有錯(cuò)誤，ModelState.IsValid就返回false爱谁。從而我們就可以進(jìn)行驗(yàn)證晒喷。
public ActionResult CreatePost(Student model)
{
var s=ModelState.IsValidField("UserName");
var ss=ModelState["UserName"].Errors.Count;
var userName = ModelState["UserName"].Errors[0].ErrorMessage; //獲取錯(cuò)誤消息
if (ModelState.IsValid) //返回bool類型
{
}
return View(model);
}
顯示和編輯注解
-
Display
顯示模型屬性設(shè)置友好的“顯示名稱”[Display(Name = "姓名")] [StringLength(160,MinimumLength = 3)] public string Name { get; set; } ScaffoldColumn
可以隱藏HTML的輔助方法
[ScaffoldColumn(false)]
public string Address { get; set; }
-
DisplayFormat
處理屬性各種格式化選項(xiàng)，當(dāng)屬性包含空值访敌，可以提供可選的顯示文本凉敲。也可以為包含標(biāo)記的屬性關(guān)閉HTML編碼。還可以運(yùn)行時(shí)指定一個(gè)應(yīng)用于屬性值的格式化字符串寺旺。[DisplayFormat(ApplyFormatInEditMode = true,DataFormatString = "{0:c}")] public decimal Total { get; set; } ReadOnly
可以確保默認(rèn)的模型綁定器不使用請(qǐng)求中的新值來更新屬性爷抓。-
DataType
運(yùn)行時(shí)提供關(guān)于屬性的特定用途信息。String類型的屬性可應(yīng)用于很多場(chǎng)合--可以保存e-mail地址阻塑，URL或密碼蓝撇。[Required(ErrorMessage = "密碼不能為空")] [DataType(DataType.Password)] public string Password { get; set; }
- UIHint
給運(yùn)行時(shí)提供一個(gè)模版名稱，以備調(diào)用模版輔助方法渲染輸出時(shí)使用陈莽。
自定義驗(yàn)證邏輯
1:將驗(yàn)證邏輯封裝在自定義的數(shù)據(jù)注解中渤昌。
2:將驗(yàn)證邏輯封裝在模型對(duì)象中。
把驗(yàn)證邏輯封裝在自定義的數(shù)據(jù)注解中可以輕松地實(shí)現(xiàn)在多個(gè)模型中重用邏輯走搁。需要在特性內(nèi)部編寫代碼以應(yīng)對(duì)不同類型的模型中独柑。
- 自定義注解
所有的驗(yàn)證注解特性最終都派生自基類ValidationAttribute,它是個(gè)抽象類，在System.ComponentMode.DataAnnotation中定義私植。同樣自定義的驗(yàn)證邏輯必須派生自ValidationAttribute的類忌栅。且重寫IsValid方法(方法里面實(shí)現(xiàn)我們相應(yīng)的邏輯)。
需求：限制用戶輸入地址中單詞數(shù)量曲稼，設(shè)定一個(gè)最大值索绪。
/// <summary>
/// 自定義模型驗(yàn)證
/// 輸入數(shù)字的單詞最大數(shù)量
/// </summary>
public class MaxWordsAttribute:ValidationAttribute
{
private readonly int _maxWord;
public MaxWordsAttribute(int maxWord)
{
_maxWord = maxWord;
}
protected override ValidationResult IsValid(object value,ValidationContext validationContext)
{
if (value!=null)
{
//將輸入轉(zhuǎn)換為string類型
var valueAsString = value.ToString();
//使用split(' ')空格來分隔輸入值，統(tǒng)計(jì)生成字符串的數(shù)量躯肌。對(duì)數(shù)目比較驗(yàn)證者春。
if (valueAsString.Split(' ').Length>_maxWord)
{
return new ValidationResult("單詞超過長(zhǎng)度"); //string類型
}
}
return ValidationResult.Success; //bool類型
}
}
第一個(gè)參數(shù)要驗(yàn)證對(duì)象中的值。后面進(jìn)行邏輯的判斷清女。這樣做這里的錯(cuò)誤提示不能顯示到前臺(tái)钱烟。我們需要修改下，使用ValidationAttrubute的ErrorMessage屬性來自定義提示錯(cuò)誤消息嫡丙。
- 修改之后
public class MaxWordsAttribute:ValidationAttribute
{
private readonly int _maxWord;
public MaxWordsAttribute(int maxWord)
:base("{0} has too many words")
{
_maxWord = maxWord;
}
protected override ValidationResult IsValid(object value,ValidationContext validationContext)
{
if (value!=null)
{
//將輸入轉(zhuǎn)換為string類型
var valueAsString = value.ToString();
//使用split(' ')空格來分隔輸入值拴袭，統(tǒng)計(jì)生成字符串的數(shù)量。對(duì)數(shù)目比較驗(yàn)證曙博。
if (valueAsString.Split(' ').Length>_maxWord)
{
var errorMessage = FormatErrorMessage(validationContext.DisplayName);
return new ValidationResult(errorMessage);
}
}
return ValidationResult.Success; //bool類型
}
}
[MaxWords(5)]
public string Address { get; set; }
這樣效果就會(huì)將我們基類中的錯(cuò)誤信息顯示出來拥刻。
我們可以模型基礎(chǔ)上添加自定義錯(cuò)誤顯示。
[MaxWords(5,ErrorMessage = "你輸入的單詞數(shù)超界限父泳，請(qǐng)重新輸入般哼。")]
public string Address { get; set; }
這里需要注意這里的執(zhí)行順序吴汪，它是先執(zhí)行模型上面的驗(yàn)證，接著在到控制器中的action中去的蒸眠。利用ModelState.IsValid來進(jìn)行驗(yàn)證漾橙。
- 自驗(yàn)證模型(IValidatableObject)
自驗(yàn)證模型是指一個(gè)知道如何驗(yàn)證自身的模型對(duì)象，可以讓類實(shí)現(xiàn)IVaalidatableObject接口來實(shí)現(xiàn)對(duì)自身的驗(yàn)證楞卡。
public class Information:IValidatableObject
{
public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
{
if (UserName!=null&&UserName.Split(' ').Length>5)
{
yield return new ValidationResult("單詞超界限了");
}
}
[Display(Name = "用戶名")]
public string UserName { get; set; }
}
其實(shí)書上面是在錯(cuò)誤返回值中返回的是string類型的數(shù)組霜运，如下
yield return new ValidationResult("單詞超界限了",new []{"UserName"});可以我不知道從那里取出來這個(gè)錯(cuò)誤消息。只能單獨(dú)的顯示出來蒋腮。其實(shí)把錯(cuò)誤消息放在數(shù)組中可以進(jìn)行多模型的驗(yàn)證淘捡，從而統(tǒng)一將錯(cuò)誤顯示出來。
自己的感覺要是需要模型驗(yàn)證池摧，最好還是進(jìn)行第一種方法焦除，最起碼代碼看起來干凈，第二種給人的感覺是很亂险绘，但是第二種適合比較模型多的場(chǎng)合踢京。
我就是我，顏色不一樣的煙火宦棺。
