feat(RequiredValidator): enhance the RequiredValidator class (#4247)

* refactor: 更改内部变量名

* refactor: 移除公共属性

* feat: 增加多语言支持

* chore: 更新字典表

* test: 更新单元测试名称

* test: 更新单元测试

exclusion.dic

@@ -55,6 +55,7 @@ Github
 menuitem
 Segmenteds
 Responsives
+resx
 tabset
 Splittings
 Foos

src/BootstrapBlazor/Components/Validate/ValidateBase.cs

@@ -227,7 +227,8 @@ protected virtual bool TryParseValueFromString(string value, [MaybeNullWhen(fals
  /// <returns></returns>
  protected virtual bool IsRequired() => ShowRequired ?? FieldIdentifier
  ?.Model.GetType().GetPropertyByName(FieldIdentifier.Value.FieldName)!.GetCustomAttribute<RequiredAttribute>(true) != null
- || (ValidateRules?.OfType<FormItemValidator>().Select(i => i.Validator).OfType<RequiredAttribute>().Any() ?? false);
+ || (ValidateRules?.OfType<FormItemValidator>().Select(i => i.IsRequired).Any() ?? false)
+ || (ValidateRules?.OfType<RequiredValidator>().Any() ?? false);
 
  /// <summary>
  /// Gets a string that indicates the status of the field being edited. This will include
@@ -295,7 +296,7 @@ protected override void OnParametersSet()
 
  if (ShowRequired is true)
  {
- Rules.Add(new RequiredValidator() { ErrorMessage = RequiredErrorMessage ?? GetDefaultErrorMessage() });
+ Rules.Add(new RequiredValidator() { ErrorMessage = RequiredErrorMessage ?? GetDefaultRequiredErrorMessage() });
  }
  }
 
@@ -321,12 +322,12 @@ protected override async Task OnAfterRenderAsync(bool firstRender)
  }
  }
 
- private string? _defaultErrorMessage;
+ private string? _defaultRequiredErrorMessage;
 
- private string GetDefaultErrorMessage()
+ private string GetDefaultRequiredErrorMessage()
  {
- _defaultErrorMessage ??= Localizer["DefaultErrorMessage"];
- return _defaultErrorMessage;
+ _defaultRequiredErrorMessage ??= Localizer["DefaultRequiredErrorMessage"];
+ return _defaultRequiredErrorMessage;
  }
 
  #region Validation

src/BootstrapBlazor/Locales/en.json

@@ -375,6 +375,6 @@
  "LightModeText": "Light"
  },
  "BootstrapBlazor.Components.ValidateBase": {
- "DefaultErrorMessage": "{0} is required."
+ "DefaultRequiredErrorMessage": "{0} is required."
  }
 }

src/BootstrapBlazor/Locales/zh.json

@@ -375,6 +375,6 @@
  "LightModeText": "明亮"
  },
  "BootstrapBlazor.Components.ValidateBase": {
- "DefaultErrorMessage": "{0}是必填项"
+ "DefaultRequiredErrorMessage": "{0}是必填项"
  }
 }

src/BootstrapBlazor/Validators/FormItemValidator.cs

@@ -10,11 +10,6 @@ namespace BootstrapBlazor.Components;
 /// <param name="attribute"></param>
 public class FormItemValidator(ValidationAttribute attribute) : ValidatorBase
 {
- /// <summary>
- /// 获得 ValidationAttribute 实例
- /// </summary>
- public ValidationAttribute Validator { get; } = attribute;
-
  /// <summary>
  /// 验证方法
  /// </summary>
@@ -23,10 +18,15 @@ public class FormItemValidator(ValidationAttribute attribute) : ValidatorBase
  /// <param name="results">ValidateResult 集合实例</param>
  public override void Validate(object? propertyValue, ValidationContext context, List<ValidationResult> results)
  {
- var result = Validator.GetValidationResult(propertyValue, context);
+ var result = attribute.GetValidationResult(propertyValue, context);
  if (result != null)
  {
  results.Add(result);
  }
  }
+
+ /// <summary>
+ /// 是否为 RequiredAttribute 标签特性
+ /// </summary>
+ public bool IsRequired => attribute is RequiredAttribute;
 }

src/BootstrapBlazor/Validators/RequiredValidator.cs

@@ -4,6 +4,7 @@
 
 using BootstrapBlazor.Localization.Json;
 using Microsoft.AspNetCore.Components.Forms;
+using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Localization;
 using System.Collections;
 using System.Globalization;
@@ -43,6 +44,15 @@ public class RequiredValidator : ValidatorBase
  /// <param name="results">ValidateResult 集合实例</param>
  public override void Validate(object? propertyValue, ValidationContext context, List<ValidationResult> results)
  {
+ if (string.IsNullOrEmpty(ErrorMessage))
+ {
+ var localizer = context.GetRequiredService<IStringLocalizer<ValidateBase<string>>>();
+ var l = localizer["DefaultRequiredErrorMessage"];
+ if (!l.ResourceNotFound)
+ {
+ ErrorMessage = l.Value;
+ }
+ }
  var errorMessage = GetLocalizerErrorMessage(context, LocalizerFactory, Options);
  var memberNames = string.IsNullOrEmpty(context.MemberName) ? null : new string[] { context.MemberName };
  if (propertyValue == null)

test/UnitTest/Components/ValidateFormTest.cs

@@ -435,7 +435,7 @@ public async Task ValidateFromCode_Ok()
  }
 
  [Fact]
- public async Task Validate_Servise_Ok()
+ public async Task Validate_Service_Ok()
  {
  var foo = new HasService();
  var cut = Context.RenderComponent<ValidateForm>(pb =>

test/UnitTest/Validators/RequiredValidatorTest.cs

@@ -35,7 +35,7 @@ public void AllowEmptyString_Ok()
  }
 
  [Fact]
- public void EnnumerableValue_Ok()
+ public void EnumerableValue_Ok()
  {
  var foo = new Foo();
  var validator = new RequiredValidator()
@@ -75,5 +75,11 @@ public void Localizer_Ok()
  validator.Options.ResourceManagerStringLocalizerType = typeof(Foo);
  validator.Validate("v1", context, results);
  Assert.Empty(results);
+
+ var provider = Context.Services.GetRequiredService<IServiceProvider>();
+ validator = new RequiredValidator();
+ context = new ValidationContext(foo, provider, null);
+ validator.Validate(null, context, results);
+ Assert.Single(results);
  }
 }