枚举类 - Hyperf 3.2 开发文档

枚举类

当您需要定义错误码和错误信息时，可能会使用以下方式，

<?php

class ErrorCode
{
    const SERVER_ERROR = 500;
    const PARAMS_INVALID = 1000;

    public static $messages = [
        self::SERVER_ERROR => 'Server Error',
        self::PARAMS_INVALID => '参数非法'
    ];
}

$message = ErrorCode::messages[ErrorCode::SERVER_ERROR] ?? '未知错误';

但这种实现方式并不友好，每当要查询错误码与对应错误信息时，都要在当前 Class 中搜索两次，所以框架提供了基于注解的枚举类。

安装

composer require hyperf/constants

使用

定义枚举类

通过 gen:constant 命令可以快速的生成一个枚举类。

php bin/hyperf.php gen:constant ErrorCode --type enum

<?php

declare(strict_types=1);

namespace App\Constants;

use Hyperf\Constants\Annotation\Constants;
use Hyperf\Constants\Annotation\Message;
use Hyperf\Constants\EnumConstantsTrait;

#[Constants]
enum ErrorCode: int
{
    use EnumConstantsTrait
    #[Message("Server Error！")]
    case SERVER_ERROR = 500;

    #[Message("系统参数错误")]
    case SYSTEM_INVALID = 700;
}

用户可以使用 ErrorCode::SERVER_ERROR->getMessage() 来获取对应错误信息。

定义异常类

如果单纯使用 枚举类，在异常处理的时候，还是不够方便。所以我们需要自己定义异常类 BusinessException，当有异常进来，会根据错误码主动查询对应错误信息。

<?php

declare(strict_types=1);

namespace App\Exception;

use App\Constants\ErrorCode;
use Hyperf\Server\Exception\ServerException;
use Throwable;

class BusinessException extends ServerException
{
    public function __construct(ErrorCode|int $code = 0, ?string $message = null, ?Throwable $previous = null)
    {
        if (is_null($message)) {
            if ($code instanceof ErrorCode) {
                $message = $code->getMessage();
            } else {
                $message = ErrorCode::getMessage($code);
            }
        }

        $code = $code instanceof ErrorCode ? $code->value : $code;

        parent::__construct($message, $code, $previous);
    }
}

抛出异常

完成上面两步，就可以在业务逻辑中，抛出对应异常了。

<?php

declare(strict_types=1);

namespace App\Controller;

use App\Constants\ErrorCode;
use App\Exception\BusinessException;

class IndexController extends AbstractController
{
    public function index()
    {
        throw new BusinessException(ErrorCode::SERVER_ERROR);
    }
}

可变参数

在使用 ErrorCode::SERVER_ERROR->getMessage() 来获取对应错误信息时，我们也可以传入可变参数，进行错误信息组合。比如以下情况

<?php


use Hyperf\Constants\Annotation\Constants;
use Hyperf\Constants\Annotation\Message;
use Hyperf\Constants\EnumConstantsTrait;

#[Constants]
enum ErrorCode: int
{
    use EnumConstantsTrait;
    
    #[Message("Params %s is invalid.")]
    case PARAMS_INVALID = 1000;
}

$message = ErrorCode::PARAMS_INVALID->getMessage(['user_id']);

国际化

要使 hyperf/constants 组件支持国际化，就必须要安装 hyperf/translation 组件并配置好语言文件，如下：

composer require hyperf/translation