mirror of
https://github.com/yiisoft/yii2.git
synced 2025-11-03 22:32:40 +08:00
new transltion chinese
This commit is contained in:
Funson Lee
@ -1,33 +1,20 @@
|
||||
Handling Errors
|
||||
错误处理
|
||||
===============
|
||||
|
||||
Yii includes a built-in [[yii\web\ErrorHandler|error handler]] which makes error handling a much more pleasant
|
||||
experience than before. In particular, the Yii error handler does the followings to improve error handling:
|
||||
Yii 内置了一个[[yii\web\ErrorHandler|error handler]]错误处理器，它使错误处理更方便，
|
||||
Yii错误处理器做以下工作来提升错误处理效果：
|
||||
|
||||
* All non-fatal PHP errors (e.g. warnings, notices) are converted into catchable exceptions.
|
||||
* Exceptions and fatal PHP errors are displayed with detailed call stack information and source code lines
|
||||
in debug mode.
|
||||
* Support using a dedicated [controller action](structure-actions.md) to display errors.
|
||||
* Support different error response formats.
|
||||
* 所有非致命PHP错误（如，警告，提示）会转换成可获取异常；
|
||||
* 异常和致命的PHP错误会被显示，在调试模式会显示详细的函数调用栈和源代码行数。
|
||||
* 支持使用专用的 [控制器操作](structure-actions.md) 来显示错误；
|
||||
* 支持不同的错误响应格式；
|
||||
|
||||
The [[yii\web\ErrorHandler|error handler]] is enabled by default. You may disable it by defining the constant
|
||||
`YII_ENABLE_ERROR_HANDLER` to be false in the [entry script](structure-entry-scripts.md) of your application.
|
||||
[[yii\web\ErrorHandler|error handler]] 错误处理器默认启用，
|
||||
可通过在应用的[入口脚本](structure-entry-scripts.md)中定义常量`YII_ENABLE_ERROR_HANDLER`来禁用。
|
||||
|
||||
|
||||
## Using Error Handler <a name="using-error-handler"></a>
|
||||
## 使用错误处理器 <a name="using-error-handler"></a>
|
||||
|
||||
The [[yii\web\ErrorHandler|error handler]] is registered as an [application component](structure-application-components.md) named `errorHandler`.
|
||||
You may configure it in the application configuration like the following:
|
||||
[[yii\web\ErrorHandler|error handler]] 注册成一个名称为`errorHandler`[应用组件](structure-application-components.md)，
|
||||
可以在应用配置中配置它类似如下：
|
||||
|
||||
@ -41,11 +28,8 @@ return [
|
||||
];
|
||||
```
|
||||
|
||||
With the above configuration, the number of source code lines to be displayed in exception pages will be up to 20.
|
||||
使用如上代码，异常页面最多显示20条源代码。
|
||||
|
||||
As aforementioned, the error handler turns all non-fatal PHP errors into catchable exceptions. This means you can
|
||||
use the following code to deal with PHP errors:
|
||||
如前所述，错误处理器将所有非致命PHP错误转换成可获取异常，也就是说可以使用如下代码处理PHP错误：
|
||||
|
||||
```php
|
||||
@ -61,10 +45,6 @@ try {
|
||||
// execution continues...
|
||||
```
|
||||
|
||||
If you want to show an error page telling the user that his request is invalid or unexpected, you may simply
|
||||
throw an [[yii\web\HttpException|HTTP exception]], such as [[yii\web\NotFoundHttpException]]. The error handler
|
||||
will correctly set the HTTP status code of the response and use an appropriate error view to display the error
|
||||
message.
|
||||
如果你想显示一个错误页面告诉用户请求是无效的或无法处理的，可简单地抛出一个 [[yii\web\HttpException|HTTP exception]]异常，
|
||||
如 [[yii\web\NotFoundHttpException]]。错误处理器会正确地设置响应的HTTP状态码并使用合适的错误视图页面来显示错误信息。
|
||||
|
||||
@ -75,45 +55,27 @@ throw new NotFoundHttpException();
|
||||
```
|
||||
|
||||
|
||||
## Customizing Error Display <a name="customizing-error-display"></a>
|
||||
## 自定义错误显示 <a name="customizing-error-display"></a>
|
||||
|
||||
The [[yii\web\ErrorHandler|error handler]] adjusts error display according to the value of the constant `YII_DEBUG`.
|
||||
When `YII_DEBUG` is true (meaning in debug mode), the error handler will display exceptions with detailed call
|
||||
stack information and source code lines to help easier debugging. And when `YII_DEBUG` is false, only the error
|
||||
message will be displayed to prevent from revealing sensitive information of the application.
|
||||
[[yii\web\ErrorHandler|error handler]]错误处理器根据常量`YII_DEBUG`的值来调整错误显示，
|
||||
当`YII_DEBUG` 为 true (表示在调试模式)，错误处理器会显示异常以及详细的函数调用栈和源代码行数来帮助调试，
|
||||
当`YII_DEBUG` 为 false，只有错误信息会被显示以防止应用的敏感信息泄漏。
|
||||
|
||||
> Info: If an exception is a descendant of [[yii\base\UserException]], no call stack will be displayed regardless
|
||||
the value of `YII_DEBUG`. This is because such exceptions are considered to be caused by user mistakes and the
|
||||
developers do not need to fix anything.
|
||||
> 补充: 如果异常是继承 [[yii\base\UserException]]，不管`YII_DEBUG`为何值，函数调用栈信息都不会显示，
|
||||
这是因为这种错误会被认为是用户产生的错误，开发人员不需要去修正。
|
||||
|
||||
By default, the [[yii\web\ErrorHandler|error handler]] displays errors using two [views](structure-views.md):
|
||||
[[yii\web\ErrorHandler|error handler]] 错误处理器默认使用两个[视图](structure-views.md)显示错误:
|
||||
|
||||
* `@yii/views/errorHandler/error.php`: used when errors should be displayed WITHOUT call stack information.
|
||||
When `YII_DEBUG` is false, this is the only error view to be displayed.
|
||||
* `@yii/views/errorHandler/exception.php`: used when errors should be displayed WITH call stack information.
|
||||
* `@yii/views/errorHandler/error.php`: 显示不包含函数调用栈信息的错误信息是使用，
|
||||
当`YII_DEBUG` 为 false时，所有错误都使用该视图。
|
||||
* `@yii/views/errorHandler/exception.php`: 显示包含函数调用栈信息的错误信息时使用。
|
||||
|
||||
You can configure the [[yii\web\ErrorHandler::errorView|errorView]] and [[yii\web\ErrorHandler::exceptionView|exceptionView]]
|
||||
properties of the error handler to use your own views to customize the error display.
|
||||
可以配置错误处理器的 [[yii\web\ErrorHandler::errorView|errorView]] 和 [[yii\web\ErrorHandler::exceptionView|exceptionView]] 属性
|
||||
使用自定义的错误显示视图。
|
||||
|
||||
|
||||
### Using Error Actions <a name="using-error-actions"></a>
|
||||
### 使用错误操作 <a name="using-error-actions"></a>
|
||||
|
||||
A better way of customizing the error display is to use dedicated error [actions](structure-controllers.md).
|
||||
To do so, first configure the [[yii\web\ErrorHandler::errorAction|errorAction]] property of the `errorHandler`
|
||||
component like the following:
|
||||
使用指定的错误[操作](structure-controllers.md) 来自定义错误显示更方便，
|
||||
为此，首先配置`errorHandler`组件的 [[yii\web\ErrorHandler::errorAction|errorAction]] 属性，类似如下：
|
||||
|
||||
@ -127,13 +89,9 @@ return [
|
||||
];
|
||||
```
|
||||
|
||||
The [[yii\web\ErrorHandler::errorAction|errorAction]] property takes a [route](structure-controllers.md#routes)
|
||||
to an action. The above configuration states that when an error needs to be displayed without call stack information,
|
||||
the `site/error` action should be executed.
|
||||
[[yii\web\ErrorHandler::errorAction|errorAction]] 属性使用[路由](structure-controllers.md#routes)到一个操作，
|
||||
上述配置表示不用显示函数调用栈信息的错误会通过执行`site/error`操作来显示。
|
||||
|
||||
You can create the `site/error` action as follows,
|
||||
可以创建`site/error` 操作如下所示：
|
||||
|
||||
```php
|
||||
@ -155,11 +113,8 @@ class SiteController extends Controller
|
||||
}
|
||||
```
|
||||
|
||||
The above code defines the `error` action using the [[yii\web\ErrorAction]] class which renders an error
|
||||
using a view named `error`.
|
||||
上述代码定义`error` 操作使用[[yii\web\ErrorAction]] 类，该类渲染名为`error`视图来显示错误。
|
||||
|
||||
Besides using [[yii\web\ErrorAction]], you may also define the `error` action using an action method like the following,
|
||||
除了使用[[yii\web\ErrorAction]], 可定义`error` 操作使用类似如下的操作方法：
|
||||
|
||||
```php
|
||||
@ -172,34 +127,19 @@ public function actionError()
|
||||
}
|
||||
```
|
||||
|
||||
You should now create a view file located at `views/site/error.php`. In this view file, you can access
|
||||
the following variables if the error action is defined as [[yii\web\ErrorAction]]:
|
||||
现在应创建一个视图文件为`views/site/error.php`，在该视图文件中，如果错误操作定义为[[yii\web\ErrorAction]]，
|
||||
可以访问该操作中定义的如下变量：
|
||||
|
||||
* `name`: the name of the error;
|
||||
* `message`: the error message;
|
||||
* `exception`: the exception object through which you can more useful information, such as HTTP status code,
|
||||
error code, error call stack, etc.
|
||||
* `name`: 错误名称
|
||||
* `message`: 错误信息
|
||||
* `exception`: 更多详细信息的异常对象，如HTTP 状态码，错误码，错误调用栈等。
|
||||
|
||||
> Info: If you are using the [basic application template](start-installation.md) or the [advanced application template](tutorial-advanced-app.md),
|
||||
the error action and the error view are already defined for you.
|
||||
> 补充: 如果你使用 [基础应用模板](start-installation.md) 或 [高级应用模板](tutorial-advanced-app.md),
|
||||
错误操作和错误视图已经定义好了。
|
||||
|
||||
|
||||
### Customizing Error Response Format <a name="error-format"></a>
|
||||
### 自定义错误格式 <a name="error-format"></a>
|
||||
|
||||
The error handler displays errors according to the format setting of the [response](runtime-responses.md).
|
||||
If the the [[yii\web\Response::format|response format]] is `html`, it will use the error or exception view
|
||||
to display errors, as described in the last subsection. For other response formats, the error handler will
|
||||
assign the array representation of the exception to the [[yii\web\Response::data]] property which will then
|
||||
be converted to different formats accordingly. For example, if the response format is `json`, you may see
|
||||
the following response:
|
||||
错误处理器根据[响应](runtime-responses.md)设置的格式来显示错误，
|
||||
如果[[yii\web\Response::format|response format]] 响应格式为`html`, 会使用错误或异常视图来显示错误信息，如上一小节所述。
|
||||
对于其他的响应格式，错误处理器会错误信息作为数组赋值给[[yii\web\Response::data]]属性，然后转换到对应的格式，
|
||||
@ -220,8 +160,6 @@ Content-Type: application/json; charset=UTF-8
|
||||
}
|
||||
```
|
||||
|
||||
You may customize the error response format by responding to the `beforeSend` event of the `response` component
|
||||
in the application configuration:
|
||||
可在应用配置中响应`response`组件的`beforeSend`事件来自定义错误响应格式。
|
||||
|
||||
```php
|
||||
@ -245,7 +183,6 @@ return [
|
||||
];
|
||||
```
|
||||
|
||||
The above code will reformat the error response like the following:
|
||||
上述代码会重新格式化错误响应，类似如下：
|
||||
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user