WebApiClient的接口输入验证方法

1. 文章目的

随着 WebApiClient 的不断完善，越来越多开发者选择WebApiClient替换原生的HttpClient，本文将介绍WebApiClient的接口参数输入有效性验证的新特性。

2.DataAnnotations介绍

在 asp.net mvc 服务端编程中，我们在创建模型的时候，使用System.ComponentModel.DataAnnotations相关的验证特性，配合mvc框架，可以做前端和后端双向输入验证的效果。

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

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

以上的Required就是验证特性， asp.net mvc 在模型绑定的时候，会进行验证一遍，验证结果放在控制器的ModelState属性里面。当然System.ComponentModel.DataAnnotations并不是 asp.net mvc 特有的，而是基础库自带的，也就是说任何框架下都是可以使用的。

3. 接口参数值的输入验证

Validator静态类提ValidateObject相关的方法，用于验证实例和实例的属性值，WebApiClient使用Validator类来完成接口方法的参数值输入验证:

/// <summary>
/// 提供参数值和参数的属性值输入合法性验证
/// </summary>
static class ParameterValidator
{
 /// <summary>
 /// 类型的属性否需要验证缓存
 /// </summary>
 private static readonly ConcurrentCache<Type, bool> cache = new ConcurrentCache<Type, bool>();

 /// <summary>
 /// 返回是否需要进行属性验证
 /// </summary>
 /// <param name="instance">实例</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>
 /// 验证参数值输入合法性
 /// 验证参数的属性值输入合法性
 /// </summary>
 /// <param name="parameter">参数描述</param>
 /// <param name="validateProperty">是否验证属性值</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.接口参数的DataAnnotations声明

4.1 声明参数值的验证