webman exception
v1.5.4
composer require tinywan/exception-handlerconfig/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 形式で返されます。上記は
返回简略的异常信息
すべての例外エラー ハンドラーは、構成ファイルconfig/app.phpのdebug値に従ってエラー表示を調整します。 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 ();
}
}
}postman を使用してスクリーンショットをリクエストする
JwtTokenExceptionValidateException 詳細: 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"}およびその他のコンテンツですconfig/plugin/tinywan/exception-handler/app.phpファイルのstatus HTTP ステータス コードを編集します。
body戻り内容config/plugin/tinywan/exception-handler/app.phpファイルのbodyフィールドを編集します。
デフォルトのオプションは次のとおりです
{
"code" : 0 ,
"msg" : " Too Many Requests " ,
"data" : null
}カスタム オプションの参照 1
1. status HTTP ステータス コードが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に応答する必要があり、 buildResponseメソッドをオーバーライドするだけで済みますsolveExtraExceptionオーバーライドするだけです。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 ,
]);
}
}
vendor/bin/phpstan analyse src
vendor/bin/php-cs-fixer fix src
