feat(MetadataTypeAttribute): support IValidatableObject/IValidateCollection (#4323)

* 增增 MetadataTypeAttribute 方式，以支持 IValidatableObject、IValidateCollection 接口验证方式。
增加简单示例。

* 增强 MetadataTypeAttribute 方式，以支持 IValidatableObject、IValidateCollection 接口验证方式。
增加简单示例。
修复文档测试错误。

* 修复代码覆盖率。

* 添加测试代码。

* 完善代码覆盖率。

* 调整示例。

* refactor: 代码格式化与规范化

* refactor: 移除不需要的命名空间

* doc: 更新示例代码

* refactor: 增加扩展方法提高代码复用率

* doc: 更新示例

* doc: 更新 MetadataType 示例

* refactor: 更新验证逻辑

* test: 更新单元测试

* chore: bump version 8.9.3-beta01

---------

Co-authored-by: Argo Zhang <argo@live.ca>

Author: AiYuZhen

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

@@ -400,6 +400,22 @@ private Task OnClickValidate()
     <ConsoleLogger @ref="Logger7" />
 </DemoBlock>
 
+<DemoBlock Title="@Localizer["ValidateMetadataTypeTitle"]" Introduction="@Localizer["ValidateMetadataTypeIntro"]" Name="MetadataType">
+    <ValidateForm Model="@_mockModel">
+        <div class="row g-3">
+            <div class="col-12 col-sm-6">
+                <BootstrapInput @bind-Value="@_mockModel.Email" />
+            </div>
+            <div class="col-12 col-sm-6">
+                <BootstrapInput @bind-Value="@_mockModel.ConfirmEmail" />
+            </div>
+            <div class="col-12">
+                <Button ButtonType="@ButtonType.Submit" Text="@Localizer["ValidateFormsSubmitButtonText"]" />
+            </div>
+        </div>
+    </ValidateForm>
+</DemoBlock>
+
 <AttributeTable Items="@GetAttributes()" />
 
 <MethodTable Items="@GetMethods()" />

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

@@ -36,7 +36,7 @@ private void OnFiledChanged(string field, object? value)
     }
 
     /// <summary>
-    /// OnInitializedAsync 方法
+    /// <inheritdoc/>
     /// </summary>
     /// <returns></returns>
     protected override async Task OnInitializedAsync()
@@ -132,19 +132,58 @@ private Task OnInvalidSubmitAddress(EditContext context)
 
     private ConcurrentDictionary<FieldIdentifier, object?> GetValueChangedFieldCollection() => ComplexForm?.ValueChangedFields ?? new ConcurrentDictionary<FieldIdentifier, object?>();
 
-    private class ComplexFoo : Foo
+    private readonly MockModel _mockModel = new() { Email = "argo@live.ca", ConfirmEmail = "argo@163.com" };
+
+    [MetadataType(typeof(MockModelMetadataType))]
+    class MockModel
+    {
+        public string? Email { get; set; }
+
+        public string? ConfirmEmail { get; set; }
+    }
+
+    class MockModelMetadataType : IValidateCollection
+    {
+        private readonly List<string> _validMemberNames = [];
+        private readonly List<ValidationResult> _invalidMemberNames = [];
+
+        public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
+        {
+            _validMemberNames.Clear();
+            _invalidMemberNames.Clear();
+            if (validationContext.ObjectInstance is MockModel model)
+            {
+                if (!string.IsNullOrEmpty(model.Email) && !string.IsNullOrEmpty(model.ConfirmEmail)
+                    && !model.Email.Equals(model.ConfirmEmail, StringComparison.OrdinalIgnoreCase))
+                {
+                    _invalidMemberNames.Add(new ValidationResult("两个值必须一致。", [nameof(model.Email), nameof(model.ConfirmEmail)]));
+                }
+                else
+                {
+                    _validMemberNames.AddRange([nameof(model.Email), nameof(model.ConfirmEmail)]);
+                }
+            }
+            return InvalidMemberNames();
+        }
+
+        public List<string> ValidMemberNames() => _validMemberNames;
+
+        public List<ValidationResult> InvalidMemberNames() => _invalidMemberNames;
+    }
+
+    class ComplexFoo : Foo
     {
         [NotNull]
         public Dummy1? Dummy { get; set; }
     }
 
-    private class Dummy1
+    class Dummy1
     {
         [NotNull]
         public Dummy2? Dummy2 { get; set; }
     }
 
-    private class Dummy2
+    class Dummy2
     {
         [Required]
         public string? Name { get; set; }

src/BootstrapBlazor.Server/Locales/en-US.json

@@ -3514,7 +3514,9 @@
     "ValidateFormIValidatableObjectDescription": "This example uses the <code>IValidatableObject</code> interface to implement validation that <code>Telephone 1</code> and <code>Telephone 2</code> must not be the same, and that <code>Name</code> cannot be empty. In this example, <code>Name</code> is not provided, but since the model implements validation through the <code>IValidatableObject</code> interface, it still triggers the <code>OnInvalidSubmit</code> callback delegate when submitting data.",
     "ValidateFormIValidateCollectionTitle": "IValidateCollection",
     "ValidateFormIValidateCollectionIntro": "The <code>IValidateCollection</code> interface provides more flexible custom <code>linked</code> validation, which is very suitable for very complex data validation, such as combining multiple attributes for validation.",
-    "ValidateFormIValidateCollectionDescription": "This example uses <code>IValidateCollection</code> to verify that <code>Telephone 1</code> and <code>Telephone 2</code> cannot be the same. If any cell is changed so that the phone numbers are the same, both text boxes will prompt."
+    "ValidateFormIValidateCollectionDescription": "This example uses <code>IValidateCollection</code> to verify that <code>Telephone 1</code> and <code>Telephone 2</code> cannot be the same. If any cell is changed so that the phone numbers are the same, both text boxes will prompt.",
+    "ValidateMetadataTypeTitle": "MetadataType IValidateCollection",
+    "ValidateMetadataTypeIntro": "The model uses <code>[MetadataType(typeof(MockModelMetadataType))]</code> to specify the metadata type <code>MockModelMetadataType</code> for model validation. If the specified model inherits the <code>IValidateCollection</code> interface, its <code>Validate</code> method is called to perform data compliance checks."
   },
   "BootstrapBlazor.Server.Components.Samples.Ajaxs": {
     "AjaxTitle": "Ajax call",

src/BootstrapBlazor.Server/Locales/zh-CN.json

@@ -3514,7 +3514,9 @@
     "ValidateFormIValidatableObjectDescription": "本示例使用 <code>IValidatableObject</code> 实现校验 <code>联系电话1</code> 和 <code>联系电话2</code> 不能相同，以及 <code>名称</code> 不能为空，本例中并未设置 <code>名称</code> 为必填项，但是由于模型对 <code>IValidatableObject</code> 接口的实现中进行了校验，所以在提交数据时仍然触发 <code>OnInvalidSubmit</code> 回调委托",
     "ValidateFormIValidateCollectionTitle": "IValidateCollection 接口类型",
     "ValidateFormIValidateCollectionIntro": "<code>IValidateCollection</code> 接口提供了更加灵活的自定义 <code>联动</code> 校验，非常适合进行非常复杂的数据校验，例如多属性组合起来进行校验等场景。",
-    "ValidateFormIValidateCollectionDescription": "本示例使用 <code>IValidateCollection</code> 实现校验 <code>联系电话1</code> 和 <code>联系电话2</code> 不能相同校验，更改任意单元格使电话号码相同时两个文本框均进行提示"
+    "ValidateFormIValidateCollectionDescription": "本示例使用 <code>IValidateCollection</code> 实现校验 <code>联系电话1</code> 和 <code>联系电话2</code> 不能相同校验，更改任意单元格使电话号码相同时两个文本框均进行提示",
+    "ValidateMetadataTypeTitle": "MetadataType IValidateCollection",
+    "ValidateMetadataTypeIntro": "模型通过 <code>[MetadataType(typeof(MockModelMetadataType))]</code> 指定元数据类型 <code>MockModelMetadataType</code> 进行模型验证，如果指定模型继承 <code>IValidateCollection</code> 接口时，调用其 <code>Validate</code> 方法进行数据合规性检查"
   },
   "BootstrapBlazor.Server.Components.Samples.Ajaxs": {
     "AjaxTitle": "Ajax调用",

src/BootstrapBlazor/BootstrapBlazor.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk.Razor">
 
   <PropertyGroup>
-    <Version>8.9.2</Version>
+    <Version>8.9.3-beta01</Version>
   </PropertyGroup>
 
   <ItemGroup Condition="'$(TargetFramework)' == 'net5.0'">

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

@@ -295,9 +295,18 @@ internal async Task ValidateObject(ValidationContext context, List<ValidationRes
             // 验证 IValidatableObject
             if (results.Count == 0)
             {
-                if (context.ObjectInstance is IValidatableObject validatableObject)
+                IValidatableObject? validate;
+                if (context.ObjectInstance is IValidatableObject v)
                 {
-                    var messages = validatableObject.Validate(context);
+                    validate = v;
+                }
+                else
+                {
+                    validate = context.GetInstanceFromMetadataType<IValidatableObject>();
+                }
+                if (validate != null)
+                {
+                    var messages = validate.Validate(context);
                     if (messages.Any())
                     {
                         foreach (var key in _validatorCache.Keys)
@@ -506,11 +515,20 @@ private async Task ValidateAsync(IValidateComponent validator, ValidationContext
             if (messages.Count == 0)
             {
                 // 联动字段验证 IValidateCollection
-                if (context.ObjectInstance is IValidateCollection validateCollection)
+                IValidateCollection? validate;
+                if (context.ObjectInstance is IValidateCollection v)
+                {
+                    validate = v;
+                }
+                else
+                {
+                    validate = context.GetInstanceFromMetadataType<IValidateCollection>();
+                }
+                if (validate != null)
                 {
-                    messages.AddRange(validateCollection.Validate(context));
-                    ValidMemberNames.AddRange(validateCollection.ValidMemberNames());
-                    InvalidMemberNames.AddRange(validateCollection.InvalidMemberNames());
+                    messages.AddRange(validate.Validate(context));
+                    ValidMemberNames.AddRange(validate.ValidMemberNames());
+                    InvalidMemberNames.AddRange(validate.InvalidMemberNames());
                 }
             }
         }
@@ -619,7 +637,7 @@ public void NotifyFieldChanged(in FieldIdentifier fieldIdentifier, object? value
         OnFieldValueChanged?.Invoke(fieldIdentifier.FieldName, value);
     }
 
-    private List<string> _invalidComponents = [];
+    private readonly List<string> _invalidComponents = [];
 
     internal void AddValidationComponent(string id)
     {

src/BootstrapBlazor/Extensions/ValidateContextExtensions.cs

@@ -0,0 +1,32 @@
+// Copyright (c) Argo Zhang (argo@163.com). All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+// Website: https://www.blazor.zone or https://argozhang.github.io/
+
+using Microsoft.Extensions.DependencyInjection;
+using System.Reflection;
+
+namespace BootstrapBlazor.Components;
+
+/// <summary>
+/// ValidationContext 扩展方法
+/// </summary>
+public static class ValidationContextExtensions
+{
+    /// <summary>
+    /// 从 <see cref="MetadataTypeAttribute"/> 中获取指定类型实例
+    /// </summary>
+    /// <typeparam name="T">验证接口类型</typeparam>
+    /// <param name="context"></param>
+    /// <returns>没有实现 <typeparamref name="T"/> 接口，则返回 <see langword="null"/></returns>
+    public static T? GetInstanceFromMetadataType<T>(this ValidationContext context) where T : class
+    {
+        T? ret = default;
+        var attribute = context.ObjectInstance.GetType().GetCustomAttribute<MetadataTypeAttribute>();
+        if (attribute != null && attribute.MetadataClassType.GetInterfaces().Any(x => x.Equals(typeof(T))))
+        {
+            //此处是否需要缓存？
+            ret = ActivatorUtilities.CreateInstance(context, attribute.MetadataClassType) as T;
+        }
+        return ret;
+    }
+}

test/UnitTest/Components/ValidateFormTest.cs

@@ -237,6 +237,30 @@ public void MetadataTypeAttribute_Ok()
         cut.InvokeAsync(() => form.Submit());
     }
 
+    [Fact]
+    public void MetadataTypeIValidatableObject_Ok()
+    {
+        var foo = new Dummy() { Password1 = "password", Password2 = "Password2" };
+        var cut = Context.RenderComponent<ValidateForm>(pb =>
+        {
+            pb.Add(a => a.Model, foo);
+            pb.AddChildContent<MockInput<string>>(pb =>
+            {
+                pb.Add(a => a.Value, foo.Password1);
+                pb.Add(a => a.ValueExpression, Utility.GenerateValueExpression(foo, "Password1", typeof(string)));
+            });
+            pb.AddChildContent<MockInput<string>>(pb =>
+            {
+                pb.Add(a => a.Value, foo.Password2);
+                pb.Add(a => a.ValueExpression, Utility.GenerateValueExpression(foo, "Password2", typeof(string)));
+            });
+        });
+        var form = cut.Find("form");
+        cut.InvokeAsync(() => form.Submit());
+        var message = cut.FindComponent<MockInput<string>>().Instance.GetErrorMessage();
+        Assert.Equal("两次密码必须一致。", message);
+    }
+
     [Fact]
     public void Validate_Class_Ok()
     {
@@ -672,12 +696,27 @@ private class Dummy
 
         [Required]
         public string? File { get; set; }
+
+        public string? Password1 { get; set; }
+        public string? Password2 { get; set; }
     }
 
-    private class DummyMetadata
+    private class DummyMetadata : IValidatableObject
     {
         [Required]
         public DateTime? Value { get; set; }
+
+        public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
+        {
+            var result = new List<ValidationResult>();
+            if (validationContext.ObjectInstance is Dummy dy)
+            {
+                if (!string.Equals(dy.Password1, dy.Password2, StringComparison.InvariantCultureIgnoreCase))
+                    result.Add(new ValidationResult("两次密码必须一致。",
+                        [nameof(Dummy.Password1), nameof(Dummy.Password2)]));
+            }
+            return result;
+        }
     }
 
     private class MockFoo