使用WebApiClient怎么實(shí)現(xiàn)接口輸入驗(yàn)證方法

這期內(nèi)容當(dāng)中小編將會(huì)給大家?guī)?lái)有關(guān)使用WebApiClient怎么實(shí)現(xiàn)接口輸入驗(yàn)證方法，文章內(nèi)容豐富且以專業(yè)的角度為大家分析和敘述，閱讀完這篇文章希望大家可以有所收獲。

在 asp.net mvc 服務(wù)端編程中，我們?cè)趧?chuàng)建模型的時(shí)候，使用System.ComponentModel.DataAnnotations相關(guān)的驗(yàn)證特性，配合mvc框架，可以做前端和后端雙向輸入驗(yàn)證的效果。

public class UserInfo
{
 [Required]
 [StringLength(10, MinimumLength = 1)]
 public string Account { get; set; }

 [Required]
 [StringLength(10, MinimumLength = 6)]
 public string Password { get; set; }
}

以上的Required就是驗(yàn)證特性， asp.net mvc 在模型綁定的時(shí)候，會(huì)進(jìn)行驗(yàn)證一遍，驗(yàn)證結(jié)果放在控制器的ModelState屬性里面。當(dāng)然System.ComponentModel.DataAnnotations并不是 asp.net mvc 特有的，而是基礎(chǔ)庫(kù)自帶的，也就是說任何框架下都是可以使用的。

3. 接口參數(shù)值的輸入驗(yàn)證

Validator靜態(tài)類提ValidateObject相關(guān)的方法，用于驗(yàn)證實(shí)例和實(shí)例的屬性值，WebApiClient使用Validator類來(lái)完成接口方法的參數(shù)值輸入驗(yàn)證:

/// <summary>
/// 提供參數(shù)值和參數(shù)的屬性值輸入合法性驗(yàn)證
/// </summary>
static class ParameterValidator
{
 /// <summary>
 /// 類型的屬性否需要驗(yàn)證緩存
 /// </summary>
 private static readonly ConcurrentCache<Type, bool> cache = new ConcurrentCache<Type, bool>();

 /// <summary>
 /// 返回是否需要進(jìn)行屬性驗(yàn)證
 /// </summary>
 /// <param name="instance">實(shí)例</param>
 /// <returns></returns>
 private static bool IsNeedValidateProperty(object instance)
 {
  if (instance == null)
  {
   return false;
  }

  var type = instance.GetType();
  if (type == typeof(string) || type.GetTypeInfo().IsValueType == true)
  {
   return false;
  }

  return cache.GetOrAdd(type, t => t.GetProperties().Any(p => p.CanRead && p.IsDefined(typeof(ValidationAttribute), true)));
 }

 /// <summary>
 /// 驗(yàn)證參數(shù)值輸入合法性
 /// 驗(yàn)證參數(shù)的屬性值輸入合法性
 /// </summary>
 /// <param name="parameter">參數(shù)描述</param>
 /// <param name="validateProperty">是否驗(yàn)證屬性值</param>
 /// <exception cref="ValidationException"></exception>
 public static void Validate(ApiParameterDescriptor parameter, bool validateProperty)
 {
  var name = parameter.Name;
  var instance = parameter.Value;

  foreach (var validation in parameter.ValidationAttributes)
  {
   validation.Validate(instance, name);
  }

  if (validateProperty == true && IsNeedValidateProperty(instance) == true)
  {
   var ctx = new ValidationContext(instance) { MemberName = name };
   Validator.ValidateObject(instance, ctx, true);
  }
 }
}

4.接口參數(shù)的DataAnnotations聲明

4.1 聲明參數(shù)值的驗(yàn)證

例如GetByIdAsync方法有個(gè)id的參數(shù)，服務(wù)器要求必填且最大長(zhǎng)度為10的字符串，我們可以使用Required, StringLength(10)特性修飾id這個(gè)參數(shù)，在接口調(diào)用時(shí)，WebApiClient會(huì)對(duì)id值進(jìn)行驗(yàn)證，如果不通過則拋出ValidationException的異常。

// /GET webapi/user/GetById?id=id001
// Return HttpResponseMessage
[HttpGet("webapi/user/GetById/{id}")]
[BasicAuth("userName", "password")]
ITask<HttpResponseMessage> GetByIdAsync(
 [Required, StringLength(10)] string id);

4.2 聲明參數(shù)值的屬性驗(yàn)證

對(duì)于自定義的模型類型，只要在屬性里聲明了相關(guān)的DataAnnotations，WebApiClient就自動(dòng)進(jìn)行屬性的輸入驗(yàn)證。

public class UserInfo
{
 [Required]
 [StringLength(10, MinimumLength = 1)]
 public string Account { get; set; }

 [Required]
 [StringLength(10, MinimumLength = 6)]
 public string Password { get; set; }
}

// POST webapi/user/UpdateWithJson
// Body {"Account":"laojiu","Password":"123456"}
// Return json或xml內(nèi)容
[HttpPost("webapi/user/UpdateWithJson")]
ITask<UserInfo> UpdateWithJsonAsync(
 [JsonContent("yyyy-MM-dd HH:mm:ss")] UserInfo user);

當(dāng)user參數(shù)不為null的情況，就會(huì)驗(yàn)證它的Account和Password兩個(gè)屬性。

4.3 聲明參數(shù)值、參數(shù)的屬性值同時(shí)驗(yàn)證

對(duì)于4.2的例子，如果我們希望user參數(shù)值也不能為null，可以如下聲明方法：

// POST webapi/user/UpdateWithJson
// Body {"Account":"laojiu","Password":"123456"}
// Return json或xml內(nèi)容
[HttpPost("webapi/user/UpdateWithJson")]
ITask<UserInfo> UpdateWithJsonAsync(
 [Required][JsonContent("yyyy-MM-dd HH:mm:ss")] UserInfo user);

5. 禁用參數(shù)的屬性驗(yàn)證

如果你的模型的屬性已聲明驗(yàn)證特性，但不希望WebApiClient進(jìn)行屬性值驗(yàn)證，可以在創(chuàng)建接口實(shí)例的時(shí)候，在配置項(xiàng)里禁用屬性驗(yàn)證：

var config = new HttpApiConfig
{
 UseParameterPropertyValidate = false
};
var client = HttpApiClient.Create<IUserApi>(config);

上述就是小編為大家分享的使用WebApiClient怎么實(shí)現(xiàn)接口輸入驗(yàn)證方法了，如果剛好有類似的疑惑，不妨參照上述分析進(jìn)行理解。如果想知道更多相關(guān)知識(shí)，歡迎關(guān)注億速云行業(yè)資訊頻道。