Mengendalikan Ralat dan Pengecualian dalam Rangka Kerja Yii: Panduan Komprehensif-tutorial php-php.cn

处理 Yii 框架中的错误和异常：综合指南

Pengenalan

Dalam tutorial hari ini, saya akan memperkenalkan ralat dan pengendalian pengecualian Yii serta membimbing anda melalui beberapa senario pengenalan.

Nak tahu apa itu Yii? Lihat Pengenalan kami kepada Rangka Kerja Yii dan siri Pengaturcaraan Yii2.

Apakah perbezaan antara ralat dan pengecualian?

Pepijat ialah kecacatan yang tidak dijangka dalam kod kami, selalunya ditemui dahulu oleh pengguna. Mereka biasanya mengganggu pelaksanaan program. Ia penting bukan sahaja untuk memecahkan dengan anggun untuk pengguna, tetapi juga untuk memberitahu pembangun masalah itu supaya ia boleh diperbaiki.

Pembangun membuat pengecualian apabila keadaan ralat yang boleh diramal berlaku. Dalam kod di mana pengecualian mungkin berlaku, pembangun boleh membuang() pengecualian kepada pengendali ralat yang mantap.

Bagaimana Yii menguruskan perkara ini?

Dalam Yii, ralat PHP yang tidak membawa maut (seperti amaran dan pemberitahuan) dialihkan kepada pengecualian yang boleh ditangkap supaya anda boleh memutuskan cara untuk bertindak balas dan membalasnya. Anda boleh menentukan tindakan pengawal untuk mengendalikan semua pengecualian ini. Anda juga boleh menyesuaikan format paparan ralat, seperti HTML, JSON, XML, dll.

Pengecualian dan ralat PHP yang membawa maut hanya boleh dinilai dalam mod nyahpepijat. Dalam jenis senario pembangunan ini, Yii boleh memaparkan maklumat tindanan panggilan terperinci dan coretan kod sumber (anda boleh melihat ini dalam imej pengepala di atas) .

Ralat maut ialah jenis peristiwa yang mengganggu pelaksanaan aplikasi. Ini termasuk kehabisan ingatan, membuat seketika objek kelas yang tidak wujud, atau memanggil fungsi yang tidak wujud.

Contohnya:

$t = new Unknownobject();

Salin selepas log masuk

Mari kita mulakan dengan melihat beberapa contoh ralat dan pengendalian pengecualian.

Ralat konfigurasi dan pengendalian pengecualian

Pertama, kami mengkonfigurasi aplikasi kami di frontend/config/main.php. errorHandler ditakrifkan sebagai komponen seperti yang ditunjukkan di bawah. Contoh ini adalah daripada aplikasi siri permulaan saya, Perancang Mesyuarat. Sila ambil perhatian konfigurasi errorHandler dalam komponen: 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,
        ],
        ...
    ],
];

Salin selepas log masuk

在上面的示例中，errorAction 将用户定向到我的 SiteController 的错误操作。

更广泛地说，Yii 为 errorHandler 提供了多种配置选项，用于重定向和数据收集：

Dalam contoh di atas, errorAction mengarahkan pengguna kepada tindakan ralat SiteController saya. Secara lebih luas, Yii menyediakan pelbagai pilihan konfigurasi untuk errorHandler untuk pengalihan dan pengumpulan data:

属性类型描述

$callStackItemView 字符串用于渲染异常和错误调用堆栈元素的视图文件的路径。例如'@yii/views/errorHandler/callStackItem.php'

$displayVars 数组应显示在错误页面上的 PHP 预定义变量列表。例如['_GET'、'_POST'、'_FILES'、'_COOKIE'、'_SESSION']

$errorAction

字符串

用于显示外部错误的控制器操作的路由（例如 site/error

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

Salin selepas log masuk

StringSusunanStringStringString

Sifat	Jenis	Penerangan	$callStackItemView
Laluan ke fail paparan yang digunakan untuk memberikan pengecualian dan elemen timbunan panggilan ralat. Contohnya '@yii/views/errorHandler/callStackItem.php'		$displayVars
Senarai pembolehubah pratakrif PHP yang harus dipaparkan pada halaman ralat. Contohnya ['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION']		$errorAction
Laluan untuk tindakan pengawal yang memaparkan ralat luaran (cth. `tapak/ralat`).		$errorView
Laluan ke fail paparan yang digunakan untuk memberikan pengecualian tanpa maklumat timbunan panggilan. Contohnya '@yii/views/errorHandler/error.php'		$Exception view

Laluan ke fail paparan yang memberikan pengecualian. Contohnya '@yii/views/errorHandler/exception.php'🎜 🎜 🎜 🎜$maxSourceLines🎜 🎜integer🎜 🎜Bilangan maksimum baris kod sumber untuk dipaparkan. 🎜 🎜 🎜 🎜$maxTraceSourceLines🎜 🎜integer🎜 🎜Bilangan maksimum garisan sumber surih untuk dipaparkan. 🎜 🎜 🎜 🎜$previousExceptionView🎜 🎜String🎜 🎜Laluan ke fail paparan yang digunakan untuk memberikan pengecualian sebelumnya. Contohnya '@yii/views/errorHandler/previousException.php'🎜 🎜 🎜🎜

使用 errorActions 直接执行

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

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

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

Salin selepas log masuk

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

namespace app\controllers;

use Yii;
use yii\web\Controller;

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

Salin selepas log masuk

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

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

Salin selepas log masuk

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

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]);
        }
    }

Salin selepas log masuk

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

处理 Yii 框架中的错误和异常：综合指南

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

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

处理 Yii 框架中的错误和异常：综合指南

捕获异常

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

use Yii;
use yii\base\ErrorException;

...

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

Salin selepas log masuk

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

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

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

use yii\web\NotFoundHttpException;

throw new NotFoundHttpException();

Salin selepas log masuk

下面是我们抛出带有特定 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).');
    }

Salin selepas log masuk

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

处理 Yii 框架中的错误和异常：综合指南