Yii 错误处理
Yii包含一个内置的错误处理程序。Yii错误处理程序执行以下操作:
- 将所有非严重的PHP错误转换为可捕获的异常。
- 显示所有错误和异常,并提供详细的调用堆栈。
- 支持不同的错误格式。
- 支持使用一个控制器操作来显示错误。
要禁用错误处理程序,您应该在入口脚本中将YII_ENABLE_ERROR_HANDLER常量定义为false。错误处理程序被注册为应用组件。
步骤1 - 您可以按以下方式进行配置。
return [
'components' => [
'errorHandler' => [
'maxSourceLines' => 10,
],
],
];
上述配置设置要显示的源代码行数为10。错误处理器将所有非致命的PHP错误转换为可捕获的异常。
步骤2 - 添加一个名为 actionShowError() 的新函数到SiteController。
public function actionShowError() {
try {
5/0;
} catch (ErrorException $e) {
Yii::warning("Ooops...division by zero.");
}
// execution continues...
}
步骤3 − 前往网址 http://localhost:8080/index.php?r=site/show-error ,您将看到一个警告信息。
如果你想让用户知道他的请求无效,可以抛出yii\web\NotFoundHttpException。
步骤 4 − 修改actionShowError()函数。
public function actionShowError() {
throw new NotFoundHttpException("Something unexpected happened");
}
步骤5 - 在地址栏中输入地址 http://localhost:8080/index.php?r=site/show-error 。你将会看到以下HTTP错误。
当 YII_DEBUG 常量为 true 时,错误处理程序将显示带有详细调用栈的错误信息。当常量为 false 时,只会显示错误消息。默认情况下,错误处理程序使用以下视图显示错误:
- @yii/views/errorHandler/exception.php - 在错误应该显示调用栈信息时使用的视图文件。
-
@yii/views/errorHandler/error.php - 在错误不应显示调用栈信息时使用的视图文件。
您可以使用专用的错误操作来自定义错误显示。
步骤6 - 修改 config/web.php 文件中的 errorHandler 应用程序组件。
<?php
params = require(__DIR__ . '/params.php');config = [
'id' => 'basic',
'basePath' => dirname(__DIR__),
'bootstrap' => ['log'],
'components' => [
'request' => [
// !!! insert a secret key in the following (if it is empty) - this
//is required by cookie validation
'cookieValidationKey' => 'ymoaYrebZHa8gURuolioHGlK8fLXCKjO',
],
'cache' => [
'class' => 'yii\caching\FileCache',
],
'user' => [
'identityClass' => 'app\models\User',
'enableAutoLogin' => true,
],
**'errorHandler' = > [
'errorAction' => 'site/error',
],**
//other components...
'db' => require(__DIR__ . '/db.php'),
],
'modules' => [
'hello' => [
'class' => 'app\modules\hello\Hello',
],
],
'params' => params,
];
if (YII_ENV_DEV) {
// configuration adjustments for 'dev' environmentconfig['bootstrap'][] = 'debug';
config['modules']['debug'] = [
'class' => 'yii\debug\Module',
];config['bootstrap'][] = 'gii';
config['modules']['gii'] = [
'class' => 'yii\gii\Module',
];
}
returnconfig;
?>
上述配置表示当需要显示一个不含调用堆栈的错误时,将执行 site/error 操作。
步骤7 - 修改 SiteController 的 actions() 方法。
public function actions() {
return [
'error' => [
'class' => 'yii\web\ErrorAction',
],
];
}
上述代码定义了当发生错误时,将渲染错误视图。
步骤8 - 在views/site目录下创建一个名为 error.php 的文件。
<?php
/* @var this yii\web\View */
/* @varname string */
/* @var message string */
/* @varexception Exception */
use yii\helpers\Html;
this->title =name;
?>
<div class = "site-error">
<h2>customized error</h2>
<h1><?= Html::encode(this->title) ?></h1>
<div class = "alert alert-danger">
<?= nl2br(Html::encode(message)) ?>
</div>
<p>
The above error occurred while the Web server was processing your request.
</p>
<p>
Please contact us if you think this is a server error. Thank you.
</p>
</div>
步骤9 - 前往地址 http://localhost:8080/index.php?r=site/show-error ,您将看到自定义错误页面。