枚举类

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

  1. <?php
  3. class ErrorCode
  4. {
  5.     const SERVER_ERROR = 500;
  6.     const PARAMS_INVALID = 1000;
  8.     public static $messages = [
  9.         self::SERVER_ERROR => 'Server Error',
  10.         self::PARAMS_INVALID => '参数非法'
  11.     ];
  12. }
  14. $message = ErrorCode::messages[ErrorCode::SERVER_ERROR] ?? '未知错误';

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

安装

  1. composer require hyperf/constants

使用

定义枚举类

  1. <?php
  3. declare(strict_types=1);
  5. namespace App\Constants;
  7. use Hyperf\Constants\AbstractConstants;
  8. use Hyperf\Constants\Annotation\Constants;
  10. /**
  11.  * @Constants
  12.  */
  13. class ErrorCode extends AbstractConstants
  14. {
  15.     /**
  16.      * @Message("Server Error！")
  17.      */
  18.     const SERVER_ERROR = 500;
  20.     /**
  21.      * @Message("系统参数错误")
  22.      */
  23.     const SYSTEM_INVALID = 700;
  24. }

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

定义异常类

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

  1. <?php
  3. declare(strict_types=1);
  5. namespace App\Exception;
  7. use App\Constants\ErrorCode;
  8. use Hyperf\Server\Exception\ServerException;
  9. use Throwable;
  11. class BusinessException extends ServerException
  12. {
  13.     public function __construct(int $code = 0, string $message = null, Throwable $previous = null)
  14.     {
  15.         if (is_null($message)) {
  16.             $message = ErrorCode::getMessage($code);
  17.         }
  19.         parent::__construct($message, $code, $previous);
  20.     }
  21. }

抛出异常

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

<?php

declare(strict_types=1);

namespace App\Controller;

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

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