使用WebApiClient怎么实现接口输入验证方法-创新互联

这期内容当中小编将会给大家带来有关使用WebApiClient怎么实现接口输入验证方法，文章内容丰富且以专业的角度为大家分析和叙述，阅读完这篇文章希望大家可以有所收获。

创新互联坚持“要么做到，要么别承诺”的工作理念，服务领域包括：网站设计制作、成都网站制作、企业官网、英文网站、手机端网站、网站推广等服务，满足客户于互联网时代的包头网站设计、移动媒体设计的需求，帮助企业找到有效的互联网解决方案。努力成为您成熟可靠的网络建设合作伙伴！

在 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类来完成接口方法的参数值输入验证:

/// 

/// 提供参数值和参数的属性值输入合法性验证
/// 
static class ParameterValidator
{
 /// 

 /// 类型的属性否需要验证缓存
 /// 
 private static readonly ConcurrentCache cache = new ConcurrentCache();

 /// 

 /// 返回是否需要进行属性验证
 /// 
 /// 实例
 /// 
 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)));
 }

 /// 

 /// 验证参数值输入合法性
 /// 验证参数的属性值输入合法性
 /// 
 /// 参数描述
 /// 是否验证属性值
 /// 
 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 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 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 UpdateWithJsonAsync(
 [Required][JsonContent("yyyy-MM-dd HH:mm:ss")] UserInfo user);

5. 禁用参数的属性验证

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

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

上述就是小编为大家分享的使用WebApiClient怎么实现接口输入验证方法了，如果刚好有类似的疑惑，不妨参照上述分析进行理解。如果想知道更多相关知识，欢迎关注创新互联行业资讯频道。

文章标题：使用WebApiClient怎么实现接口输入验证方法-创新互联
本文URL：http://shouzuofang.com/article/cshpdd.html