mirror of
https://github.com/yiisoft/yii2.git
synced 2025-08-15 06:40:59 +08:00
96 lines
3.5 KiB
Markdown
96 lines
3.5 KiB
Markdown
错误处理
|
||
==============
|
||
|
||
处理一个 RESTful API 请求时， 如果有一个用户请求错误或服务器发生意外时，
|
||
你可以简单地抛出一个异常来通知用户出错了。
|
||
如果你能找出错误的原因 (例如，所请求的资源不存在)，你应该
|
||
考虑抛出一个适当的HTTP状态代码的异常
|
||
(例如， [[yii\web\NotFoundHttpException]]意味着一个404 HTTP状态代码)。
|
||
Yii 将通过HTTP状态码和文本发送相应的响应。
|
||
它还将包括在响应主体异常的序列化表示形式。
|
||
例如，
|
||
|
||
```
|
||
HTTP/1.1 404 Not Found
|
||
Date: Sun, 02 Mar 2014 05:31:43 GMT
|
||
Server: Apache/2.2.26 (Unix) DAV/2 PHP/5.4.20 mod_ssl/2.2.26 OpenSSL/0.9.8y
|
||
Transfer-Encoding: chunked
|
||
Content-Type: application/json; charset=UTF-8
|
||
|
||
{
|
||
"name": "Not Found Exception",
|
||
"message": "The requested resource was not found.",
|
||
"code": 0,
|
||
"status": 404
|
||
}
|
||
```
|
||
|
||
下面的列表总结了Yii的REST框架的HTTP状态代码:
|
||
|
||
* `200`: OK。一切正常。
|
||
* `201`: 响应 `POST` 请求时成功创建一个资源。`Location` header
|
||
包含的URL指向新创建的资源。
|
||
* `204`: 该请求被成功处理，响应不包含正文内容 (类似 `DELETE` 请求)。
|
||
* `304`: 资源没有被修改。可以使用缓存的版本。
|
||
* `400`: 错误的请求。可能通过用户方面的多种原因引起的，例如在请求体内有无效的JSON
|
||
数据，无效的操作参数，等等。
|
||
* `401`: 验证失败。
|
||
* `403`: 已经经过身份验证的用户不允许访问指定的 API 末端。
|
||
* `404`: 所请求的资源不存在。
|
||
* `405`: 不被允许的方法。 请检查 `Allow` header 允许的HTTP方法。
|
||
* `415`: 不支持的媒体类型。 所请求的内容类型或版本号是无效的。
|
||
* `422`: 数据验证失败 (例如，响应一个 `POST` 请求)。 请检查响应体内详细的错误消息。
|
||
* `429`: 请求过多。 由于限速请求被拒绝。
|
||
* `500`: 内部服务器错误。 这可能是由于内部程序错误引起的。
|
||
|
||
|
||
## 自定义错误响应 <span id="customizing-error-response"></span>
|
||
|
||
有时你可能想自定义默认的错误响应格式。例如，你想一直使用HTTP状态码200，
|
||
而不是依赖于使用不同的HTTP状态来表示不同的错误，
|
||
并附上实际的HTTP状态代码为JSON结构的一部分的响应，就像以下所示，
|
||
|
||
```
|
||
HTTP/1.1 200 OK
|
||
Date: Sun, 02 Mar 2014 05:31:43 GMT
|
||
Server: Apache/2.2.26 (Unix) DAV/2 PHP/5.4.20 mod_ssl/2.2.26 OpenSSL/0.9.8y
|
||
Transfer-Encoding: chunked
|
||
Content-Type: application/json; charset=UTF-8
|
||
|
||
{
|
||
"success": false,
|
||
"data": {
|
||
"name": "Not Found Exception",
|
||
"message": "The requested resource was not found.",
|
||
"code": 0,
|
||
"status": 404
|
||
}
|
||
}
|
||
```
|
||
|
||
为了实现这一目的，你可以响应该应用程序配置的 `response` 组件的 `beforeSend` 事件：
|
||
|
||
```php
|
||
return [
|
||
// ...
|
||
'components' => [
|
||
'response' => [
|
||
'class' => 'yii\web\Response',
|
||
'on beforeSend' => function ($event) {
|
||
$response = $event->sender;
|
||
if ($response->data !== null && !empty(Yii::$app->request->get('suppress_response_code'))) {
|
||
$response->data = [
|
||
'success' => $response->isSuccessful,
|
||
'data' => $response->data,
|
||
];
|
||
$response->statusCode = 200;
|
||
}
|
||
},
|
||
],
|
||
],
|
||
];
|
||
```
|
||
|
||
当 `suppress_response_code` 作为 `GET` 参数传递时，上面的代码
|
||
将重新按照自己定义的格式响应（无论失败还是成功）。
|