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

概述

在FluentValidation验证框架中，开发者经常需要创建可重用的属性验证逻辑。本文探讨如何实现一个能够访问完整对象上下文的属性验证器(PropertyValidator)，这在需要根据对象其他属性值来验证当前属性的场景中非常有用。

核心问题

传统属性验证器通常只关注单个属性的值，但在实际业务场景中，我们经常需要：

• 根据对象的其他属性值来验证当前属性
• 避免重复编写相似的验证逻辑
• 保持代码的整洁和可维护性

解决方案

FluentValidation提供了灵活的方式来实现这一需求，主要通过自定义PropertyValidator类来实现。

1. 创建自定义属性验证器

首先创建一个继承自PropertyValidator<T, TProperty>的验证器类：

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);
        
        // 实现具体的验证逻辑
        return /* 根据companyId验证value的逻辑 */;
    }

    protected override string GetDefaultMessageTemplate(string errorCode)
    {
        return "信用卡号无效";
    }
}

2. 创建扩展方法

为了提供更友好的API，可以创建扩展方法：

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));
    }
}

3. 使用方式

在实际验证规则中使用这个验证器非常简单：

public class OrderValidator : AbstractValidator<Order>
{
    public OrderValidator()
    {
        RuleFor(x => x.CardNumber).CardIsValid(x => x.CompanyId);
    }
}

设计原理

这种实现方式遵循了FluentValidation的几个核心设计原则：

1. 依赖注入：通过构造函数注入选择器函数，保持验证器的可测试性
2. 上下文感知：验证器可以访问完整的被验证对象，而不仅仅是当前属性值
3. 重用性：相同的验证逻辑可以在不同场景下复用
4. 强类型：所有类型信息都在编译时检查

替代方案比较

除了自定义PropertyValidator，FluentValidation还提供了其他实现类似功能的方式：

1. 使用Must/Custom方法：

   • 优点：实现简单，适合简单场景
   • 缺点：复杂验证逻辑可能导致代码重复

2. 使用RootContextData：

   • 优点：可以共享上下文数据
   • 缺点：类型安全性较低，代码可读性较差

3. 本文方案：

   • 优点：类型安全，可重用，可测试
   • 缺点：需要创建更多类，适合复杂验证逻辑

最佳实践建议

1. 对于简单的一次性验证，考虑使用Must/Custom方法
2. 对于需要在多个验证器中重用的复杂逻辑，使用自定义PropertyValidator
3. 保持验证器的单一职责，每个验证器只关注一种验证逻辑
4. 为自定义验证器提供清晰的错误消息
5. 考虑为验证器编写单元测试

总结

通过自定义PropertyValidator并配合扩展方法，我们可以在FluentValidation中创建强大且灵活的属性验证逻辑，这些验证器不仅能够验证属性值本身，还能根据对象的其他属性值进行上下文感知的验证。这种方法既保持了代码的整洁性，又提供了良好的重用性和可维护性，是处理复杂验证场景的理想选择。