首页 | 编程 | ASP.NET

WebApiClient的接口输入验证方法

2017年11月30日 作者：jiulang 原文

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 声明参数值的验证

例如GetByIdAsync方法有个id的参数，服务器要求必填且最大长度为10的字符串，我们可以使用Required, StringLength(10)特性修饰id这个参数，在接口调用时，WebApiClient会对id值进行验证，如果不通过则抛出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 声明参数值的属性验证

对于自定义的模型类型，只要在属性里声明了相关的DataAnnotations，WebApiClient就自动进行属性的输入验证。

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内容
[HttpPost("webapi/user/UpdateWithJson")]
ITask<UserInfo> UpdateWithJsonAsync(
 [JsonContent("yyyy-MM-dd HH:mm:ss")] UserInfo user);

当user参数不为null的情况，就会验证它的Account和Password两个属性。

4.3 声明参数值、参数的属性值同时验证

对于4.2的例子，如果我们希望user参数值也不能为null，可以如下声明方法：

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

5. 禁用参数的属性验证

如果你的模型的属性已声明验证特性，但不希望WebApiClient进行属性值验证，可以在创建接口实例的时候，在配置项里禁用属性验证：

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

6. 结束语

博主为WebApiClient库的作者，本文向读者介绍了DataAnnotations验证特性在WebApiCiient下的使用方法，欢迎大家给WebApiClient提建议。 也希望大家多多支持来客网。

相关链接