兼职 做网站,wordpress erp,wordpress如何看访问,外贸营销推广方案1. 文章目的随着WebApiClient的不断完善#xff0c;越来越多开发者选择WebApiClient替换原生的HttpClient#xff0c;本文将介绍WebApiClient的接口参数输入有效性验证的新特性。2.DataAnnotations介绍在asp.net mvc服务端编程中#xff0c;我们在创建模型的时候#xff0c… 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/// 提供参数值和参数的属性值输入合法性验证/// /summarystatic class ParameterValidator{ /// summary /// 类型的属性否需要验证缓存 /// /summary private static readonly ConcurrentCacheType, bool cache new ConcurrentCacheType, bool(); /// summary /// 返回是否需要进行属性验证 /// /summary /// param nameinstance实例/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 nameparameter参数描述/param /// param namevalidateProperty是否验证属性值/param /// exception crefValidationException/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?idid001// Return HttpResponseMessage[HttpGet(webapi/user/GetById/{id})][BasicAuth(userName, password)]ITaskHttpResponseMessage GetByIdAsync( [Required, StringLength(10)] string id);4.2 声明参数值的属性验证对于自定义的模型类型只要在属性里声明了相关的DataAnnotationsWebApiClient就自动进行属性的输入验证。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)]ITaskUserInfo 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)]ITaskUserInfo UpdateWithJsonAsync([Required][JsonContent(yyyy-MM-dd HH:mm:ss)] UserInfo user);5. 禁用参数的属性验证如果你的模型的属性已声明验证特性但不希望WebApiClient进行属性值验证可以在创建接口实例的时候在配置项里禁用属性验证var config new HttpApiConfig
{UseParameterPropertyValidate false};var client HttpApiClient.CreateIUserApi(config);6. 结束语博主为WebApiClient库的作者本文向读者介绍了DataAnnotations验证特性在WebApiCiient下的使用方法欢迎大家给WebApiClient提建议。原文地址https://www.cnblogs.com/kewei/p/9406201.html.NET社区新闻深度好文欢迎访问公众号文章汇总 http://www.csharpkit.com
