laravelリクエスト例外処理

Laravel は、Web アプリケーションを構築するための強力で柔軟なシステムを提供する人気のある PHP フレームワークです。ただし、開発プロセス中に、リクエスト例外が発生することは避けられません。この記事では、Laravel リクエスト例外を処理する方法について説明します。

1. 例外の分類

Laravel におけるリクエスト例外は、プログラム例外と HTTP 例外の 2 種類に分類できます。

プログラム例外とは、PHP によってスローされた致命的なエラー、キャッチされなかった例外など、コードの実行中に発生する例外です。

HTTP 例外とは、404 Not Found、500 Internal Server Error など、HTTP リクエストで発生する例外を指します。

例外の種類が異なれば、異なる処理方法が必要になります。

2. プログラム例外の処理

Laravel コントローラーでプログラム例外が発生する場合があります。処理されない場合は、ページがポップアップしてエラー メッセージが表示されます。これはユーザーが期待するものではないため、プログラム例外を処理する必要があります。

Laravel は、プログラム例外を処理する 2 つのメソッドを提供します。 1 つ目は例外ハンドラーを使用する方法で、2 つ目はグローバル例外処理を使用する方法です。

2.1 例外ハンドラー

Laravel 例外ハンドラーは、アプリケーションによってスローされた例外を処理するクラスです。例外がスローされたときにコントローラーが JSON 形式で応答を返すようにしたい場合は、カスタム例外ハンドラーを作成できます。以下は例です:

<?php

namespace AppExceptions;

use Exception;
use IlluminateFoundationExceptionsHandler as ExceptionHandler;

class Handler extends ExceptionHandler
{
    /**
     * A list of the exception types that are not reported.
     *
     * @var array
     */
    protected $dontReport = [
        //
    ];

    /**
     * Report or log an exception.
     *
     * @param  Exception  $exception
     * @return void
     */
    public function report(Exception $exception)
    {
        parent::report($exception);
    }

    /**
     * Render an exception into an HTTP response.
     *
     * @param  IlluminateHttpRequest  $request
     * @param  Exception  $exception
     * @return IlluminateHttpResponse
     */
    public function render($request, Exception $exception)
    {
        if ($exception instanceof IlluminateDatabaseEloquentModelNotFoundException) {
            return response()->json([
                'error' => 'Resource not found'
            ], 404);
        }

        return parent::render($request, $exception);
    }
}

この例では、Laravel の例外ハンドラー クラスを継承し、render メソッドをオーバーライドします。 render メソッドでは、例外タイプが IlluminateDatabaseEloquentModelNotFoundException であるかどうかを確認します。その場合、JSON 形式の応答が返されます。

このメソッドでは、他のプログラム例外も処理できます。このアプローチの利点は、例外の種類ごとにカスタム ハンドラーを作成できることです。このようにして、どのような応答が得られるかを予測できます。

2.2 グローバル例外処理

グローバル例外処理を使用すると、例外ごとに個別のハンドラを作成する代わりに、アプリケーション内のすべての例外をキャッチできます。以下に例を示します。

<?php

namespace AppExceptions;

use Exception;
use IlluminateFoundationExceptionsHandler as ExceptionHandler;

class Handler extends ExceptionHandler
{
    /**
     * A list of the exception types that are not reported.
     *
     * @var array
     */
    protected $dontReport = [
        //
    ];

    /**
     * Report or log an exception.
     *
     * @param  Exception  $exception
     * @return void
     */
    public function report(Exception $exception)
    {
        parent::report($exception);
    }

    /**
     * Render an exception into an HTTP response.
     *
     * @param  IlluminateHttpRequest  $request
     * @param  Exception  $exception
     * @return IlluminateHttpResponse
     */
    public function render($request, Exception $exception)
    {
        if ($exception instanceof SymfonyComponentHttpKernelExceptionHttpException) {
            $code = $exception->getStatusCode();

            return response()->json([
                'error' => 'HTTP Exception',
                'status' => $code
            ], $code);
        }

        return parent::render($request, $exception);
    }

    /**
     * Render the given HttpException.
     *
     * @param  SymfonyComponentHttpKernelExceptionHttpException  $e
     * @return IlluminateHttpResponse
     */
    protected function renderHttpException(HttpException $e)
    {
        $status = $e->getStatusCode();

        if (view()->exists("errors.{$status}")) {
            return response()->view("errors.{$status}", ['exception' => $e], $status, $e->getHeaders());
        } else {
            return $this->convertExceptionToResponse($e);
        }
    }
}

この例では、render メソッドをオーバーライドして、例外タイプが SymfonyComponentHttpKernelExceptionHttpException であるかどうかを確認します。その場合、エラー メッセージと HTTP ステータス コードを含む JSON 形式の応答が作成されます。

HTML ページをレンダリングする必要がある場合は、renderHttpException メソッドをオーバーライドしてカスタム例外ページをレンダリングすることもできます。

3. HTTP 例外処理

Laravel は、HTTP 例外を処理する簡単な方法を提供します。 app/Exceptions/Handler.php の render メソッドをカスタマイズすることで、指定された HTTP ステータス コードを返すことができます。以下に例を示します。

public function render($request, Exception $exception)
{
    if ($this->isHttpException($exception)) {
        return $this->renderHttpException($exception);
    } else {
        return parent::render($request, $exception);
    }
}

protected function renderHttpException(HttpException $exception)
{
    return response()->view('errors.' . $exception->getStatusCode(), [], $exception->getStatusCode());
}

上の例では、例外が HTTP 例外であるかどうかを確認します。その場合、getStatusCode メソッドを使用して HTTP ステータス コードを取得し、それをビュー名として使用します。この例では、ステータス コードに対応するビューを返すだけです。

4. 結論

この記事では、Laravel でプログラムと HTTP 例外を処理する方法を紹介しました。例外ハンドラーとグローバル例外処理を使用してプログラム例外を処理する方法と、render メソッドをカスタマイズして HTTP 例外を処理する方法を学習しました。 Laravel 開発者にとって、例外を正しく処理することは非常に重要です。これらのテクノロジーを使用することで、アプリケーションの動作をより正確に制御し、信頼性と安定性を向上させることができます。

以上がlaravelリクエスト例外処理の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。