Gestion des erreurs et des exceptions dans le framework Yii : un guide complet

Présentation

Dans le didacticiel d'aujourd'hui, je vais vous présenter la gestion des erreurs et des exceptions de Yii et vous guider à travers quelques scénarios d'introduction.

Vous voulez savoir ce qu'est Yii ? Consultez nos séries Introduction au framework Yii et à la programmation Yii2.

Quelle est la différence entre les erreurs et les exceptions ?

Les bugs sont des failles inattendues dans notre code, souvent découvertes en premier par les utilisateurs. Ils interrompent généralement l'exécution du programme. Il est important non seulement d'interrompre le processus en douceur pour l'utilisateur, mais également d'informer le développeur du problème afin qu'il puisse être résolu.

Les développeurs créent des exceptions lorsque des conditions d'erreur potentiellement prévisibles se produisent. Dans le code où des exceptions peuvent se produire, les développeurs peuvent lancer des exceptions() vers des gestionnaires d'erreurs robustes.

Comment Yii gère-t-il cela ?

Dans Yii, les erreurs PHP non fatales (telles que les avertissements et les notifications) sont acheminées vers des exceptions capturables afin que vous puissiez décider comment réagir et y répondre. Vous pouvez spécifier une action de contrôleur pour gérer toutes ces exceptions. Vous pouvez également personnaliser le format d'affichage des erreurs, tel que HTML, JSON, XML, etc.

Les exceptions et erreurs PHP fatales ne peuvent être évaluées qu'en mode débogage. Dans ces types de scénarios de développement, Yii peut afficher des informations détaillées sur la pile d'appels et des extraits de code source (vous pouvez le voir dans l'image d'en-tête ci-dessus) .

Les erreurs fatales sont le type d'événements qui interrompent l'exécution d'une application. Il s'agit notamment du manque de mémoire, de l'instanciation d'un objet d'une classe inexistante ou de l'appel d'une fonction inexistante.

Par exemple :

$t = new Unknownobject();

Commençons par examiner quelques exemples de gestion des erreurs et des exceptions.

Erreur de configuration et gestion des exceptions

Tout d'abord, nous configurons notre application dans frontend/config/main.php. errorHandler est défini comme un composant comme indiqué ci-dessous. Cet exemple provient de ma série d'applications de démarrage, Meeting Planner. Veuillez noter la configuration dans errorHandler 在 components :

<?php
$params = array_merge(
    require(__DIR__ . '/params.php'),
    require(__DIR__ . '/params-local.php')
);
return [
    'id' => 'mp-frontend',
    'name' => 'Meeting Planner',
    'basePath' => dirname(__DIR__),
    'bootstrap' => ['log','\common\components\SiteHelper'],
    'controllerNamespace' => 'frontend\controllers',
    'catchAll'=> [],
    'components' => [
      'assetManager' => [...],
      ...
      'errorHandler' => [
            'errorAction' => 'site/error',
            'maxSourceLines' => 20,
        ],
        ...
    ],
];

Dans l'exemple ci-dessus, errorAction dirige l'utilisateur vers la mauvaise action de mon SiteController.

Plus largement, Yii propose errorHandler une variété d'options de configuration pour la redirection et la collecte de données :

Propriétés	Type	Description
$callStackItemView	Chaîne	Chemin d'accès au fichier de vue utilisé pour restituer les éléments de la pile d'appels d'exception et d'erreur. Par exemple '@yii/views/errorHandler/callStackItem.php'
$displayVars	Tableau	Liste des variables prédéfinies PHP qui doivent être affichées sur les pages d'erreur. Par exemple ['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION']
$errorAction	Chaîne	Route pour les actions du contrôleur qui affichent des erreurs externes (par exemple site/error).
$errorView	Chaîne	Chemin d'accès au fichier de vue utilisé pour restituer les exceptions sans informations sur la pile d'appels. Par exemple '@yii/views/errorHandler/error.php'
$Vue d'exception	Chaîne	Le chemin d'accès au fichier de vue qui restitue l'exception. Par exemple '@yii/views/errorHandler/exception.php'
$maxSourceLines	entier	Nombre maximum de lignes de code source à afficher.
$maxTraceSourceLines	entier	Nombre maximum de lignes sources de trace à afficher.
$previousExceptionView	Chaîne	Chemin d'accès au fichier de vue utilisé pour restituer l'exception précédente. Par exemple '@yii/views/errorHandler/previousException.php'

使用 errorActions 直接执行

通常，当用户遇到严重错误时，我们希望将他们重定向到友好的、描述性的错误页面。

这就是 errorHandler 中的 errorAction 的作用。它重定向到我们的 SiteController 的 actionError:

return [
    'components' => [
        'errorHandler' => [
            'errorAction' => 'site/error',
        ],
    ]
];

在我们的 SiteController 中，我们定义了一个显式的 error 操作：

namespace app\controllers;

use Yii;
use yii\web\Controller;

class SiteController extends Controller
{
    public function actions()
    {
        return [
            'error' => [
                'class' => 'yii\web\ErrorAction',
            ],
        ];
    }
}

这是一个基本的错误处理程序（您可以在此处阅读有关这些内容的更多信息）：

public function actionError()
{
    $exception = Yii::$app->errorHandler->exception;
    if ($exception !== null) {
        return $this->render('error', ['exception' => $exception]);
    }
}

无论是否存在错误或页面请求是否在您的应用程序中不存在，您也可以做出不同的响应：

public function actionError()
    {
        $exception = Yii::$app->errorHandler->exception;
        if ($exception instanceof \yii\web\NotFoundHttpException) {
            // all non existing controllers+actions will end up here
            return $this->render('pnf'); // page not found
        } else {
          return $this->render('error', ['exception' => $exception]);
        }
    }

这是我当前的 Page Not Found 404 错误处理程序：

理论上，您可以包含链接的站点地图、与页面请求类似的建议页面、搜索功能和联系支持错误页面上的链接。所有这些都可以帮助用户恢复并优雅地继续前进。

这是我当前的一般错误页面（显然我需要添加功能）：

捕获异常

如果我们想要监视一段代码是否存在问题，我们可以使用 PHP try catch 块。下面，我们将通过触发致命除以零错误进行实验：

use Yii;
use yii\base\ErrorException;

...

    try {
        10/0;
    } catch (ErrorException $e) {
        Yii::warning("Division by zero.");
    }
    
...

上面的 catch 响应是为日志生成警告。 Yii 有广泛的日志记录：

• Yii::trace()：记录一条消息以跟踪一段代码的运行情况。主要用于开发。
• Yii::info()：记录一条消息，传达有关事件的信息。
• Yii::warning()：记录发生意外事件的警告消息
• Yii::error()：记录一个致命错误以供调查

如果您希望将用户定向到我们之前配置的错误页面，而不是记录事件，则可以通过事件抛出异常：

use yii\web\NotFoundHttpException;

throw new NotFoundHttpException();

下面是我们抛出带有特定 HTTP 状态代码和自定义消息的异常的示例：

  try {
          10/0;
      } catch (ErrorException $e) {
        throw new \yii\web\HttpException(451,
            'Tom McFarlin\'s humor is often lost on me
                (and lots of people).');
    }

对于用户来说，该代码如下所示：

关于 Yii 日志记录

Yii 中的所有错误都会根据您的设置方式进行记录。您可能还对我有关用于登录 Yii 的 Sentry 和 Rollbar 的教程感兴趣：

• 

  构建您的初创公司：错误日志

  如果没有正确的错误处理或基于云的日志服务，查找生产错误可能会很困难。我尝试了两个。跟随并了解如何记录...
  

Yii

结束时

我希望您喜欢我们对错误和异常处理的探索。请关注我们的“使用 Yii2 编程”系列中即将推出的教程，我们将继续深入探讨该框架的不同方面。

如果您想更深入地了解 Yii 应用程序开发，请查看我们的使用 PHP 构建您的初创公司系列，该系列使用 Yii2 的高级模板。它讲述了对 Meeting Planner 的每个步骤进行编程的故事。如果您想从头开始学习如何在 Yii 中构建应用程序，它会非常有用。

如果您想知道下一个 Yii2 教程何时发布，请在 Twitter 上关注我@lookahead_io 或查看我的讲师页面。

相关链接

• yii\web\ErrorHandler 文档
• 处理错误（Yii 2.0 权威指南）
• 日志记录（Yii 2.0 权威指南）
• Yii2 Developer Exchange（作者的资源网站）

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!