FluentValidation中基于对象上下文的自定义属性验证器实现

概述

在使用FluentValidation进行数据验证时，开发者经常会遇到需要根据整个对象的上下文来验证某个特定属性的场景。本文将详细介绍如何在FluentValidation中实现这种基于对象上下文的属性验证器。

核心问题

在FluentValidation中，标准的属性验证器(PropertyValidator)通常只关注单个属性的验证逻辑。但实际业务场景中，我们经常需要根据对象的其他属性值来决定当前属性的验证规则。

例如，验证信用卡号时，可能需要根据公司ID(CompanyId)来决定不同的验证规则。这种情况下，验证器需要访问整个对象而不仅仅是信用卡号属性本身。

解决方案

FluentValidation提供了灵活的方式来实现这种需求，主要有两种实现模式：

1. 通过构造函数传递选择器函数

这是FluentValidation推荐的标准做法，通过向属性验证器的构造函数传递一个选择器函数，该函数可以从完整对象中提取所需信息。

public class CardNumberValidator<T> : PropertyValidator<T, CardNumber> {
    private readonly Func<T, CompanyIdEnums> _companyIdSelector;
    
    public CardNumberValidator(Func<T, CompanyIdEnums> companyIdSelector) {
        _companyIdSelector = companyIdSelector;
    }

    public override bool IsValid(ValidationContext<T> context, CardNumber value) {
        var companyId = _companyIdSelector(context.InstanceToValidate);
        // 根据companyId执行不同的验证逻辑
    }
}

使用时通过扩展方法封装：

public static IRuleBuilderOptions<T, CardNumber> CardIsValid<T>(
    this IRuleBuilder<T, CardNumber> ruleBuilder,
    Func<T, CompanyIdEnums> companyIdSelector)
{
    return ruleBuilder.SetValidator(new CardNumberValidator<T>(companyIdSelector));
}

2. 直接访问验证上下文

另一种方式是让验证器直接从验证上下文中获取所需信息：

public override bool IsValid(ValidationContext<T> context, CardNumber value) {
    var instance = context.InstanceToValidate;
    // 直接从instance中获取所需属性
}

这种方式虽然简单，但耦合度较高，不利于复用。

最佳实践建议

1. 优先使用选择器模式：通过构造函数传递选择器函数的方式更加灵活，验证器可以独立测试，且与具体属性解耦。

2. 封装为扩展方法：将复杂验证逻辑封装为扩展方法，提供简洁的API给调用方。

3. 考虑多种构造方式：可以为验证器提供多种构造函数，同时支持直接值和选择器函数两种方式。

4. 文档注释：为自定义验证器添加详细的XML注释，说明其使用方式和预期行为。

实现示例

完整实现一个基于公司ID的信用卡号验证器：

/// <summary>
/// 信用卡号验证器，根据公司ID应用不同的验证规则
/// </summary>
public class CardNumberValidator<T> : PropertyValidator<T, CardNumber> {
    private readonly Func<T, CompanyIdEnums> _companyIdSelector;
    private readonly CompanyIdEnums? _fixedCompanyId;
    
    // 使用选择器函数的构造函数
    public CardNumberValidator(Func<T, CompanyIdEnums> companyIdSelector) {
        _companyIdSelector = companyIdSelector;
    }
    
    // 使用固定值的构造函数
    public CardNumberValidator(CompanyIdEnums fixedCompanyId) {
        _fixedCompanyId = fixedCompanyId;
    }

    public override string Name => "CardNumberValidator";

    protected override string GetDefaultMessageTemplate(string errorCode)
        => "{PropertyName}不是有效的信用卡号";

    public override bool IsValid(ValidationContext<T> context, CardNumber value) {
        var companyId = _companyIdSelector?.Invoke(context.InstanceToValidate) 
                      ?? _fixedCompanyId.Value;
        
        // 根据companyId执行验证逻辑
        return IsValidForCompany(value, companyId);
    }
    
    private bool IsValidForCompany(CardNumber card, CompanyIdEnums companyId) {
        // 实现具体的验证逻辑
    }
}

// 扩展方法
public static class CardValidationExtensions {
    public static IRuleBuilderOptions<T, CardNumber> CardIsValid<T>(
        this IRuleBuilder<T, CardNumber> ruleBuilder,
        Func<T, CompanyIdEnums> companyIdSelector)
    {
        return ruleBuilder.SetValidator(new CardNumberValidator<T>(companyIdSelector));
    }
    
    public static IRuleBuilderOptions<T, CardNumber> CardIsValid<T>(
        this IRuleBuilder<T, CardNumber> ruleBuilder,
        CompanyIdEnums companyId)
    {
        return ruleBuilder.SetValidator(new CardNumberValidator<T>(companyId));
    }
}

总结

FluentValidation提供了强大的扩展能力来处理复杂的验证场景。通过合理设计验证器结构和封装扩展方法，可以实现既灵活又可复用的验证逻辑。选择器函数模式是处理依赖对象上下文验证的最佳实践，它保持了验证器的独立性和可测试性，同时提供了足够的灵活性来应对各种业务需求。