hf3.0使用枚举类

转载自 “自如出博客” 地址:https://www.ziruchu.com/art/654
第一步:安装组件

composer require hyperf/constants
第二步:生成枚举类

php bin/hyperf.php gen:constant PostStatusCode
该命令会在 app/Constants 目录下生成 PostStatusCode.php 文件。

第三步:编写生成的枚举类

<?php

declare(strict_types=1);

namespace App\Constants;

use Hyperf\Constants\AbstractConstants;
use Hyperf\Constants\Annotation\Constants;

#[Constants]
class PostStatusCode extends AbstractConstants
{
   /**
    * @Message("草稿")
    */
   const DRAFT = 1;

   /**
    * @Message("发布")
    */
   const PUBLISHED = 2;
}

第四步:定义 API 异常类

1、定义异常 Handler

<?php

namespace App\Exception\Handler;


use App\Constants\ErrorCode;
use App\Constants\PostStatusCode;
use App\Exception\ApiException;
use Hyperf\ExceptionHandler\ExceptionHandler;
use Hyperf\HttpMessage\Stream\SwooleStream;
use Psr\Http\Message\ResponseInterface;
use Throwable;

class ApiExceptionHandler extends ExceptionHandler
{
   public function handle(Throwable $throwable, ResponseInterface $response)
   {
       if ($throwable instanceof ApiException) {
           $data = json_encode([
               'code'    => $throwable->getCode(),
               // 通过状态码获取枚举信息
               'message' => PostStatusCode::getMessage($throwable->getCode()),
           ], JSON_UNESCAPED_UNICODE);


           $this->stopPropagation();

           return $response->withStatus(500)->withBody(new SwooleStream($data));
       }

       return $response;
   }

   public function isValid(Throwable $throwable): bool
   {
       return true;
   }
}

2、定义异常

<?php

namespace App\Exception;

use Hyperf\Server\Exception\ServerException;
class ApiException extends ServerException
{
}

3、注册异常

<?php
// config/autoload/exceptions.php
   
declare(strict_types=1);

return [
   'handler' => [
       'http' => [
           Hyperf\HttpServer\Exception\Handler\HttpExceptionHandler::class,
           App\Exception\Handler\AppExceptionHandler::class,
           // 添加 API 异常
           \App\Exception\Handler\ApiExceptionHandler::class,
       ],
   ],
];

第五步:控制器使用枚举类

<?php
// App\Controller\demo\TestController.php

use App\Constants\PostStatusCode;
   
#[GetMapping('/test/error')]
public function error(RequestInterface $request)
{
   $status = (int) $request->input('status', 1);

   $code = match ($status) {
       1 => PostStatusCode::DRAFT,
       2 => PostStatusCode::PUBLISHED,
       default => PostStatusCode::DRAFT,
   };

   throw new ApiException(PostStatusCode::getMessage($code), $code);
}

第六步:测试

$ curl http://192.168.31.90:9501/test/error?status=1
{"code":1,"message":"草稿"}
$ curl http://192.168.31.90:9501/test/error?status=2
{"code":2,"message":"发布"}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,458评论 4 363
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,454评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,171评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,062评论 0 207
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,440评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,661评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,906评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,609评论 0 200
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,379评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,600评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,085评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,409评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,072评论 3 237
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,088评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,860评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,704评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,608评论 2 270

推荐阅读更多精彩内容