CustomFluentValidationManager.cs 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131
  1. using BlazorEditForms.Model;
  2. using FluentValidation;
  3. using FluentValidation.Internal;
  4. using FluentValidation.Results;
  5. using FluentValidation.Validators;
  6. using Microsoft.AspNetCore.Components.Forms;
  7. namespace BlazorEditForms;
  8. public static class ValidationFailureExtensions
  9. {
  10. private const string FieldIdentifierKey = $"{nameof(FieldIdentifier)}_Key";
  11. public static FieldIdentifier? GetFieldIdentifier(this ValidationFailure failure)
  12. {
  13. failure.FormattedMessagePlaceholderValues.TryGetValue(FieldIdentifierKey, out var fieldIdentifier);
  14. return (FieldIdentifier?)fieldIdentifier;
  15. }
  16. public static void SetFieldIdentifier(this ValidationFailure failure, FieldIdentifier fieldIdentifier)
  17. {
  18. failure.FormattedMessagePlaceholderValues[FieldIdentifierKey] = fieldIdentifier;
  19. }
  20. }
  21. public class CustomFluentValidationManager : IDisposable
  22. {
  23. static CustomFluentValidationManager()
  24. {
  25. ValidatorOptions.Global.OnFailureCreated = (failure, context, value, rule, component) =>
  26. {
  27. if (!string.IsNullOrEmpty(rule.PropertyName))
  28. {
  29. failure.SetFieldIdentifier(new FieldIdentifier(context.InstanceToValidate, rule.PropertyName));
  30. }
  31. return failure;
  32. };
  33. }
  34. private readonly EventHandler<ValidationRequestedEventArgs> _validationRequestedHandler;
  35. private readonly EventHandler<FieldChangedEventArgs> _fieldChangedHandler;
  36. private readonly EditContext _editContext;
  37. private readonly IServiceProvider _serviceProvider;
  38. private readonly IValidator<Aggregate> _validator;
  39. private readonly ValidationMessageStore _validationMessageStore;
  40. public CustomFluentValidationManager(EditContext editContext, IServiceProvider serviceProvider)
  41. {
  42. _editContext = editContext;
  43. _serviceProvider = serviceProvider;
  44. _validator = new AggregateValidator();
  45. _validationRequestedHandler = async (sender, eventArgs) => await ValidateModel();
  46. _editContext.OnValidationRequested += _validationRequestedHandler;
  47. _fieldChangedHandler = async (sender, eventArgs) => await ValidateField(eventArgs.FieldIdentifier);
  48. _editContext.OnFieldChanged += _fieldChangedHandler;
  49. // This validation message store is _internally_ connected to the edit context and essentially serves as a
  50. // separate API to manage the validation messages that can (with public methods) only be _extracted from_ the
  51. // edit context.
  52. _validationMessageStore = new ValidationMessageStore(_editContext);
  53. }
  54. private async Task ValidateModel()
  55. {
  56. var validationContext = ValidationContext<object>.CreateWithOptions(_editContext.Model, strategy =>
  57. {
  58. strategy.IncludeRulesNotInRuleSet();
  59. });
  60. var validationResult = await _validator.ValidateAsync(validationContext);
  61. _validationMessageStore.Clear();
  62. foreach (var failure in validationResult.Errors)
  63. {
  64. var fieldIdentifier = failure.GetFieldIdentifier();
  65. if (fieldIdentifier.HasValue)
  66. {
  67. _validationMessageStore.Add(fieldIdentifier.Value, failure.ErrorMessage);
  68. }
  69. }
  70. _editContext.NotifyValidationStateChanged();
  71. }
  72. private async Task ValidateField(FieldIdentifier fieldIdentifier)
  73. {
  74. var validationContext = ValidationContext<object>.CreateWithOptions(_editContext.Model, strategy =>
  75. {
  76. strategy.UseCustomSelector(new FieldIdentifierSelector(fieldIdentifier));
  77. });
  78. var validationResult = await _validator.ValidateAsync(validationContext);
  79. _validationMessageStore.Clear(fieldIdentifier);
  80. foreach (var failure in validationResult.Errors)
  81. {
  82. var failureIdentifier = failure.GetFieldIdentifier();
  83. if (fieldIdentifier.Equals(failureIdentifier))
  84. {
  85. _validationMessageStore.Add(fieldIdentifier, failure.ErrorMessage);
  86. }
  87. }
  88. _editContext.NotifyValidationStateChanged();
  89. }
  90. private class FieldIdentifierSelector : IValidatorSelector
  91. {
  92. private readonly FieldIdentifier _fieldIdentifier;
  93. public FieldIdentifierSelector(FieldIdentifier fieldIdentifier)
  94. {
  95. _fieldIdentifier = fieldIdentifier;
  96. }
  97. public bool CanExecute(IValidationRule rule, string propertyPath, IValidationContext context)
  98. {
  99. return rule.Components.Any(c => c.Validator is IChildValidatorAdaptor) || (context.InstanceToValidate == _fieldIdentifier.Model &&
  100. rule.PropertyName == _fieldIdentifier.FieldName);
  101. }
  102. }
  103. public void Dispose()
  104. {
  105. _editContext.OnValidationRequested -= _validationRequestedHandler;
  106. _editContext.OnFieldChanged -= _fieldChangedHandler;
  107. }
  108. }