lujihong/easy-validator

php hyperf validator

v1.0.3 2023-03-16 16:39 UTC

Requires

• php: >=8.0
• hyperf/di: ~2.2.0|~3.0.0
• hyperf/filesystem: ~2.2.0|~3.0.0
• hyperf/http-server: ~2.2.0|~3.0.0
• hyperf/json-rpc: ~2.2.0|~3.0.0
• hyperf/rpc-server: ~2.2.0|~3.0.0
• hyperf/validation: ~2.2.0|~3.0.0
• jetbrains/phpstorm-attributes: ^1.0
• netresearch/jsonmapper: ^4.0
• phpdocumentor/reflection-docblock: ^5.0
• symfony/serializer: ^5.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• mockery/mockery: ^1.0
• phpstan/phpstan: ^0.12
• phpunit/phpunit: >=7.0
• symfony/var-dumper: ^5.1

MIT

• lujihong

• validator
• validation
• hyperf
• hyperf validation

README

基于 Hyperf EasyValidator

优点

• 根据注解自动生成Vo类，自动获取并转换request参数类型
• 支持框架数据验证器，自定义验证规则

注意

php >= 8.0

安装

composer require lujihong/easy-validator

使用示例

控制器

declare(strict_types=1);

namespace Api\Controller;

use Hyperf\EasyValidator\Annotation\Body;
use Hyperf\EasyValidator\Annotation\FormData;
use Hyperf\EasyValidator\Annotation\Query;
use Hyperf\EasyValidator\Annotation\Header;
use Api\Vo\Demo\DemoEditVo; //自动生成的Vo类

#[Controller(prefix: '/demo')]
class DemoController extends AbstractController
{
    #[
        PostMapping(path: "test"),
        FormData(key: "phone|手机号", rule: "required|phone"),
        FormData(key: "code|验证码", rule: "required|max:6")
    ]
    public function index()
    {

    }

    #[
        PutMapping(path: 'edit'),
        Header(key: 'Token|token', rule: 'required'),
        Body(key: 'test|测试', rule: 'required', fieldType: 'int'),
        Body(key: 'test1|测试1', rule: 'required', fieldType: 'string'),
    ]
    public function edit()
    {
        $vo = new DemoEditVo();、
        
        //从request请求中获取请求参数
        $vo->getAttributes();//获取所有属性，包含ip
        $vo->getIp();//获取Ip
        $vo->getTest();//获取测试字段值，已自动转换成int类型
        $vo->getTest1();//获取测试1字段值，已自动转换成string类型
        
        //自定义request参数值
        $changeVal = 2;
        $vo->setTest($changeVal);
        $vo->getTest();//此时值已变为2
        
        //设置其他自定义参数
        $vo->setOther(['foo_field' => '测试值']);
        $vo->getOther();//获取设置的其他值
    }

    #[
        PostMapping(path: 'fromData'),
        FormData(key: "phone|手机号", rule: "required|phone"),
        FormData(key: "code|验证码", rule: "required|max:6")
    ]
    public function fromData(): bool
    {

    }

    #[
        GetMapping(path: 'find/{id}/and/{in}'),
        Query(key: "id|测试id", rule: "required|numeric"),
        Query(key: "name|测试名称", rule: "required|test") //test为自定义验证规格
    ]
    public function find(int $id, float $in): array
    {
        return ['$id' => $id, '$in' => $in];
    }

}

Vo类

• fieldType，用于生成Vo类的类型限定，所有字段均不设置则不生成Vo类

支持的值为：string | array | bool | int | float | file

验证器

• key 格式：field|字段名称
• rule 验证规则

rule 支持hyperf框架所有验证

内置规则：phone、telephone、identity_card、crontab、class_exist、comma_separated

• 自定义验证规则

只需类名称上加上CustomValidationRule，并实现对应规则即可

use Hyperf\EasyValidator\Annotation\CustomValidationRule;

#[CustomValidationRule]
class DemoCustomValidationRule
{
    /**
     * 校验错误则返回错误信息, 正确则返回 true
     * @param $attribute
     * @param $value
     * @return bool|string
     */
    public function test($attribute, $value): bool|string
    {
        if (!preg_match('/^1[3456789]{1}\d{9}$/', trim((string)$value))) {
            return '格式不正确';
        }

        return true;
    }
}