Yii Framework Official Guide Series 46 - Sujet spécial : Gestion des erreurs

Yii fournit un mécanisme complet de gestion des erreurs basé sur la gestion des exceptions PHP5. Lorsqu'une application démarre et gère les requêtes des utilisateurs, la méthode handleError est enregistrée pour gérer les avertissements et les informations PHP ; la méthode handleException est également enregistrée pour gérer les exceptions PHP non interceptées. Par conséquent, si un avertissement/avis PHP ou une exception PHP non interceptée se produit pendant l'exécution de l'application, le gestionnaire d'erreurs prendra le contrôle et exécutera les mécanismes de gestion nécessaires.

Conseils : Le gestionnaire d'erreurs est enregistré dans la méthode constructeur de l'application, à l'aide des fonctions PHP set_exception_handler et set_error_handler. Si vous ne voulez pas que Yii gère les erreurs et les exceptions, vous pouvez définir YII_ENABLE_ERROR_HANDLER et YII_ENABLE_EXCEPTION_HANDLER comme false dans le fichier d'entrée

Par défaut, l'événement onError (ou onException). est déclenché, errorHandler (ou exceptionHandler) sera déclenché. Si l'erreur ou l'exception n'est gérée par aucun événement, vous devez alors exécuter le composant errorHandler pour la gérer.

1. Déclencher des exceptions

Déclencher des exceptions dans Yii est la même que dans les fichiers PHP ordinaires. Vous pouvez utiliser le code suivant pour lever une exception :

throw new ExceptionClass('错误信息');

Yii définit deux classes d'exception : CException et CHttpException . La première est une classe d’exception générale, tandis que la seconde est utilisée pour afficher des informations sur les exceptions aux utilisateurs finaux. En parallèle, ce dernier dispose d’un attribut statusCode pour représenter le code d’état HTTP. Le type d'exception détermine l'effet d'affichage, qui sera discuté en détail ci-dessous.

Astuce : Si vous souhaitez indiquer à l'utilisateur qu'une certaine opération est erronée, lancer une CHttpException est le moyen le plus simple. Par exemple, si l'utilisateur fournit une valeur d'ID invalide dans l'URL, nous pouvons afficher une erreur 404 :

// 如果提交的ID是无效的
throw new CHttpException(404,'此页面不存在');

2. Afficher les erreurs

Lorsqu'une erreur est transmise au composant CErrorHandler, il sélectionnera la vue appropriée pour afficher l'erreur. Si l'erreur doit être affichée à l'utilisateur final (comme une CHttpException), alors une vue nommée errorXXX sera utilisée pour afficher l'erreur. Ce XXX représente un code d'erreur HTTP (tel que 400, 404, 500, etc.). S'il s'agit d'une erreur interne qui ne doit être visible que par les développeurs, le nom de la vue qui sera utilisé est exception. Dans ce dernier cas, les informations complètes sur la pile d'appels et les informations sur la ligne d'erreur seront affichées.

Informations : Lorsque l'application s'exécute en mode production, toutes les erreurs, y compris les erreurs internes, utiliseront la vue errorXXX. En effet, les informations sur la pile d'appels et les informations sur la ligne d'erreur peuvent contenir des informations sensibles. Dans ce cas, les développeurs doivent s'appuyer sur les journaux d'erreurs pour déterminer la cause de l'erreur.

CErrorHandler recherchera la vue appropriée pour afficher le message d'erreur. L'ordre de recherche est le suivant :

1. WebRoot/themes/ThemeName/views/system : system sous le. vue actuelle du thème dans le répertoire.

2. WebRoot/protected/views/system : Dans le répertoire system de la vue par défaut de l'application.

3. yii/framework/views : Dans le répertoire de vue standard fourni par Yii.

Par conséquent, si vous souhaitez personnaliser l'affichage des erreurs, vous pouvez créer un fichier de vue directement dans le répertoire de vue system ou dans le répertoire de vue system du thème. Chaque fichier de vue est un fichier PHP standard contenant beaucoup de code HTML. Reportez-vous aux fichiers du répertoire view du framework pour plus d'informations.

3. Utilisez une action pour gérer les erreurs

Yii peut également utiliser les actions du contrôleur pour gérer l'affichage des erreurs. Ceci est accompli en configurant un gestionnaire d'erreurs dans le fichier de configuration de l'application.

return array(
    ......
    'components'=>array(
        'errorHandler'=>array(
            'errorAction'=>'site/error',
        ),
    ),
);

Dans le code ci-dessus, nous configurons l'attribut CErrorHandler::errorAction, et la valeur de l'attribut est un itinérairesite/error. Cet itinéraire pointe vers SiteController dans error. Bien entendu, vous pouvez également emprunter d’autres itinéraires.

On peut écrire l'action error comme ceci :

public function actionError()
{
    if($error=Yii::app()->errorHandler->error)
        $this->render('error', $error);
}

Dans cette action , obtenez d’abord des informations détaillées sur l’erreur auprès de CErrorHandler::error. Si les informations obtenues ne sont pas vides, utilisez les informations renvoyées par CErrorHandler::error pour restituer la vue error. Les informations renvoyées par CErrorHandler::error sont un tableau avec la structure suivante :

• code : code d'état HTTP (tel que 403, 500) ; 🎜>

 : type d'erreur (tel que CHttpException,
• ) ;

  typePHP Error

 : message d'erreur

• message

: Le nom du fichier PHP où l'erreur s'est produite

• file

: La ligne où l'erreur s'est produite ; 🎜>
•  : La mauvaise pile d'appels Informations

  line

•  : Le contexte du code où l'erreur s'est produite.

Astuce : La raison pour laquelle nous vérifions si CErrorHandler::error est vide est que l'action error est accessible à l'utilisateur, et il se peut qu'elle ne soit pas accessible. il n'y aura aucune erreur à ce moment. Lorsque nous transmettons le tableau $error à la vue, il sera automatiquement libéré en tant que variable indépendante. Ainsi, dans la vue, nous pouvons utiliser $code, $type pour accéder à ces informations.

4. Enregistrement des messages

Un message d'erreur de niveau error sera enregistré lorsqu'une erreur se produit. Si l'erreur est provoquée par un avertissement ou un avis PHP, le message sera enregistré dans la catégorie php ; si le message d'erreur est provoqué par une exception non interceptée, la catégorie sera exception.ExceptionClassName (pour CHttpException par exemple, son statusCode sera également ajouté au nom de la catégorie). Les développeurs peuvent utiliser ces enregistrements pour surveiller les messages d'erreur pendant l'exécution de l'application

Ce qui précède est la série 46 du guide officiel du Yii Framework - Sujet spécial : gestion des erreurs. Pour plus de contenu connexe, veuillez prêter attention au site Web chinois PHP (www. php.cn) !