CakePHP でカスタム例外ハンドラーを作成するにはどうすればよいですか?

CakePHP は、Web アプリケーションを迅速に構築できる人気の PHP フレームワークです。ユーザー入力の処理中やデータベース操作などのタスクの実行中に、さまざまな例外が発生する可能性があります。問題が発生したときにエラー メッセージがユーザーに直接表示されないように、例外をどのように処理できるでしょうか?ここで、カスタム例外ハンドラーが登場します。この記事では、CakePHP でカスタム例外ハンドラーを作成する方法を説明します。

なぜカスタム例外ハンドラーが必要なのでしょうか?

Web アプリケーションが例外をスローすると、CakePHP はアプリケーションに関連する標準例外エラー ページを表示します。デフォルトでは、これらのページにはスタック トレース、例外メッセージ、および存在する可能性のあるその他のコンテキスト情報が含まれています。これは開発者にとっては非常に便利ですが、運用環境ではこのようなエラー メッセージをユーザーに表示することはできません。代わりに、アプリケーションが適切に機能し、データとユーザーのプライバシー情報を保護できるように、カスタム例外ページを提供する必要があります。

CakePHP でのカスタム例外ハンドラーの作成

カスタム例外ハンドラーを作成するには、CakePHP の例外クラスを使用します。これは、例外を管理するための多くのプロパティとメソッドを提供する一般的な基本クラスです。 CakePHPExceptionRenderer クラスを拡張するサブクラスを作成します。これを実現する手順は次のとおりです。

1. カスタム例外クラスを作成する

AppException という名前の例外クラスを作成します。アプリケーション内のすべての例外の基本クラス。すべての例外が要件を満たしていることを確認するために、いくつかのデフォルトのプロパティとメソッドをそこに追加します。カスタム例外クラスは次の例のようになります。

<?php
namespace AppError;

use CakeCoreExceptionException;

class AppException extends Exception
{
    protected $_messageTemplate = 'An error occurred.';
    protected $_defaultCode = 500;

    public function __construct($message = null, $code = null, $previous = null)
    {
        if (empty($message)) {
            $message = $this->_messageTemplate;
        }

        if (empty($code)) {
            $code = $this->_defaultCode;
        }

        parent::__construct($message, $code, $previous);
    }

    public function getResponse()
    {
        // your custom response handling logic here
    }
}

2. Create AppExceptionRendererClass

次に、新しい例外レンダラー クラスを作成します。 CakeErrorExceptionRenderer クラスを拡張します。このクラスでは、どの例外ケースでどのテンプレートが使用されるかを定義します。このクラスでは、HTTP 404 エラー、内部サーバー エラーなどのさまざまな例外を定義することを選択できます。 AppExceptionRenderer クラスの例を次に示します。

<?php 
.namespace AppError;

use CakeErrorExceptionRenderer;
use Throwable;

class AppExceptionRenderer extends ExceptionRenderer {

    public function render() {
        $exception = $this->error instanceof Throwable ? $this->error : new FatalErrorException($this->error->getMessage(), 0, E_ERROR, __FILE__, __LINE__);
        
        $this->controller->response = $this->_getJsonResponse($exception);
        
        $this->controller->response->statusCode($exception->getCode());
        
    }
    
    protected function _getJsonResponse(Throwable $exception): JsonResponse {
        $response = new JsonResponse([
            'status' => 'error',
            'code' => $exception->getCode(),
            'message' => $exception->getMessage(),
        ],JsonResponse::HTTP_OK);
        
        if (method_exists($exception, 'getResponse')) {
            $response = $exception->getResponse();
        }
        
        return $response;
    }
}

このクラスは、アプリケーションの実行中に例外をキャッチし、カスタム テンプレートをレンダリングします。このクラスでは、型破りな例外レシーバー、カスタム ページ レンダリングなど、必要なロジックを定義できます。

3. 例外ハンドラーの構成

必要なクラスをすべて定義したので、例外をキャッチするときにこれらのクラスを使用するようにアプリケーションに指示する必要があります。 CakePHP の設定ファイル config/app.php の Error セクションを使用します。次の設定を変更して、カスタム例外ハンドラーを使用するようにフレームワークに指示します。

'Error' => [
        'errorLevel' => E_ALL & ~E_USER_DEPRECATED,
        'exceptionRenderer' => 'AppErrorAppExceptionRenderer',
    ],

これにより、アプリケーションの実行中に例外がスローされたときにカスタム例外ハンドラーを使用するように CakePHP に指示されます。

概要

CakePHP でカスタム例外ハンドラーを作成するには追加の作業が必要ですが、それだけの価値のある結果が得られます。カスタム例外ハンドラーを使用すると、エラー発生時にアプリケーションが適切に機能することを保証しながら、アプリケーションとユーザーのデータを保護できます。上記の手順は、例外ハンドラーをカスタマイズする方法を示す基本的な方法にすぎません。実際の状況に応じて、必要に応じて変更および拡張できます。

この記事がお役に立てば幸いです。ご質問やご意見がございましたら、以下のコメント欄にご記入ください。読んでくれてありがとう！

以上がCakePHP でカスタム例外ハンドラーを作成するにはどうすればよいですか?の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。