如何在asp.net core 2.1或更高版本中创建自定义required if验证器

在ASP.NET Core 2.1或更高版本中创建自定义的RequiredIf验证器，可以通过实现IClientModelValidator接口和IValidationAttribute接口来完成。以下是一个详细的步骤和示例代码：

基础概念

模型验证：在ASP.NET Core中，模型验证是通过数据注解属性（如[Required]）和自定义验证器来实现的。
IClientModelValidator：用于客户端验证的接口。
IValidationAttribute：用于服务器端验证的接口。

类型

RequiredIfAttribute：自定义的验证属性，用于在特定条件下使字段成为必填项。

应用场景

当某个字段的值依赖于另一个字段的值时，可以使用RequiredIf验证器。例如，如果一个字段是“国家”，另一个字段是“邮政编码”，则只有在“国家”为特定值时，“邮政编码”才必须填写。

示例代码

1. 创建自定义验证属性

using System;
using System.ComponentModel.DataAnnotations;
using Microsoft.AspNetCore.Mvc.ModelBinding.Validation;

public class RequiredIfAttribute : ValidationAttribute, IClientModelValidator
{
    private readonly string _dependentProperty;
    private readonly object _targetValue;

    public RequiredIfAttribute(string dependentProperty, object targetValue)
    {
        _dependentProperty = dependentProperty;
        _targetValue = targetValue;
    }

    protected override ValidationResult IsValid(object value, ValidationContext validationContext)
    {
        var instance = validationContext.ObjectInstance;
        var type = instance.GetType();
        var property = type.GetProperty(_dependentProperty);

        if (property == null)
        {
            return new ValidationResult($"Unknown property: {_dependentProperty}");
        }

        var dependentValue = property.GetValue(instance, null);

        if (dependentValue != null && dependentValue.Equals(_targetValue))
        {
            if (value == null || string.IsNullOrWhiteSpace(value.ToString()))
            {
                return new ValidationResult(FormatErrorMessage(validationContext.DisplayName));
            }
        }

        return ValidationResult.Success;
    }

    public void AddValidation(ClientModelValidationContext context)
    {
        MergeAttribute(context.Attributes, "data-val", "true");
        MergeAttribute(context.Attributes, $"data-val-requiredif", ErrorMessage);
        MergeAttribute(context.Attributes, $"data-val-requiredif-dependentproperty", _dependentProperty);
        MergeAttribute(context.Attributes, $"data-val-requiredif-targetvalue", _targetValue?.ToString());
    }

    private bool MergeAttribute(IDictionary<string, string> attributes, string key, string value)
    {
        if (attributes.ContainsKey(key))
        {
            return false;
        }

        attributes.Add(key, value);
        return true;
    }
}

2. 在模型中使用自定义验证属性

public class MyModel
{
    [RequiredIf("Country", "USA")]
    public string ZipCode { get; set; }

    public string Country { get; set; }
}

3. 客户端JavaScript验证

为了使客户端验证生效，需要添加相应的JavaScript代码：

<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-validate/1.19.3/jquery.validate.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-validation-unobtrusive/3.2.12/jquery.validate.unobtrusive.min.js"></script>

<script>
    $.validator.addMethod("requiredif", function (value, element, params) {
        var dependentProperty = params.dependentproperty;
        var targetValue = params.targetvalue;
        var dependentValue = $(`#${dependentProperty}`).val();

        if (dependentValue === targetValue) {
            return value !== "";
        }
        return true;
    });

    $.validator.unobtrusive.adapters.addBool("requiredif", ["dependentproperty", "targetvalue"]);
</script>