?

在綁定完Action的所有參數后,WebAPI并不會馬上執行該方法,而要對參數進行驗證,以保證輸入的合法性.

?

ModelState

在ApiController中一個ModelState屬性用來獲取參數驗證結果.

?

public abstract class ApiController : IHttpController, IDisposable{public ModelStateDictionary ModelState { get; } }

?

?

?

ApiContext的ModelState屬性實際是對每個Action參數驗證的結果集合.

?

public class ModelStateDictionary : IDictionary<string, ModelState>, ICollection<KeyValuePair<string, ModelState>>, IEnumerable<KeyValuePair<string, ModelState>>, IEnumerable{ public int Count { get; } public bool IsReadOnly { get; } public bool IsValid { get; } public ModelState this[string key] { get; set; } public void Add(KeyValuePair<string, ModelState> item); public void Add(string key, ModelState value); }

?

?

?

?

?

public class ModelState{ public ModelState(); public ModelErrorCollection Errors { get; } public ValueProviderResult Value { get; set; } } 

public class ModelError{public string ErrorMessage { get; } public Exception Exception { get; } }

?

?

?

對于ModelStateDictionary,ModelState,ModelError我們可以理解成Action所有參數(所有參數的屬性)的驗證結果.單個參數的驗證結果.單個參數屬性的單個驗證結果(一個參數可能有多個難結果).

?

ModelStateDictionary的IsValid屬性表示驗證是否通過.另外 Count屬性對于不同的參數綁定方式在WebAPI中可能表現不同的結果.這個后面會有具體例子.

?

ValidationAttribute特性

采用ValidationAttribute特性進行參數驗證是WebAPI的默認驗證方式.ValidationAttribute位于" System.ComponentModel.DataAnnotations"命名空間下,在這個命名空間下還定義了一些具體的ValidationAttribute,如圖:

?

?

?

public abstract class ValidationAttribute : Attribute{public string ErrorMessage { get; set; } public string ErrorMessageResourceName { get; set; } public Type ErrorMessageResourceType { get; set; } public virtual bool RequiresValidationContext { get; } public virtual string FormatErrorMessage(string name); public ValidationResult GetValidationResult(object value, ValidationContext validationContext); public virtual bool IsValid(object value); public void Validate(object value, string name); public void Validate(object value, ValidationContext validationContext); }

?

?

?

?

ValidationAttribute的IsValid方法用來返回驗證是否通過, FormatErrorMessage方法用來返回錯誤信息.

?

下面我就自定義一個ArrayValidatorAttribute,用來進行區間判斷,即讓開發者自定義一個數組,然后判斷值是不是在數組內.

?

public class ArrayValidationAttribute : ValidationAttribute{ public object[] _list; public ArrayValidationAttribute(params object[] list) { _list = list; } public object[] List { get { return _list; } set { _list = value; } } public override bool IsValid(object value) { return _list.Contains(value); } public override string FormatErrorMessage(string name) { return string.Format("{0}不在區間內.", name); } }

?

?

?

?

?

CustomerValidationAttribute的使用

?

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method | AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Parameter, AllowMultiple = true)] public sealed class CustomValidationAttribute : ValidationAttribute{ public CustomValidationAttribute(Type validatorType, string method); public string Method { get; } public override object TypeId { get; } public Type ValidatorType { get; } public override string FormatErrorMessage(string name); protected override ValidationResult IsValid(object value, ValidationContext validationContext); }

?

?

?

?

從定義中我們可以看出來CustomerValidationAttribute是不能被繼承的,這是說明CustomerValidationAttribute不同于ValidaitionAttribute的使用方式.實際上CustomerValidationAttribute采用的反射的方式去進行驗證.它包含了ValidationType,Method兩個屬性,這兩個屬性分別表示反射使用到的類與方法名.

對于可以用作驗證的方法要滿足以下條件:

1. 方法是公開的,靜態的
2. 方法必須要有一個或者兩個參數.
3. 如果方法只有一個參數,那么這個參數必須是未做ref,out標注的(該參數實際上是要驗證的值)
4. 如果方法有兩個參數,那么第一個參數的約束用3,第二個參數必須是ValidationContext類型

?

Model綁定與反序列化參數結果對比

Model綁定方式保存了所有的驗證結果,反序列化方式只保存了驗證未通過的結果

如下:

?

public ModelStateDictionary PostFigureFromUrlForState([ModelBinder]Figure figure) { return ModelState; } public ModelStateDictionary PostFigureFromBodyForState([FromBody]Figure figure) { return ModelState; } 

?

?

?

對于Figure,將LastName,FirstName都設置成必須。

?

public class Figure{ [Required] public string FirstName { get; set; } [Required]public string LastName { get; set; } } 

?

?

?

現在我們對兩個方法傳相同的數據：{FirstName:null,LastName:"Stack"}

url:

/api/Demo/PostFigureFromUrlForState?LastName=Stack

/api/Demo/PostFigureFromBodyForState

?

實際得到的結果分別如下：

?

?

?

源碼

Github: https://github.com/BarlowDu/WebAPI (API_11)

轉載于:https://www.cnblogs.com/gangtianci/p/4951351.html

總結

以上是生活随笔為你收集整理的ASP.NET WebAPI 11 参数验证的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。