fix(ValidateForm): validate all validation from MetadataType (#4360)

* 修复 MetadataType 方式继承 IValidateCollection 接口验证后又对其中涉及的属性进行了单独验证，在特定情况下会忽略单独验证的错误提示。#4359

* fix: 更新 ValidateForm 验证逻辑

* refactor: 重构代码

* refactor: 更改 IValidateCollection 接口方法名称

* 调整代码以通过验证。

* doc: 增加注释文档

* refactor: 精简代码

* test: 更新单元测试

* chore: bump version 8.9.4-beta06

---------

Co-authored-by: Argo <[email protected]>

Author: AiYuZhen

src/BootstrapBlazor.Server/Components/Samples/ValidateForms.razor.cs

@@ -163,12 +163,12 @@ public IEnumerable<ValidationResult> Validate(ValidationContext validationContex
                     _validMemberNames.AddRange([nameof(model.Email), nameof(model.ConfirmEmail)]);
                 }
             }
-            return InvalidMemberNames();
+            return GetInvalidMemberNames();
         }
 
-        public List<string> ValidMemberNames() => _validMemberNames;
+        public List<string> GetValidMemberNames() => _validMemberNames;
 
-        public List<ValidationResult> InvalidMemberNames() => _invalidMemberNames;
+        public List<ValidationResult> GetInvalidMemberNames() => _invalidMemberNames;
     }
 
     class ComplexFoo : Foo

src/BootstrapBlazor.Server/Data/CustomValidateCollectionModel.cs

@@ -61,11 +61,11 @@ public IEnumerable<ValidationResult> Validate(ValidationContext validationContex
     /// <inheritdoc/>
     /// </summary>
     /// <returns></returns>
-    public List<string> ValidMemberNames() => _validMemberNames;
+    public List<string> GetValidMemberNames() => _validMemberNames;
 
     /// <summary>
     /// <inheritdoc/>
     /// </summary>
     /// <returns></returns>
-    public List<ValidationResult> InvalidMemberNames() => _invalidMemberNames;
+    public List<ValidationResult> GetInvalidMemberNames() => _invalidMemberNames;
 }

src/BootstrapBlazor/BootstrapBlazor.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk.Razor">
 
   <PropertyGroup>
-    <Version>8.9.4-beta05</Version>
+    <Version>8.9.4-beta06</Version>
   </PropertyGroup>
 
   <ItemGroup Condition="'$(TargetFramework)' == 'net6.0'">

src/BootstrapBlazor/Components/Validate/IValidateCollection.cs

@@ -20,11 +20,11 @@ public interface IValidateCollection
     /// 返回合法成员集合
     /// </summary>
     /// <returns></returns>
-    List<string> ValidMemberNames();
+    List<string> GetValidMemberNames();
 
     /// <summary>
     /// 返回非法成员集合
     /// </summary>
     /// <returns></returns>
-    List<ValidationResult> InvalidMemberNames();
+    List<ValidationResult> GetInvalidMemberNames();
 }

src/BootstrapBlazor/Components/Validate/ValidateBase.cs

@@ -301,6 +301,7 @@ protected override void OnParametersSet()
 
         if (ValidateForm != null)
         {
+            // IValidateCollection 支持组件间联动验证
             var fieldName = FieldIdentifier?.FieldName;
             if (!string.IsNullOrEmpty(fieldName))
             {

src/BootstrapBlazor/Components/ValidateForm/ValidateForm.razor.cs

@@ -21,15 +21,13 @@ public partial class ValidateForm
     /// <see cref="EditContext"/> is determined to be valid.
     /// </summary>
     [Parameter]
-    [NotNull]
     public Func<EditContext, Task>? OnValidSubmit { get; set; }
 
     /// <summary>
     /// A callback that will be invoked when the form is submitted and the
     /// <see cref="EditContext"/> is determined to be invalid.
     /// </summary>
     [Parameter]
-    [NotNull]
     public Func<EditContext, Task>? OnInvalidSubmit { get; set; }
 
     /// <summary>
@@ -107,6 +105,11 @@ public partial class ValidateForm
     /// </summary>
     private readonly ConcurrentDictionary<(string FieldName, Type ModelType), (FieldIdentifier FieldIdentifier, IValidateComponent ValidateComponent)> _validatorCache = new();
 
+    /// <summary>
+    /// 验证组件验证结果缓存
+    /// </summary>
+    private readonly ConcurrentDictionary<IValidateComponent, List<ValidationResult>> _validateResults = new();
+
     private string? DisableAutoSubmitString => (DisableAutoSubmitFormByEnter.HasValue && DisableAutoSubmitFormByEnter.Value) ? "true" : null;
 
     /// <summary>
@@ -165,7 +168,7 @@ internal void AddValidator((string FieldName, Type ModelType) key, (FieldIdentif
     /// </summary>
     /// <param name="key"></param>
     /// <param name="value"></param>
-    internal bool TryRemoveValidator((string FieldName, Type ModelType) key, [MaybeNullWhen(false)] out (FieldIdentifier FieldIdentifier, IValidateComponent IValidateComponent) value) => _validatorCache.TryRemove(key, out value);
+    internal bool TryRemoveValidator((string FieldName, Type ModelType) key, out (FieldIdentifier FieldIdentifier, IValidateComponent IValidateComponent) value) => _validatorCache.TryRemove(key, out value);
 
     /// <summary>
     /// 设置指定字段错误信息
@@ -186,19 +189,21 @@ public void SetError<TModel>(Expression<Func<TModel, object?>> expression, strin
 
     private void InternalSetError(MemberExpression exp, string errorMessage)
     {
-        var fieldName = exp.Member.Name;
         if (exp.Expression != null)
         {
+            var fieldName = exp.Member.Name;
             var modelType = exp.Expression.Type;
             var validator = _validatorCache.FirstOrDefault(c => c.Key.ModelType == modelType && c.Key.FieldName == fieldName).Value.ValidateComponent;
-            if (validator != null)
+            if (validator == null)
             {
-                var results = new List<ValidationResult>
-                {
-                    new(errorMessage, new string[] { fieldName })
-                };
-                validator.ToggleMessage(results);
+                return;
             }
+
+            var results = new List<ValidationResult>
+            {
+                new(errorMessage, [fieldName])
+            };
+            validator.ToggleMessage(results);
         }
     }
 
@@ -213,7 +218,7 @@ public void SetError(string propertyName, string errorMessage)
         {
             var results = new List<ValidationResult>
             {
-                new(errorMessage, new string[] { fieldName })
+                new(errorMessage, [fieldName])
             };
             validator.ToggleMessage(results);
         }
@@ -241,7 +246,7 @@ private bool TryGetModelField(string propertyName, [MaybeNullWhen(false)] out Ty
         return propNames.IsEmpty;
     }
 
-    private bool TryGetValidator(Type modelType, string fieldName, [NotNullWhen(true)] out IValidateComponent validator)
+    private bool TryGetValidator(Type modelType, string fieldName, out IValidateComponent validator)
     {
         validator = _validatorCache.FirstOrDefault(c => c.Key.ModelType == modelType && c.Key.FieldName == fieldName).Value.ValidateComponent;
         return validator != null;
@@ -256,6 +261,8 @@ private bool TryGetValidator(Type modelType, string fieldName, [NotNullWhen(true
     /// <param name="results"></param>
     internal async Task ValidateObject(ValidationContext context, List<ValidationResult> results)
     {
+        _validateResults.Clear();
+
         if (ValidateAllProperties)
         {
             await ValidateProperty(context, results);
@@ -266,30 +273,29 @@ internal async Task ValidateObject(ValidationContext context, List<ValidationRes
             foreach (var key in _validatorCache.Keys)
             {
                 // 验证 DataAnnotations
-                var validatorValue = _validatorCache[key];
-                var validator = validatorValue.ValidateComponent;
-                var fieldIdentifier = validatorValue.FieldIdentifier;
-                if (validator.IsNeedValidate)
+                var (fieldIdentifier, validator) = _validatorCache[key];
+                if (!validator.IsNeedValidate)
                 {
-                    var messages = new List<ValidationResult>();
-                    var pi = key.ModelType.GetPropertyByName(key.FieldName);
-                    if (pi != null)
+                    continue;
+                }
+
+                var messages = new List<ValidationResult>();
+                var pi = key.ModelType.GetPropertyByName(key.FieldName);
+                if (pi != null)
+                {
+                    var propertyValidateContext = new ValidationContext(fieldIdentifier.Model, context, null)
                     {
-                        var propertyValidateContext = new ValidationContext(fieldIdentifier.Model, context, null)
-                        {
-                            MemberName = fieldIdentifier.FieldName,
-                            DisplayName = fieldIdentifier.GetDisplayName()
-                        };
+                        MemberName = fieldIdentifier.FieldName,
+                        DisplayName = fieldIdentifier.GetDisplayName()
+                    };
 
-                        // 设置其关联属性字段
-                        var propertyValue = Utility.GetPropertyValue(fieldIdentifier.Model, fieldIdentifier.FieldName);
+                    // 设置其关联属性字段
+                    var propertyValue = Utility.GetPropertyValue(fieldIdentifier.Model, fieldIdentifier.FieldName);
 
-                        await ValidateAsync(validator, propertyValidateContext, messages, pi, propertyValue);
-                    }
-                    // 客户端提示
-                    validator.ToggleMessage(messages);
-                    results.AddRange(messages);
+                    await ValidateAsync(validator, propertyValidateContext, messages, pi, propertyValue);
                 }
+                _validateResults.TryAdd(validator, messages);
+                results.AddRange(messages);
             }
 
             // 验证 IValidatableObject
@@ -306,22 +312,28 @@ internal async Task ValidateObject(ValidationContext context, List<ValidationRes
                 }
                 if (validate != null)
                 {
-                    var messages = validate.Validate(context);
-                    if (messages.Any())
+                    var messages = validate.Validate(context).ToList();
+                    if (messages.Count > 0)
                     {
                         foreach (var key in _validatorCache.Keys)
                         {
                             var validatorValue = _validatorCache[key];
                             var validator = validatorValue.ValidateComponent;
                             if (validator.IsNeedValidate)
                             {
-                                validator.ToggleMessage(messages);
+                                _validateResults[validator].AddRange(messages);
                             }
                         }
                         results.AddRange(messages);
                     }
                 }
             }
+
+            ValidMemberNames.RemoveAll(name => _validateResults.Values.SelectMany(i => i).Any(i => i.MemberNames.Contains(name)));
+            foreach (var (validator, messages) in _validateResults)
+            {
+                validator.ToggleMessage(messages);
+            }
         }
     }
 
@@ -425,7 +437,7 @@ private void ValidateDataAnnotations(object? value, ValidationContext context, L
                 var errorMessage = !string.IsNullOrEmpty(rule.ErrorMessage) && rule.ErrorMessage.Contains("{0}")
                     ? rule.FormatErrorMessage(displayName)
                     : rule.ErrorMessage;
-                results.Add(new ValidationResult(errorMessage, new string[] { memberName }));
+                results.Add(new ValidationResult(errorMessage, [memberName]));
             }
         }
     }
@@ -507,7 +519,7 @@ private async Task ValidateAsync(IValidateComponent validator, ValidationContext
             if (messages.Count == 0)
             {
                 // 自定义验证组件
-                _tcs = new();
+                _tcs = new TaskCompletionSource<bool>();
                 await validator.ValidatePropertyAsync(propertyValue, context, messages);
                 _tcs.TrySetResult(messages.Count == 0);
             }
@@ -527,8 +539,8 @@ private async Task ValidateAsync(IValidateComponent validator, ValidationContext
                 if (validate != null)
                 {
                     messages.AddRange(validate.Validate(context));
-                    ValidMemberNames.AddRange(validate.ValidMemberNames());
-                    InvalidMemberNames.AddRange(validate.InvalidMemberNames());
+                    ValidMemberNames.AddRange(validate.GetValidMemberNames());
+                    InvalidMemberNames.AddRange(validate.GetInvalidMemberNames());
                 }
             }
         }