webman exception

Плагин обработчика webman exception

Установить

composer require tinywan/exception-handler

Конфигурация

config/exception.php

 return [
    // 这里配置异常处理类
    '' =>  Tinywan  ExceptionHandler Handler::class,
];

В режиме нескольких приложений вы можете настроить классы обработки исключений отдельно для каждого приложения, см.

Основное использование

Ошибка параметра запроса

 use support  Request ;
use support  Response ;
use Tinywan  ExceptionHandler  Exception  BadRequestHttpException ;

class Token{
    public function issueToken ( Request $ request ): Response
    {
        $ params = $ request -> post ();
        if ( empty ( $ params )) {
            throw new BadRequestHttpException ( '账号或密码不能为空' );
        }
    }
}

Вышеупомянутое исключение выдает сообщение об ошибке в следующем формате:

 HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=utf-8

{
    "code" : 0 ,
    "msg" : "账号或密码不能为空" ,
    "data" : {},
}

Вся возвращаемая информация об исключении будет возвращена в формате json. Выше返回简略的异常信息

Все обработчики ошибок настраивают отображение ошибок в соответствии со значением debug в файле конфигурации config/app.php Если значение debug true (указывает, что он находится в режиме отладки), обработчик ошибок отобразит исключение и подробный вызов функции. стек и номер исходного кода для облегчения отладки; будет возвращена подробная информация об исключении. Если значение debug равно false , будет отображаться только информация об ошибке, чтобы предотвратить утечку конфиденциальной информации приложения, и будет возвращена краткая информация об исключении.

Возврат подробной информации об исключении

 HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=utf-8
        
{
    "code" : 0 ,
    "msg" : " password不允许为空" ,
    "data" : {
        "request_url" : " POST //127.0.0.1:8888/oauth/issue-token " ,
        "timestamp" : " 2022-03-06 15:19:12 " ,
        "client_ip" : " 172.18.0.1 " ,
        "request_param" : {
            "username" : " webman "
        },
        "error_message" : " password不允许为空" ,
        "error_trace": "#0 /var/www/webman-admin/app/functions.php(68): Tinywan\Validate\Validate->check(Array)n#1 /var/www/webman-admin/app/controller/Authentication.php(25): validate(Array, 'app\\common\\vali...')n#2 /var/www/webman-admin/vendor/workerman/webman-framework/src/App.php(234): app\controller\Authentication->issueToken(Object(support\Request))n#3 /var/www/webman-admin/app/middleware/AccessControlMiddleware.php(26): Webman\App::Webman\{closure}(Object(support\Request))n#4 /var/www/webman-admin/vendor/workerman/webman-framework/src/App.php(228): app\middleware\AccessControlMiddleware->process(Object(support\Request), Object(Closure))n#5 /var/www/webman-admin/vendor/workerman/webman-framework/src/App.php(137): Webman\App::Webman\{closure}(Object(support\Request))n#6 /var/www/webman-admin/vendor/workerman/workerman/Connection/TcpConnection.php(638): Webman\App->onMessage(Object(Workerman\Connection\TcpConnection), Object(support\Request))n#7 /var/www/webman-admin/vendor/workerman/workerman/Events/Select.php(295): Workerman\Connection\TcpConnection->baseRead(Resource id #254)n#8 /var/www/webman-admin/vendor/workerman/workerman/Worker.php(2417): Workerman\Events\Select->loop()n#9 /var/www/webman-admin/vendor/workerman/workerman/Worker.php(1541): Workerman\Worker->run()n#10 /var/www/webman-admin/vendor/workerman/workerman/Worker.php(1383): Workerman\Worker::forkOneWorkerForLinux(Object(Workerman\Worker))n#11 /var/www/webman-admin/vendor/workerman/workerman/Worker.php(1357): Workerman\Worker::forkWorkersForLinux()n#12 /var/www/webman-admin/vendor/workerman/workerman/Worker.php(549): Workerman\Worker::forkWorkers()n#13 /var/www/webman-admin/start.php(87): Workerman\Worker::runAll()n#14 {main}"
    }
}

Добавить данные расширенного ответа об исключении

 throw new BadRequestHttpException ( '验证码错误' ,[
    ' data ' => [
        ' data1 ' => '自定义响应数据1 ' ,
        ' data2 ' => '自定义响应数据2 ' ,
    ]
]);

К data

Добавьте data , чтобы получить подробную информацию об исключении.

{
    "code" : 0 ,
    "msg" : "验证码错误" ,
    "data" : {
        "request_url" : " POST //127.0.0.1:8888/oauth/issue-token " ,
         ...
        "data1" : "自定义响应数据1 " ,
        "data2" : "自定义响应数据2 "
    }
}

Как настроить собственный класс исключений

Написать класс исключения

Предположим, вы настроили один из них: 405 Method Not Allowed (это означает: метод запроса, указанный в строке запроса, не может использоваться для запроса соответствующего ресурса).

Пользовательские классы исключений должны наследовать только класс TinywanExceptionHandlerExceptionBaseException

 <?php
declare (strict_types= 1 );

namespace support  exception ;

use Tinywan  ExceptionHandler  Exception  BaseException ;

class MethodNotAllowedException extends BaseException
{
    /**
     * @var int
     */
    public int $ statusCode = 405 ;

    /**
     * @var string
     */
    public string $ errorMessage = '请求行中指定的请求方法不能被用于请求相应的资源' ;
}

Использовать класс исключения

 use support  Request ;
use support  Response ;
use support  exception  MethodNotAllowedException ;

class Token{
    public function issueToken ( Request $ request ): Response
    {
        $ params = $ request -> post ();
        if ( empty ( $ params )) {
            throw new MethodNotAllowedException ();
        }
    }
}

Используйте почтальона, чтобы запросить скриншоты

Поддерживаются классы исключений плагина

• Проверка класса исключения подключаемого модуля валидатора JwtTokenException
• Класс исключения подключаемого модуля проверки подлинности JWT ValidateException

Встроенный класс исключений

• Класс исключений клиента (статус HTTP 400): BadRequestHttpException
• Класс исключения аутентификации (статус HTTP 401): UnauthorizedHttpException
• Класс исключения авторизации ресурса (статус HTTP 403): ForbiddenHttpException
• Ресурс не имеет класса исключения (статус HTTP 404): NotFoundHttpException.
• Для адреса маршрутизации не существует класса исключений (состояние HTTP 404): RouteNotFoundException.
• Поток запросов ограничен в классе исключений (статус HTTP 429): TooManyRequestsHttpException.
• Класс исключений внутренней ошибки сервера (статус HTTP 500): ServerErrorHttpException

Подробнее: https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Status.

Пользовательский ответ на исключение

Сценарии использования

• Каждый проект имеет стандартный унифицированный вывод и настраиваемый возвращаемый контент.
• Разделение внешнего и внутреннего интерфейса: HTTP状态码возвращаемый внешним интерфейсом, не 429 , а 200 или другой.
• body ответа не {"code":0,"msg":"Too Many Requests"} , а {"error_code":200,"message":"Too Many Requests"} и другое содержимое.

Пользовательский код статуса HTTP

Отредактируйте код status HTTP файла config/plugin/tinywan/exception-handler/app.php

Пользовательское содержимое возвращаемого body

Отредактируйте поля body файла config/plugin/tinywan/exception-handler/app.php

Опция по умолчанию:

{
	"code" : 0 ,
	"msg" : " Too Many Requests " ,
	"data" : null
}

Пользовательские параметры, ссылка на один

1. Предположим, что код статуса HTTP status установлен на 200

2. Предположим, что для массива body установлено значение

 ' body ' => [
	' error_code ' => 200 ,
	' message ' => '请求太多请稍后重试'
]

Содержание ответа

 HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
	"error_code" : 200 ,
	"message" : "请求太多请稍后重试"
}

Другие могут быть настроены в соответствии с вашим собственным бизнесом

Расширьте свой собственный обработчик

Если проект требует значительной настройки, вероятно, потребуется расширить Handler. В этом случае вы можете наследовать TinywanExceptionHandlerHandler и изменить соответствующий метод.

Сценарии использования

• ответ должен отвечать на формат xml , а не json, просто нужно переопределить метод buildResponse
• Чтобы расширить ответ других исключений, я просто переопределяюsolveExtraException solveExtraException
• Чтобы отправить сообщения WeChat ненормально, я могу переопределить triggerNotifyEvent

Пользовательское исключение ErrorHandler

 namespace support ;

use Illuminate  Validation  ValidationException ;
use Tinywan  ExceptionHandler  Handler ;
use Webman  Http  Response ;

class ErrorHandler extends Handler
{
    /**
     * @inheritDoc
     */
    protected function solveExtraException (  Throwable $ e ): void
    {
        // 当前项目下的异常扩展
        if ( $ e instanceof ValidationException) {
            $ this -> errorMessage = $ e -> validator -> errors ()-> first ();
            $ this -> errorCode = 422 ;
            return ;
        }

        parent :: solveExtraException ( $ e );
    }

    /**
     * @inheritDoc
     */
    protected function triggerNotifyEvent (  Throwable $ e ): void
    {
         // ... 这里省略触发其他错误推送渠道

        parent :: triggerNotifyEvent ( $ e );
    }

    /**
     * @inheritDoc
     */
    protected function buildResponse (): Response
    {
        // 构造自己项目下的响应
        return json ([
            ' code ' => $ this -> statusCode , // 使用 statusCode 作为 code 返回
            ' msg ' => $ this -> errorMessage ,
            ' data ' => $ this -> responseData ,
        ]);
    }
}

Уведомление об исключении (робот DingTalk)

Другой

phpstan

 vendor/bin/phpstan analyse src

поставщик/bin/php-cs-fixer исправить источник

 vendor/bin/php-cs-fixer fix src