Intervention Validation开发者指南：如何扩展与贡献新验证规则

Intervention Validation开发者指南：如何扩展与贡献新验证规则

【免费下载链接】validationMissing Laravel Validation Rules项目地址: https://gitcode.com/gh_mirrors/validation4/validation

Intervention Validation是一个为Laravel框架提供扩展验证规则的强大工具包，旨在补充框架中缺失的验证规则。本文将详细介绍如何扩展现有验证规则并贡献新规则，帮助开发者轻松定制符合业务需求的验证逻辑。

为什么选择Intervention Validation？

Laravel框架自带了丰富的验证规则，但在实际开发中，我们经常会遇到一些特殊的验证需求，例如验证IBAN账号、信用卡号、国家代码等。Intervention Validation通过提供这些"缺失的"验证规则，极大地简化了开发流程。目前，该项目已包含超过40种常用验证规则，涵盖了金融、地理、格式验证等多个领域。

验证规则的基本结构

所有验证规则都遵循Laravel的验证规则接口规范。在项目中，基础验证规则抽象类定义在src/AbstractRule.php文件中，该类实现了Rule和ValidationRule接口：

abstract class AbstractRule implements Rule, ValidationRule

每个具体的验证规则都需要继承这个抽象类并实现validate方法：

public function validate(string $attribute, mixed $value, Closure $fail): void

这个方法接收三个参数：验证属性名、待验证值和失败回调函数。当验证失败时，通过调用$fail回调函数返回错误信息。

如何创建自定义验证规则

创建自定义验证规则只需三个简单步骤：

1. 创建规则类文件

在src/Rules/目录下创建一个新的PHP类文件，文件名应遵循PascalCase命名规范，例如CustomRule.php。

2. 实现验证逻辑

继承AbstractRule抽象类并实现validate方法。以下是一个简单的示例：

use Intervention\Validation\AbstractRule; class CustomRule extends AbstractRule { public function validate(string $attribute, mixed $value, Closure $fail): void { if (! $this->isValid($value)) { $fail('validation.custom_rule')->translate(); } } private function isValid($value): bool { // 实现具体的验证逻辑 return true; } }

3. 添加语言文件

在src/lang/目录下对应语言的文件夹中添加验证错误信息。例如，在src/lang/en/validation.php文件中添加：

'custom_rule' => 'The :attribute is not valid.',

如何注册验证规则

创建好自定义规则后，需要将其注册到Laravel的验证器中。项目通过src/Laravel/ValidationServiceProvider.php类来完成规则注册：

class ValidationServiceProvider extends ServiceProvider

在该服务提供者中，所有规则都通过Validator::extend方法注册。要添加新规则，只需在boot方法中添加类似以下的代码：

Validator::extend('custom_rule', CustomRule::class);

贡献新规则到开源项目

如果你创建的验证规则具有通用性，欢迎贡献到Intervention Validation项目中。贡献流程如下：

1. 克隆项目仓库

git clone https://gitcode.com/gh_mirrors/validation4/validation

2. 创建测试用例

为新规则创建对应的测试类，测试文件应放在tests/Rules/目录下，命名格式为RuleNameTest.php。

3. 提交PR

确保代码符合项目的编码规范，并提交Pull Request到主仓库。项目使用PHPStan进行静态分析，相关配置文件为phpstan.dist.neon。

常用验证规则示例

Intervention Validation已经包含了许多实用的验证规则，以下是一些常用规则及其用途：

• Iban.php：验证国际银行账号格式
• Creditcard.php：验证信用卡号
• CountryCode.php：验证ISO国家代码
• Postalcode.php：验证邮政编码
• LatLng.php：验证经纬度坐标

这些规则都可以直接在Laravel的验证器中使用，例如：

$request->validate([ 'iban' => 'required|iban', 'credit_card' => 'required|creditcard', 'country' => 'required|country_code', ]);

总结

Intervention Validation为Laravel开发者提供了一个灵活的扩展验证规则的解决方案。通过本文介绍的方法，你可以轻松创建自定义验证规则，满足特定业务需求，同时也可以为开源项目贡献自己的力量。无论是个人项目还是企业应用，Intervention Validation都能帮助你编写更简洁、更可靠的验证逻辑。

希望本文对你理解和使用Intervention Validation有所帮助！如果你有任何问题或建议，欢迎参与项目的讨论和贡献。

【免费下载链接】validationMissing Laravel Validation Rules项目地址: https://gitcode.com/gh_mirrors/validation4/validation