buexplain/arg

参数描述类

dev-main 2024-01-02 10:06 UTC

Requires

• php: >=8.0
• hyperf/context: ^3.1
• hyperf/contract: ^3.1
• hyperf/validation: ^3.1

Requires (Dev)

• hyperf/config: ^3.1
• hyperf/di: ^3.1
• hyperf/engine: ^2.10
• hyperf/framework: ^3.1
• hyperf/testing: ^3.1
• phpunit/phpunit: ^10.0
• swoole/ide-helper: ^5.0

Apache-2.0

• buexplain

• php

README

本包解决的问题是，参数通过map传递导致参数无法被编辑器识别的问题。

注意，本包只能在hyperf框架下使用。

安装命令：composer require buexplain/arg

使用示例

以注册接口为例子，做个简单的示例。

第一步：构造一个注册接口需要的参数描述。

<?php

namespace App\Arg;

use Arg\ArgAttr;
use Arg\BaseArg;

/**
 * 注册一个用户
 */
class RegisterArg extends BaseArg
{
    /**
     * @var string 账号
     */
    #[ArgAttr('required')]
    #[ArgAttr('string')]
    public string $account;

    /**
     * @var string 密码
     */
    #[ArgAttr('required')]
    #[ArgAttr('string')]
    public string $password;

    /**
     * @var string 验证码
     */
    #[ArgAttr('required')]
    #[ArgAttr('string')]
    public string $verification_code;
}

第二步：编写注册接口的控制器

<?php

declare(strict_types=1);

namespace App\Controller;

use App\Arg\RegisterArg;
use App\Services\RegisterService;
use Psr\Container\ContainerExceptionInterface;
use Psr\Container\NotFoundExceptionInterface;

class IndexController extends AbstractController
{
    /**
     * 注册用户
     * @return array
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
    public function index(): array
    {
        //初始化参数类
        $registerArg = new RegisterArg();
        //获取客户端发送的数据
        $data = $this->request->all();
        //校验数据
        $msgBag = $registerArg->validate($data);
        if ($msgBag->isNotEmpty()) {
            //校验失败，返回错误信息
            return [
                'code' => 1,
                'message' => $msgBag->first(),
            ];
        }
        //校验成功，将客户端数据注入到参数对象中
        $registerArg->assign($data);
        //调用service层的注册逻辑，执行注册动作，并返回注册结果
        return [
            'code' => 0,
            'data' => RegisterService::create($registerArg),
            'message' => '注册成功',
        ];
    }
}

第三步：实现注册逻辑

<?php

declare(strict_types=1);

namespace App\Services;

use App\Arg\RegisterArg;

class RegisterService
{
    /**
     * 注册用户
     * @param RegisterArg $arg
     * @return array
     */
    public static function create(RegisterArg $arg): array
    {
        //开始注册逻辑，这里假设注册成功后返回账号信息
        return ['account' => $arg->account];
    }
}

运行测试用例

Windows下：

swoole-cli.exe /cygdrive/c/buexplain/arg/vendor/bin/co-phpunit --prepend tests/bootstrap.php --configuration phpunit.xml --log-events-verbose-text phpunit.log

Linux： composer test