init:完整功能

Author: jikang

.gitignore

@@ -0,0 +1,6 @@
+build
+vendor
+.idea
+.vscode
+.phpunit*
+composer.lock

README.md

@@ -0,0 +1,73 @@
+# webman exception handler 异常插件
+
+## 安装
+
+```php
+composer require jnewer/exception-handler
+```
+
+## 配置
+
+`config/exception.php`
+
+```php
+return [
+    // 这里配置异常处理类
+    '' => \Jnewer\ExceptionHandler\Handler::class,
+];
+```
+
+> 多应用模式时，你可以为每个应用单独配置异常处理类，参见[多应用](https://www.workerman.net/doc/webman/multiapp.html)
+
+## 基本用法
+
+请求参数错误
+
+```php
+use support\Request;
+use support\Response;
+use Jnewer\ExceptionHandler\Exception\NotFoundHttpException;
+
+class UserController{
+    public function view($id): Response
+    {
+        $user = User::find($id);
+        if (is_null($user)) {
+            throw new NotFoundHttpException('用户不存在');
+        }
+    }
+}
+```
+
+以上异常抛出错误信息，如下格式：
+
+```json
+HTTP/1.1 404 Not Found
+Content-Type: application/json;charset=utf-8
+
+{
+    "code": 0,
+    "success": false,
+    "message": "用户不存在",
+    "data": [],
+}
+```
+
+## 内置异常类
+
+- 客户端异常类（HTTP Status 400）：NotFoundHttpException
+- 身份认证异常类（HTTP Status 401）：UnauthorizedHttpException
+- 资源授权异常类（HTTP Status 403）：ForbiddenHttpException
+- 资源未找到异常类（HTTP Status 404）：NotFoundHttpException
+- 请求方法不允许异常类（HTTP Status 405）：MethodNotAllowedHttpException
+- 请求内容类型不支持异常类（HTTP Status 406）：NotAcceptableHttpException
+- 请求限流在异常类（HTTP Status 429）：TooManyRequestsHttpException
+- 服务器内部错误异常类（HTTP Status 500）：ServerErrorHttpException
+
+[更多参考：https://datatracker.ietf.org/doc/html/rfc7231#page-47](https://datatracker.ietf.org/doc/html/rfc7231#page-47)
+
+## 内置异常类Handler
+
+- 扩展自webman的Handler：Handler，可以针对不同的异常类进行不同的处理。
+- Http异常处理：HttpExceptionHandler
+- laravel验证器异常处理：ValidationExceptionHandler

composer.json

@@ -0,0 +1,13 @@
+{
+  "name": "jnewer/exception-handler",
+  "type": "library",
+  "license": "MIT",
+  "description": "Webman plugin jnewer/exception-handler",
+  "require": {
+  },
+  "autoload": {
+    "psr-4": {
+      "Jnewer\\ExceptionHandler\\": "src"
+    }
+  }
+}

src/Exception/BadRequestHttpException.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Jnewer\ExceptionHandler\Exception;
+
+/**
+ * BadRequestHttpException represents a "Bad Request" HTTP exception with status code 400.
+ *
+ * Use this exception to represent a generic client error. In many cases, there
+ * may be an HTTP exception that more precisely describes the error. In that
+ * case, consider using the more precise exception to provide the user with
+ * additional information.
+ *
+ * @see https://tools.ietf.org/html/rfc7231#section-6.5.1
+ * @author Jnewer <jeekang@qq.com>
+ */
+class BadRequestHttpException extends HttpException{
+    /**
+     * Constructor.
+     * @param string $message error message
+     * @param int $code error code
+     * @param \Exception $previous The previous exception used for the exception chaining.
+     */
+    public function __construct($message = null, $code = 0, \Exception $previous = null)
+    {
+        parent::__construct(400, $message, $code, $previous);
+    }
+}

src/Exception/ForbiddenHttpException.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Jnewer\ExceptionHandler\Exception;
+
+/**
+ * ForbiddenHttpException represents a "Forbidden" HTTP exception with status code 403.
+ *
+ * Use this exception when a user is not allowed to perform the requested action.
+ * Using different credentials might or might not allow performing the requested action.
+ * If you do not want to expose authorization information to the user, it is valid
+ * to respond with a 404 [[NotFoundHttpException]].
+ *
+ * @see https://tools.ietf.org/html/rfc7231#section-6.5.3
+ * @author Jnewer <jeekang@qq.com>
+ */
+class ForbiddenHttpException extends HttpException{
+    /**
+     * Constructor.
+     * @param string $message error message
+     * @param int $code error code
+     * @param \Exception $previous The previous exception used for the exception chaining.
+     */
+    public function __construct($message = null, $code = 0, \Exception $previous = null)
+    {
+        parent::__construct(403, $message, $code, $previous);
+    }
+}

src/Exception/HttpException.php

@@ -0,0 +1,45 @@
+<?php
+namespace Jnewer\ExceptionHandler\Exception;
+use Webman\Http\Request;
+use Webman\Http\Response;
+
+class HttpException extends \Exception{
+    /**
+     * @var int HTTP status code, such as 403, 404, 500, etc.
+     */
+    public $statusCode;
+
+    /**
+     * Constructor.
+     * @param int $status HTTP status code, such as 404, 500, etc.
+     * @param string $message error message
+     * @param int $code error code
+     * @param \Exception $previous The previous exception used for the exception chaining.
+     */
+    public function __construct($statusCode, $message = null, $code = 0, \Exception $previous = null)
+    {
+        $this->statusCode = $statusCode;
+        if(!$message){
+            $message = Response::$_phrases[$statusCode] ?? '';
+        }
+        
+        parent::__construct($message, $code, $previous);
+    }
+
+    public function render(Request $request, \Throwable $exception): Response
+    {
+        /** @var ValidationException $exception */
+        $message = $exception->validator->errors()->first();
+        if (!$request->expectsJson()) {
+            return new Response($exception->statusCode, [], $message);
+        }
+
+        $jsonMessage = ['code' => $exception->code ?: $exception->statusCode, 'message' => $message, 'success' => false, 'data' => []];
+        return new Response(
+            $exception->statusCode,
+            ['Content-Type' => 'application/json'],
+            json_encode($jsonMessage, JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES)
+        );
+    }
+
+}

src/Exception/MethodNotAllowedHttpException.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Jnewer\ExceptionHandler\Exception;
+
+/**
+ * MethodNotAllowedHttpException represents a "Method Not Allowed" HTTP exception with status code 405.
+ *
+ * @see https://tools.ietf.org/html/rfc7231#section-6.5.5
+ * @author Jnewer <jeekang@qq.com>
+ */
+class MethodNotAllowedHttpException extends HttpException{
+    /**
+     * Constructor.
+     * @param string $message error message
+     * @param int $code error code
+     * @param \Exception $previous The previous exception used for the exception chaining.
+     */
+    public function __construct($message = null, $code = 0, \Exception $previous = null)
+    {
+        parent::__construct(405, $message, $code, $previous);
+    }
+}

src/Exception/NotAcceptableHttpException.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Jnewer\ExceptionHandler\Exception;
+
+/**
+ * NotAcceptableHttpException represents a "Not Acceptable" HTTP exception with status code 406.
+ *
+ * Use this exception when the client requests a Content-Type that your
+ * application cannot return. Note that, according to the HTTP 1.1 specification,
+ * you are not required to respond with this status code in this situation.
+ *
+ * @see https://tools.ietf.org/html/rfc7231#section-6.5.6
+ * @author Jnewer <jeekang@qq.com>
+ */
+class NotAcceptableHttpException extends HttpException{
+    /**
+     * Constructor.
+     * @param string $message error message
+     * @param int $code error code
+     * @param \Exception $previous The previous exception used for the exception chaining.
+     */
+    public function __construct($message = null, $code = 0, \Exception $previous = null)
+    {
+        parent::__construct(406, $message, $code, $previous);
+    }
+}

src/Exception/NotFoundHttpException.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Jnewer\ExceptionHandler\Exception;
+
+/**
+ * NotFoundHttpException represents a "Not Found" HTTP exception with status code 404.
+ *
+ * @see https://tools.ietf.org/html/rfc7231#section-6.5.4
+ * @author Jnewer <jeekang@qq.com>
+ */
+class NotFoundHttpException extends HttpException{
+    /**
+     * Constructor.
+     * @param string $message error message
+     * @param int $code error code
+     * @param \Exception $previous The previous exception used for the exception chaining.
+     */
+    public function __construct($message = null, $code = 0, \Exception $previous = null)
+    {
+        parent::__construct(404, $message, $code, $previous);
+    }
+}

src/Exception/ServerErrorHttpException.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Jnewer\ExceptionHandler\Exception;
+
+/**
+ * ServerErrorHttpException represents an "Internal Server Error" HTTP exception with status code 500.
+ *
+ * @see https://tools.ietf.org/html/rfc7231#section-6.6.1
+ * @author Jnewer <jeekang@qq.com>
+ */
+class ServerErrorHttpException extends HttpException{
+    /**
+     * Constructor.
+     * @param string $message error message
+     * @param int $code error code
+     * @param \Exception $previous The previous exception used for the exception chaining.
+     */
+    public function __construct($message = null, $code = 0, \Exception $previous = null)
+    {
+        parent::__construct(500, $message, $code, $previous);
+    }
+}