webman exception
v1.5.4
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 형식으로 반환됩니다. 위는
返回简略的异常信息
모든 예외 오류 핸들러는 구성 파일 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 ();
}
}
}우편 배달부를 사용하여 스크린샷 요청
JwtTokenException 유효성 검증ValidateException 더 보기: 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. 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
