mirror of
https://gitee.com/hyperf/hyperf.git
synced 2024-12-05 21:28:15 +08:00
e1544beec5
Co-authored-by: zmy <my.zhu@knowyourself.cc> Co-authored-by: 沈唁 <52o@qq52o.cn> Co-authored-by: 李铭昕 <l@hyperf.io>
3.8 KiB
3.8 KiB
枚举类
当您需要定义错误码和错误信息时,可能会使用以下方式,
<?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
<?php
declare(strict_types=1);
namespace App\Constants;
use Hyperf\Constants\AbstractConstants;
use Hyperf\Constants\Annotation\Constants;
#[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 App\Exception;
use App\Constants\ErrorCode;
use Hyperf\Server\Exception\ServerException;
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 App\Controller;
use App\Constants\ErrorCode;
use App\Exception\BusinessException;
class IndexController extends AbstractController
{
public function index()
{
throw new BusinessException(ErrorCode::SERVER_ERROR);
}
}
可变参数
在使用 ErrorCode::getMessage(ErrorCode::SERVER_ERROR)
来获取对应错误信息时,我们也可以传入可变参数,进行错误信息组合。比如以下情况
<?php
use Hyperf\Constants\AbstractConstants;
use Hyperf\Constants\Annotation\Constants;
#[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 Hyperf\Constants\AbstractConstants;
use Hyperf\Constants\Annotation\Constants;
#[Constants]
class ErrorCode extends AbstractConstants
{
/**
* @Message("params.invalid")
*/
const PARAMS_INVALID = 1000;
}
$message = ErrorCode::getMessage(ErrorCode::SERVER_ERROR, ['param' => 'user_id']);