Respect/Validation 扩展证件验证规则的技术实践

背景介绍

Respect/Validation 是一个流行的 PHP 验证库，它提供了丰富的验证规则来满足各种数据验证需求。其中，identityCard 规则用于验证证件号码，但当前版本(1.1)仅支持波兰证件的验证。本文将探讨如何扩展这一功能，以支持更多国家的证件验证。

现有实现分析

Respect/Validation 的 identityCard 规则设计采用了工厂模式，通过国家代码动态加载对应的验证类。核心实现逻辑如下：

1. 规则类位于 Respect\Validation\Rules 命名空间下
2. 特定国家的验证实现位于 Respect\Validation\Rules\Locale 子命名空间
3. 异常类位于 Respect\Validation\Exceptions\Locale 命名空间
4. 通过 __NAMESPACE__.'\\Locale\\'.$shortName 动态构建类名

这种设计虽然提供了扩展性，但也带来了一些限制，特别是当开发者想要在自己的命名空间下实现自定义规则时。

扩展方案比较

方案一：直接扩展核心命名空间

如问题中所述，可以通过修改 composer.json 的自动加载配置，将自己的规则类映射到 Respect/Validation 的命名空间下：

"autoload": {
    "psr-4": {
        "Respect\\Validation\\Rules\\Locale\\": "src/Libraries/Validation/Rules/Locale/",
        "Respect\\Validation\\Exceptions\\Locale\\": "src/Libraries/Validation/Exceptions/Locale/"
    }
}

优点：

• 完全兼容现有的 identityCard 规则调用方式
• 无需修改库的核心代码

缺点：

• 污染了库的原始命名空间
• 可能在未来版本升级时产生冲突
• 不够优雅，违背了命名空间隔离的原则

方案二：创建独立规则

更推荐的方案是创建完全独立的验证规则，不依赖于原有的 identityCard 实现：

v::with('MyApp\\Libraries\\Validation\\Rules\\');
v::xxIdentityCard()->assert($input);

优点：

• 完全自主控制实现
• 不与核心库产生耦合
• 更清晰的代码组织
• 升级兼容性更好

缺点：

• 不能复用 identityCard 的统一调用接口
• 需要为每个国家创建独立的规则

最佳实践建议

基于以上分析，对于大多数项目场景，推荐采用方案二，即创建独立的验证规则。这种方式的长期维护成本更低，也更符合现代PHP开发的最佳实践。

如果需要保持与 identityCard 相同的调用接口，可以考虑以下折中方案：

1. 继承原始的 IdentityCard 类并重写相关方法
2. 在自己的命名空间下实现全套规则和异常类
3. 通过工厂方法或依赖注入来提供自定义实现

实现示例

以下是创建独立验证规则的完整示例：

规则类：

namespace MyApp\Validation\Rules;

use Respect\Validation\Rules\AbstractRule;

class XxIdentityCard extends AbstractRule
{
    public function validate($input): bool
    {
        // 实现具体的验证逻辑
        return $this->isValidXxId($input);
    }
    
    private function isValidXxId(string $id): bool
    {
        // 具体的验证算法
        return true;
    }
}

异常类：

namespace MyApp\Validation\Exceptions;

use Respect\Validation\Exceptions\ValidationException;

class XxIdentityCardException extends ValidationException
{
    protected $defaultTemplates = [
        self::MODE_DEFAULT => [
            self::STANDARD => '{{name}} 必须是有效的XX国证件号码',
        ],
        self::MODE_NEGATIVE => [
            self::STANDARD => '{{name}} 不能是有效的XX国证件号码',
        ],
    ];
}

使用方式：

v::with('MyApp\\Validation\\Rules\\', 'MyApp\\Validation\\Exceptions\\');
v::xxIdentityCard()->validate($idNumber);

总结

在扩展 Respect/Validation 功能时，优先考虑在自己的命名空间下实现独立规则，这能带来更好的代码组织和维护性。虽然直接扩展核心命名空间在技术上是可行的，但从长期维护角度看并不是最佳选择。理解库的设计理念和扩展机制，能够帮助开发者做出更合理的架构决策。