本篇文章給大家分享的是有關(guān)如何分析WebApiClient的接口輸入驗證，小編覺得挺實用的，因此分享給大家學(xué)習(xí)，希望大家閱讀完這篇文章后可以有所收獲，話不多說，跟著小編一起來看看吧。
成都創(chuàng)新互聯(lián)專注于臺安企業(yè)網(wǎng)站建設(shè),成都響應(yīng)式網(wǎng)站建設(shè)公司,商城網(wǎng)站建設(shè)。臺安網(wǎng)站建設(shè)公司,為臺安等地區(qū)提供建站服務(wù)。全流程按需規(guī)劃網(wǎng)站，專業(yè)設(shè)計，全程項目跟蹤，成都創(chuàng)新互聯(lián)專業(yè)和態(tài)度為您提供的服務(wù)
隨著WebApiClient的不斷完善，越來越多開發(fā)者選擇WebApiClient替換原生的HttpClient，下面將介紹WebApiClient的接口參數(shù)輸入有效性驗證的新特性。
在asp.net mvc服務(wù)端編程中，我們在創(chuàng)建模型的時候，使用System.ComponentModel.DataAnnotations相關(guān)的驗證特性，配合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在模型綁定的時候，會進(jìn)行驗證一遍，驗證結(jié)果放在控制器的ModelState屬性里面。當(dāng)然System.ComponentModel.DataAnnotations并不是asp.net mvc特有的，而是基礎(chǔ)庫自帶的，也就是說任何框架下都是可以使用的。
Validator靜態(tài)類提ValidateObject相關(guān)的方法，用于驗證實例和實例的屬性值，WebApiClient使用Validator類來完成接口方法的參數(shù)值輸入驗證:
///
/// 提供參數(shù)值和參數(shù)的屬性值輸入合法性驗證
///
static class ParameterValidator
{
///
/// 類型的屬性否需要驗證緩存
///
private static readonly ConcurrentCache
///
/// 返回是否需要進(jìn)行屬性驗證
///
/// 實例
///
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)));
}
///
/// 驗證參數(shù)值輸入合法性
/// 驗證參數(shù)的屬性值輸入合法性
///
/// 參數(shù)描述
/// 是否驗證屬性值
///
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);
}
}
}
例如GetByIdAsync方法有個id的參數(shù)，服務(wù)器要求必填且最大長度為10的字符串，我們可以使用Required, StringLength(10)特性修飾id這個參數(shù)，在接口調(diào)用時，WebApiClient會對id值進(jìn)行驗證，如果不通過則拋出ValidationException的異常。
重慶分公司
重慶分公司
// /GET webapi/user/GetById?id=id001// Return HttpResponseMessage[HttpGet("webapi/user/GetById/{id}")][BasicAuth("userName", "password")]ITask GetByIdAsync( [Required, StringLength(10)] string id); 對于自定義的模型類型，只要在屬性里聲明了相關(guān)的DataAnnotations，WebApiClient就自動進(jì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
[JsonContent("yyyy-MM-dd HH:mm:ss")] UserInfo user);
當(dāng)user參數(shù)不為null的情況，就會驗證它的Account和Password兩個屬性。
對于4.2的例子，如果我們希望user參數(shù)值也不能為null，可以如下聲明方法：
// POST webapi/user/UpdateWithJson// Body {"Account":"laojiu","Password":"123456"}
// Return json或xml內(nèi)容
[HttpPost("webapi/user/UpdateWithJson")]ITask UpdateWithJsonAsync(
[Required][JsonContent("yyyy-MM-dd HH:mm:ss")] UserInfo user); 如果你的模型的屬性已聲明驗證特性，但不希望WebApiClient進(jìn)行屬性值驗證，可以在創(chuàng)建接口實例的時候，在配置項里禁用屬性驗證：
var config = new HttpApiConfig
{
UseParameterPropertyValidate = false};var client = HttpApiClient.Create(config); 以上就是如何分析WebApiClient的接口輸入驗證，小編相信有部分知識點可能是我們?nèi)粘９ぷ鲿姷交蛴玫降?。希望你能通過這篇文章學(xué)到更多知識。更多詳情敬請關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道。
