告别繁琐的用户输入验证：HyperfValidation助你构建健壮的API

<code class="bash">composer require hyperf/validation</code>

<code class="bash"># 发布国际化配置，如果已发布过 hyperf/translation 可以省略
php bin/hyperf.php vendor:publish hyperf/translation

# 发布 validation 组件的配置
php bin/hyperf.php vendor:publish hyperf/validation</code>

<code class="php">// your/config/path/autoload/exceptions.php (示例)
return [
    'handler' => [
        'http' => [
            \Hyperf\Validation\ValidationExceptionHandler::class,
            // 其他异常处理器...
        ],
    ],
];</code>

<code class="php">// your/config/path/autoload/middlewares.php (示例)
return [
    'http' => [
        \Hyperf\Validation\Middleware\ValidationMiddleware::class,
        // 其他中间件...
    ],
];</code>

<code class="bash">php bin/hyperf.php gen:request UserStoreRequest</code>

<code class="php"><?php

declare(strict_types=1);

namespace App\Request;

use Hyperf\Validation\Request\FormRequest;

class UserStoreRequest extends FormRequest
{
    /**
     * Determine if the user is authorized to make this request.
     */
    public function authorize(): bool
    {
        // 这里可以编写授权逻辑，例如检查用户是否登录或拥有特定权限
        return true;
    }

    /**
     * Get the validation rules that apply to the request.
     */
    public function rules(): array
    {
        return [
            'name' => 'required|string|min:2|max:50',
            'email' => 'required|email|unique:users,email',
            'password' => 'required|min:6|confirmed', // confirmed 会自动匹配 password_confirmation 字段
        ];
    }

    /**
     * Get custom messages for validator errors.
     */
    public function messages(): array
    {
        return [
            'name.required' => '用户名称不能为空。',
            'name.min' => '用户名称至少需要2个字符。',
            'email.required' => '邮箱不能为空。',
            'email.email' => '邮箱格式不正确。',
            'email.unique' => '该邮箱已被注册。',
            'password.required' => '密码不能为空。',
            'password.min' => '密码至少需要6位。',
            'password.confirmed' => '两次输入的密码不一致。',
        ];
    }
}</code>

<code class="php"><?php

declare(strict_types=1);

namespace App\Controller;

use App\Request\UserStoreRequest;
use Hyperf\HttpServer\Annotation\AutoController;

#[AutoController]
class UserController
{
    public function store(UserStoreRequest $request)
    {
        // 如果请求通过了验证，代码才会执行到这里
        $name = $request->input('name');
        $email = $request->input('email');
        $password = $request->input('password');

        // ... 执行业务逻辑，例如保存用户到数据库

        return ['message' => '用户创建成功！'];
    }
}</code>

<code class="php"><?php

declare(strict_types=1);

namespace App\Controller;

use Hyperf\Di\Annotation\Inject;
use Hyperf\HttpServer\Annotation\AutoController;
use Hyperf\HttpServer\Contract\RequestInterface;
use Hyperf\Validation\Contract\ValidatorFactoryInterface;
use Hyperf\Validation\Validator;

#[AutoController]
class ProductController
{
    #[Inject]
    protected ValidatorFactoryInterface $validatorFactory;

    public function createProduct(RequestInterface $request)
    {
        $rules = [
            'title' => 'required|string|max:255',
            'price' => 'required|numeric|min:0.01',
            'category_id' => 'required|integer|exists:categories,id',
        ];

        $messages = [
            'title.required' => '商品标题不能为空。',
            'price.min' => '商品价格必须大于0。',
            'category_id.exists' => '选择的分类不存在。',
        ];

        /** @var Validator $validator */
        $validator = $this->validatorFactory->make($request->all(), $rules, $messages);

        if ($validator->fails()) {
            // 获取所有验证失败的错误信息
            $errors = $validator->errors()->all();
            return ['code' => 400, 'message' => '验证失败', 'errors' => $errors];
        }

        // 验证通过，执行业务逻辑
        // ... 保存商品数据

        return ['message' => '商品创建成功！'];
    }

    // 示例：自定义验证规则
    public function bar(RequestInterface $request)
    {
        // 扩展自定义规则 'foo'
        $this->validatorFactory->extend('foo', function ($attribute, $value, $parameters, $validator) {
            return $value == 'foo';
        }, 'The :attribute must be "foo".'); // 默认错误消息

        // 替换自定义规则的错误消息占位符
        $this->validatorFactory->replacer('foo', function ($message, $attribute, $rule, $parameters) {
            return str_replace(':attribute', $attribute, $message);
        });

        $validator = $this->validatorFactory->make(
            $request->all(),
            [
                'name' => 'required|foo', // 使用自定义的 foo 规则
            ],
            [
                'name.foo' => ':attribute 必须是 "foo" 哦！', // 自定义错误消息
            ]
        );

        if ($validator->fails()) {
             return ['errors' => $validator->errors()->all()];
        }

        return ['message' => '验证通过！'];
    }
}</code>