Yii - 错误处理

简述

Yii 包含一个内置的错误处理程序。Yii 错误处理程序执行以下操作 -

将所有非致命的 PHP 错误转换为可捕获的异常。
使用详细的调用堆栈显示所有错误和异常。
支持不同的错误格式。
支持使用控制器操作来显示错误。

要禁用错误处理程序，您应该在入口脚本中将 YII_ENABLE_ERROR_HANDLER 常量定义为 false。错误处理程序注册为应用程序组件。

第 1 步 - 您可以通过以下方式配置它。


return [
   'components' => [
      'errorHandler' => [
         'maxSourceLines' => 10,
      ],
   ],
];

上述配置将要显示的源代码行数设置为 10。错误处理程序将所有非致命 PHP 错误转换为可捕获的异常。

第 2 步- 向 SiteController 添加一个名为actionShowError()的新函数。


public function actionShowError() {
   try {
      5/0;
   } catch (ErrorException $e) {
      Yii::warning("Ooops...division by zero.");
   }
   // execution continues...
}

第 3 步- 转到 URL 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 常量为真时，错误处理程序将显示带有详细调用堆栈的错误。当常量为 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' environment
      $config['bootstrap'][] = 'debug';
      $config['modules']['debug'] = [
         'class' => 'yii\debug\Module',
      ];
      $config['bootstrap'][] = 'gii';
      $config['modules']['gii'] = [
         'class' => 'yii\gii\Module',
      ];
   }
   return $config;
?>

上面的配置定义了当需要在没有调用栈的情况下显示错误时，会执行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 */
   /* @var $name string */
   /* @var $message string */
   /* @var $exception 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，您将看到自定义的错误视图。