登录/注册

枚举类

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

<?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

使用

定义枚举类

<?php

declare(strict_types=1);

namespace AppConstants;

use HyperfConstantsAbstractConstants;
use HyperfConstantsAnnotationConstants;

/**
 * @Constants
 */
class ErrorCode extends AbstractConstants
{
    /**
     * @Message("Server Error!")
     */
    const SERVER_ERROR = 500;

    /**
     * @Message("系统参数错误")
     */
    const SYSTEM_INVALID = 700;
}

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

定义异常类

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

<?php

declare(strict_types=1);

namespace AppException;

use AppConstantsErrorCode;
use HyperfServerExceptionServerException;
use Throwable;

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

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

抛出异常

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

<?php

declare(strict_types=1);

namespace AppController;

use AppConstantsErrorCode;
use AppExceptionBusinessException;

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

可变参数

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

<?php

use HyperfConstantsAbstractConstants;
use HyperfConstantsAnnotationConstants;

/**
 * @Constants
 */
class ErrorCode extends AbstractConstants
{
    /**
     * @Message("Params %s is invalid.")
     */
    const PARAMS_INVALID = 1000;
}

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

// 1.2 版本以下 可以使用以下方式,但会在 1.2 版本移除

$message = ErrorCode::getMessage(ErrorCode::PARAMS_INVALID, 'user_id');

国际化

该功能仅在 v1.1.13 及往后的版本上可用

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

composer require hyperf/translation

相关配置详见 国际化

<?php

// 国际化配置

return [
    'params.invalid' => 'Params :param is invalid.',
];

use HyperfConstantsAbstractConstants;
use HyperfConstantsAnnotationConstants;

/**
 * @Constants
 */
class ErrorCode extends AbstractConstants
{
    /**
     * @Message("params.invalid")
     */
    const PARAMS_INVALID = 1000;
}

$message = ErrorCode::getMessage(ErrorCode::SERVER_ERROR, ['param' => 'user_id']);
原文地址:https://www.bookstack.cn/read/hyperf-1.1.20/constants.md
文章来源与用户投稿或网络采集,如果您是本文的作者,发现版权或转载方式问题请右侧邮箱联系管理员。

抢沙发

我们不是孤独的个体,留下足迹,保持联系,成为团体...
姓名
电子邮件
个人主页