增加接口返回值验证功能

Author: xljiulang

WebApiClient.Test/Internal/ApiValidatorTest.cs

@@ -0,0 +1,48 @@
+using System.ComponentModel.DataAnnotations;
+using WebApiClient.Contexts;
+using Xunit;
+
+namespace WebApiClient.Test.Internal
+{
+    public class ParameterValidatorTest
+    {
+        class User
+        {
+            [Required]
+            [StringLength(4)]
+            public string Account { get; set; }
+        }
+
+        [Fact]
+        public void ValidateParameterTest()
+        {
+            var parameter = TestParameter.Create(null);
+            Assert.Throws<ValidationException>(() => ApiValidator.ValidateParameter(parameter, true));
+
+            parameter = TestParameter.Create(new User { });
+            Assert.Throws<ValidationException>(() => ApiValidator.ValidateParameter(parameter, true));
+
+            parameter = TestParameter.Create(new User { Account = "123" });
+            ApiValidator.ValidateParameter(parameter, true);
+
+            parameter = TestParameter.Create(new User { Account = "123456" });
+            Assert.Throws<ValidationException>(() => ApiValidator.ValidateParameter(parameter, true));
+        }
+
+        [Fact]
+        public void ValidateReturnValueTest()
+        {
+            var value = default(User);
+            ApiValidator.ValidateReturnValue(value, true);
+
+            value = new User();
+            Assert.Throws<ValidationException>(() => ApiValidator.ValidateReturnValue(value, true));
+
+            value = new User { Account = "123" };
+            ApiValidator.ValidateReturnValue(value, true);
+
+            value = new User { Account = "123456" };
+            Assert.Throws<ValidationException>(() => ApiValidator.ValidateReturnValue(value, true));
+        }
+    }
+}

WebApiClient.Test/Internal/ParameterValidatorTest.cs

@@ -135,7 +135,7 @@ private async Task PrepareRequestAsync()
 
             foreach (var parameter in apiAction.Parameters)
             {
-                ParameterValidator.Validate(parameter, validateProperty);
+                ApiValidator.ValidateParameter(parameter, validateProperty);
             }
 
             foreach (var actionAttribute in apiAction.Attributes)
@@ -172,9 +172,12 @@ private async Task ExecRequestAsync()
                         .SendAsync(this.RequestMessage, completionOption, cancellation.Token)
                         .ConfigureAwait(false);
 
-                    this.Result = await this.ApiActionDescriptor.Return.Attribute
+                    var result = await this.ApiActionDescriptor.Return.Attribute
                         .GetTaskResult(this)
                         .ConfigureAwait(false);
+
+                    ApiValidator.ValidateReturnValue(result, this.HttpApiConfig.UseReturnValuePropertyValidate);
+                    this.Result = result;
                 }
                 catch (Exception ex)
                 {

WebApiClient/Contexts/ApiActionContext.cs

@@ -94,6 +94,12 @@ public Uri HttpHost
         /// </summary>
         public bool UseParameterPropertyValidate { get; set; } = true;
 
+        /// <summary>
+        /// 获取或设置是否对返回值的属性值进行输入有效性验证
+        /// 默认为true
+        /// </summary>
+        public bool UseReturnValuePropertyValidate { get; set; } = true;
+
         /// <summary>
         /// 获取或设置请求时序列化使用的默认格式   
         /// 影响JsonFormatter或KeyValueFormatter的序列化

WebApiClient/HttpApiConfig.cs

@@ -7,9 +7,9 @@
 namespace WebApiClient
 {
     /// <summary>
-    /// 提供参数值和参数的属性值输入合法性验证
+    /// Api验证器，提供返回值的属性验证、参数值和参数的属性值验证
     /// </summary>
-    static class ParameterValidator
+    static class ApiValidator
     {
         /// <summary>
         /// 类型的属性否需要验证缓存
@@ -44,7 +44,7 @@ private static bool IsNeedValidateProperty(object instance)
         /// <param name="parameter">参数描述</param>
         /// <param name="validateProperty">是否验证属性值</param>
         /// <exception cref="ValidationException"></exception>
-        public static void Validate(ApiParameterDescriptor parameter, bool validateProperty)
+        public static void ValidateParameter(ApiParameterDescriptor parameter, bool validateProperty)
         {
             var name = parameter.Name;
             var instance = parameter.Value;
@@ -57,7 +57,22 @@ public static void Validate(ApiParameterDescriptor parameter, bool validatePrope
             if (validateProperty == true && IsNeedValidateProperty(instance) == true)
             {
                 var ctx = new ValidationContext(instance) { MemberName = name };
-                Validator.ValidateObject(instance, ctx, true);
+                Validator.ValidateObject(instance, ctx, false);
+            }
+        }
+
+        /// <summary>
+        /// 验证参返回的结果
+        /// </summary>
+        /// <param name="value">结果值</param>
+        /// <param name="validateProperty">是否验证属性值</param>
+        /// <exception cref="ValidationException"></exception>
+        public static void ValidateReturnValue(object value, bool validateProperty)
+        {
+            if (validateProperty == true && IsNeedValidateProperty(value) == true)
+            {
+                var ctx = new ValidationContext(value);
+                Validator.ValidateObject(value, ctx, false);
             }
         }
     }