PHPackages                             php-woox/webman-exception - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. php-woox/webman-exception

ActiveLibrary[Utility & Helpers](/categories/utility)

php-woox/webman-exception
=========================

webman exception handler plugin

v0.0.1(2y ago)06MITPHPPHP >=8.2

Since May 11Pushed 1y ago1 watchersCompare

[ Source](https://github.com/php-woox/webman-exception)[ Packagist](https://packagist.org/packages/php-woox/webman-exception)[ RSS](/packages/php-woox-webman-exception/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (7)Versions (2)Used By (0)

php-woox/webman-exception
=========================

[](#php-wooxwebman-exception)

安装
--

[](#安装)

```
composer require php-woox/webman-exception
```

配置
--

[](#配置)

`config/exception.php`

```
return [
    // 这里配置异常处理类
    '' => \Woox\WebmanException\Handler::class,
];
```

> 多应用模式时，你可以为每个应用单独配置异常处理类，参见[多应用](https://www.workerman.net/doc/webman/multiapp.html)

基本用法
----

[](#基本用法)

请求参数错误

```
use support\Request;
use support\Response;
use Woox\WebmanException\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...{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`（表示：请求行中指定的请求方法不能被用于请求相应的资源）

自定义异常类只需要继承`Woox\WebmanException\Exception\BaseException`类即可

```