feat(FieldIdentifier): add GetRequiredValidator extension method (#4937)

* refactor: 代码重构

* chore: bump version 9.1.9-beta05

Co-Authored-By: Ocrosoft <[email protected]>

* test: 增加单元测试

* refactor: 更新必填项验证逻辑

Co-Authored-By: Ocrosoft <[email protected]>

* refactor: 利用基类方法精简代码

* refactor: 增加 GetRequiredValidator 扩展方法

* refactor: 支持 DateTimeRangeValue 合规性检查

* test: 增加必填项约束

* test: 更新单元测试

* test: 更新单元测试

* doc: 更新示例

---------

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

Author: ArgoZhang

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

@@ -39,7 +39,7 @@
     <ValidateForm Model="BindModel">
         <div class="row g-3">
             <div class="col-12 col-sm-6">
-                <SelectTree TValue="string" @bind-Value="BindModel.Text" ShowIcon="true" Items="BindItems" />
+                <SelectTree TValue="string" @bind-Value="BindModel.Text" ShowIcon="true" Items="BindItems" OnExpandNodeAsync="OnExpandNodeAsync" />
             </div>
             <div class="col-12 col-sm-6 align-self-end">
                 <Button ButtonType="ButtonType.Submit">@Localizer["SelectTreesClientValidationButtonText"]</Button>

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

@@ -19,7 +19,7 @@ public partial class SelectTrees
     [NotNull]
     private TreeFoo? Model { get; set; }
 
-    private TreeFoo BindModel { get; set; } = new TreeFoo();
+    private TreeFoo BindModel { get; set; } = new();
 
     [NotNull]
     private List<TreeViewItem<string>>? BindItems { get; set; }
@@ -55,35 +55,49 @@ protected override void OnInitialized()
 
         BindModel = new TreeFoo()
         {
-            Text = "Sub Menu Three",
             Id = "1090",
             ParentId = "1050",
-            Icon = "fa-solid fa-font-awesome",
-            IsActive = true
+            Icon = "fa-solid fa-font-awesome"
         };
 
         BindItems =
         [
-          new TreeViewItem<string>("目录一")
-          {
-              Text ="目录一",
-              Icon = "fa-solid fa-folder",
-              ExpandIcon = "fa-solid fa-folder-open",
-              Items =
-              [
-                  new TreeViewItem<string>("子目录一")
-                  {
-                      Text ="子目录一",
-                      Icon = "fa-solid fa-folder",
-                      ExpandIcon = "fa-solid fa-folder-open",
-                      Items =
-                      [
-                          new TreeViewItem<string>("文件一") { Text = "文件一", Icon = "fa-solid fa-file", IsActive = true },
-                          new TreeViewItem<string>("文件二") { Text = "文件二", Icon = "fa-solid fa-file" }
-                      ]
-                  }
-              ]
-          }
-      ];
+            new TreeViewItem<string>("目录一")
+            {
+                Text = "目录一",
+                Icon = "fa-solid fa-folder",
+                ExpandIcon = "fa-solid fa-folder-open",
+                Value = "101",
+                HasChildren = true
+            }
+        ];
+    }
+
+    private async Task<IEnumerable<TreeViewItem<string>>> OnExpandNodeAsync(TreeViewItem<string> node)
+    {
+        await Task.Delay(500);
+
+        if (node.Value == "101")
+        {
+            return [new TreeViewItem<string>("子目录一")
+            {
+                Text = "子目录一",
+                Icon = "fa-solid fa-folder",
+                ExpandIcon = "fa-solid fa-folder-open",
+                Value = "1001",
+                HasChildren = true
+            }];
+        }
+        else if (node.Value == "1001")
+        {
+            return [
+                new TreeViewItem<string>("文件一") { Text = "文件一", Icon = "fa-solid fa-file", Value = "10010" },
+                new TreeViewItem<string>("文件二") { Text = "文件二", Icon = "fa-solid fa-file", Value = "10011" }
+            ];
+        }
+        else
+        {
+            return [];
+        }
     }
 }

src/BootstrapBlazor/BootstrapBlazor.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk.Razor">
 
   <PropertyGroup>
-    <Version>9.1.9-beta04</Version>
+    <Version>9.1.9-beta05</Version>
   </PropertyGroup>
 
   <ItemGroup>

src/BootstrapBlazor/Components/Checkbox/CheckboxList.razor.cs

@@ -98,10 +98,6 @@ public partial class CheckboxList<TValue> : ValidateBase<TValue>
     [Parameter]
     public Func<Task>? OnMaxSelectedCountExceed { get; set; }
 
-    [Inject]
-    [NotNull]
-    private IStringLocalizerFactory? LocalizerFactory { get; set; }
-
     /// <summary>
     /// 获得 当前选项是否被禁用
     /// </summary>
@@ -121,23 +117,7 @@ protected override void OnInitialized()
         EnsureParameterValid();
 
         // 处理 Required 标签
-        if (EditContext != null && FieldIdentifier != null)
-        {
-            var pi = FieldIdentifier.Value.Model.GetType().GetPropertyByName(FieldIdentifier.Value.FieldName);
-            if (pi != null)
-            {
-                var required = pi.GetCustomAttribute<RequiredAttribute>(true);
-                if (required != null)
-                {
-                    Rules.Add(new RequiredValidator()
-                    {
-                        LocalizerFactory = LocalizerFactory,
-                        ErrorMessage = required.ErrorMessage,
-                        AllowEmptyString = required.AllowEmptyStrings
-                    });
-                }
-            }
-        }
+        AddRequiredValidator();
     }
 
     /// <summary>

src/BootstrapBlazor/Components/Checkbox/CheckboxListGeneric.razor.cs

@@ -4,7 +4,6 @@
 // Maintainer: Argo Zhang([email protected]) Website: https://www.blazor.zone
 
 using Microsoft.Extensions.Localization;
-using System.Reflection;
 
 namespace BootstrapBlazor.Components;
 
@@ -111,10 +110,6 @@ public partial class CheckboxListGeneric<TValue> : IModelEqualityComparer<TValue
     [Parameter]
     public Func<Task>? OnMaxSelectedCountExceed { get; set; }
 
-    [Inject]
-    [NotNull]
-    private IStringLocalizerFactory? LocalizerFactory { get; set; }
-
     /// <summary>
     /// 获得 当前选项是否被禁用
     /// </summary>
@@ -132,23 +127,7 @@ protected override void OnInitialized()
         base.OnInitialized();
 
         // 处理 Required 标签
-        if (EditContext != null && FieldIdentifier != null)
-        {
-            var pi = FieldIdentifier.Value.Model.GetType().GetPropertyByName(FieldIdentifier.Value.FieldName);
-            if (pi != null)
-            {
-                var required = pi.GetCustomAttribute<RequiredAttribute>(true);
-                if (required != null)
-                {
-                    Rules.Add(new RequiredValidator()
-                    {
-                        LocalizerFactory = LocalizerFactory,
-                        ErrorMessage = required.ErrorMessage,
-                        AllowEmptyString = required.AllowEmptyStrings
-                    });
-                }
-            }
-        }
+        AddRequiredValidator();
     }
 
     /// <summary>

src/BootstrapBlazor/Components/DateTimeRange/DateTimeRange.razor.cs

@@ -256,10 +256,6 @@ public bool AllowNull
     [NotNull]
     private IStringLocalizer<DateTimeRange>? Localizer { get; set; }
 
-    [Inject]
-    [NotNull]
-    private IStringLocalizerFactory? LocalizerFactory { get; set; }
-
     [Inject]
     [NotNull]
     private IIconTheme? IconTheme { get; set; }
@@ -280,24 +276,7 @@ protected override void OnInitialized()
     {
         base.OnInitialized();
 
-        if (FieldIdentifier != null)
-        {
-            var pi = FieldIdentifier.Value.Model.GetType().GetPropertyByName(FieldIdentifier.Value.FieldName);
-            if (pi != null)
-            {
-                var required = pi.GetCustomAttribute<RequiredAttribute>(true);
-                if (required != null)
-                {
-                    Rules.Add(new DateTimeRangeRequiredValidator()
-                    {
-                        LocalizerFactory = LocalizerFactory,
-                        ErrorMessage = required.ErrorMessage,
-                        AllowEmptyString = required.AllowEmptyStrings
-                    });
-                }
-            }
-        }
-
+        AddRequiredValidator();
         _showLeftButtons = RenderMode == DateTimeRangeRenderMode.Single;
     }
 

src/BootstrapBlazor/Components/Select/SelectObject.razor.cs

@@ -111,13 +111,6 @@ public partial class SelectObject<TItem>
     [NotNull]
     private IStringLocalizer<Select<TItem>>? Localizer { get; set; }
 
-    /// <summary>
-    /// 获得/设置 IStringLocalizerFactory 注入服务实例 默认为 null
-    /// </summary>
-    [Inject]
-    [NotNull]
-    public IStringLocalizerFactory? LocalizerFactory { get; set; }
-
     /// <summary>
     /// 获得 input 组件 Id 方法
     /// </summary>
@@ -140,10 +133,7 @@ protected override void OnInitialized()
     {
         base.OnInitialized();
 
-        if (ValidateForm != null)
-        {
-            Rules.Add(new RequiredValidator() { LocalizerFactory = LocalizerFactory, ErrorMessage = "{0} is required." });
-        }
+        AddRequiredValidator();
         _context = new InternalSelectObjectContext<TItem>() { Component = this };
     }
 

src/BootstrapBlazor/Components/Select/SelectTable.razor.cs

@@ -178,13 +178,6 @@ namespace BootstrapBlazor.Components;
     [NotNull]
     private IStringLocalizer<Select<TItem>>? Localizer { get; set; }
 
-    /// <summary>
-    /// 获得/设置 IStringLocalizerFactory 注入服务实例 默认为 null
-    /// </summary>
-    [Inject]
-    [NotNull]
-    public IStringLocalizerFactory? LocalizerFactory { get; set; }
-
     /// <summary>
     /// 获得 input 组件 Id 方法
     /// </summary>
@@ -205,10 +198,7 @@ protected override void OnInitialized()
     {
         base.OnInitialized();
 
-        if (ValidateForm != null)
-        {
-            Rules.Add(new RequiredValidator() { LocalizerFactory = LocalizerFactory, ErrorMessage = "{0} is required." });
-        }
+        AddRequiredValidator();
     }
 
     /// <summary>

src/BootstrapBlazor/Components/Select/SelectTree.razor.cs

@@ -155,6 +155,17 @@ public partial class SelectTree<TValue> : IModelEqualityComparer<TValue>
     [NotNull]
     private IIconTheme? IconTheme { get; set; }
 
+    /// <summary>
+    /// <inheritdoc/>
+    /// </summary>
+    protected override void OnInitialized()
+    {
+        base.OnInitialized();
+
+        // 处理 Required 标签
+        AddRequiredValidator();
+    }
+
     /// <summary>
     /// <inheritdoc/>
     /// </summary>
@@ -171,12 +182,20 @@ protected override async Task OnInitializedAsync()
     /// <summary>
     /// <inheritdoc/>
     /// </summary>
-    protected override async Task OnParametersSetAsync()
+    protected override void OnParametersSet()
     {
-        await base.OnParametersSetAsync();
+        base.OnParametersSet();
 
         DropdownIcon ??= IconTheme.GetIconByKey(ComponentIcons.SelectTreeDropdownIcon);
         PlaceHolder ??= Localizer[nameof(PlaceHolder)];
+    }
+
+    /// <summary>
+    /// <inheritdoc/>
+    /// </summary>
+    protected override async Task OnParametersSetAsync()
+    {
+        await base.OnParametersSetAsync();
 
         Items ??= [];
 

src/BootstrapBlazor/Components/Transfer/Transfer.razor.cs

@@ -188,13 +188,6 @@ public partial class Transfer<TValue>
     [Parameter]
     public RenderFragment<SelectedItem>? RightItemTemplate { get; set; }
 
-    /// <summary>
-    /// 获得/设置 IStringLocalizerFactory 注入服务实例 默认为 null
-    /// </summary>
-    [Inject]
-    [NotNull]
-    public IStringLocalizerFactory? LocalizerFactory { get; set; }
-
     [Inject]
     [NotNull]
     private IIconTheme? IconTheme { get; set; }
@@ -206,21 +199,8 @@ protected override void OnInitialized()
     {
         base.OnInitialized();
 
-        OnSetItemClass ??= _ => null;
-
         // 处理 Required 标签
-        if (FieldIdentifier != null)
-        {
-            var pi = FieldIdentifier.Value.Model.GetType().GetPropertyByName(FieldIdentifier.Value.FieldName);
-            if (pi != null)
-            {
-                var required = pi.GetCustomAttribute<RequiredAttribute>(true);
-                if (required != null)
-                {
-                    Rules.Add(new RequiredValidator() { LocalizerFactory = LocalizerFactory, ErrorMessage = required.ErrorMessage, AllowEmptyString = required.AllowEmptyStrings });
-                }
-            }
-        }
+        AddRequiredValidator();
     }
 
     /// <summary>