Basics - 11. Error Handling

The Exception Handler

The Report Method

Alle Ausnahmen werden von der Klasse App\Exceptions\Handler behandelt. Diese Klasse enthält zwei Methoden: report und render. Wir werden jede dieser Methoden im Detail untersuchen. Die Reportmethode wird verwendet, um Exceptions zu protokollieren oder an einen externen Service wie Bugsnag oder Sentry zu senden. Standardmäßig übergibt die report-Methode die Ausnahme an die Basisklasse, in der die Ausnahme protokolliert wird. Es steht Ihnen jedoch frei, Ausnahmen zu protokollieren, wie Sie es wünschen.

Wenn Sie beispielsweise verschiedene Arten von Ausnahmen auf unterschiedliche Weise melden müssen, können Sie den PHP instanceof des Vergleichsoperators verwenden:

/**
 * Report or log an exception.
 *
 * This is a great spot to send exceptions to Sentry, Bugsnag, etc.
 *
 * @param  \Exception  $exception
 * @return void
 */
public function report(Exception $exception)
{
    if ($exception instanceof CustomException) {
        //
    }

    parent::report($exception);
}

Global Log Context

Wenn verfügbar, fügt Laravel die ID des aktuellen Benutzers automatisch als Kontextdaten in die Logmeldung jeder Ausnahme ein. Sie können Ihre eigenen globalen Kontextdaten definieren, indem Sie die context-Methode der Klasse App\Exceptions\Handler Ihrer Anwendung überschreiben. Diese Informationen werden in die Logmeldung jeder Ausnahme aufgenommen, die von Ihrer Anwendung geschrieben wurde:

/**
 * Get the default context variables for logging.
 *
 * @return array
 */
protected function context()
{
    return array_merge(parent::context(), [
        'foo' => 'bar',
    ]);
}

The report Helper

Manchmal müssen Sie eine Ausnahme melden, aber die aktuelle Anfrage weiter bearbeiten. Die Berichtshelferfunktion (report helper function) ermöglicht es Ihnen, eine Ausnahme mit der report-Methode Ihres Ausnahmebehandlers schnell zu melden, ohne eine Fehlerseite anzuzeigen:

public function isValid($value)
{
    try {
        // Validate the value...
    } catch (Exception $e) {
        report($e);

        return false;
    }
}

Ignoring Exceptions By Type

Die Eigenschaft $dontReport des Ausnahmebehandlers enthält ein Array von Ausnahmearten, die nicht protokolliert werden. Beispielsweise werden Ausnahmen, die sich aus 404 Fehlern ergeben, sowie einige andere Arten von Fehlern nicht in Ihre Protokolldateien geschrieben. Sie können diesem Array bei Bedarf weitere Ausnahmearten hinzufügen:

/**
 * A list of the exception types that should not be reported.
 *
 * @var array
 */
protected $dontReport = [
    \Illuminate\Auth\AuthenticationException::class,
    \Illuminate\Auth\Access\AuthorizationException::class,
    \Symfony\Component\HttpKernel\Exception\HttpException::class,
    \Illuminate\Database\Eloquent\ModelNotFoundException::class,
    \Illuminate\Validation\ValidationException::class,
];

The Render Method

Die render-Methode ist dafür verantwortlich, eine bestimmte Ausnahme in eine HTTP-Antwort umzuwandeln, die an den Browser zurückgeschickt werden soll. Standardmäßig wird die Ausnahme an die Basisklasse übergeben, die eine Antwort für Sie generiert. Es steht Ihnen jedoch frei, die Ausnahmeart zu überprüfen oder Ihre eigene benutzerdefinierte Antwort zurückzugeben:

/**
 * Render an exception into an HTTP response.
 *
 * @param  \Illuminate\Http\Request  $request
 * @param  \Exception  $exception
 * @return \Illuminate\Http\Response
 */
public function render($request, Exception $exception)
{
    if ($exception instanceof CustomException) {
        return response()->view('errors.custom', [], 500);
    }

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

Reportable & Renderable Exceptions

Anstatt Ausnahmen in den report- und render-Methoden des Ausnahmebehandlers typgeprüft zu haben, können Sie report- und render-Methoden direkt auf Ihrer benutzerdefinierten Ausnahme definieren. Wenn diese Methoden existieren, werden sie vom Framework automatisch aufgerufen:

<?php

namespace App\Exceptions;

use Exception;

class RenderException extends Exception
{
    /**
     * Report the exception.
     *
     * @return void
     */
    public function report()
    {
        //
    }

    /**
     * Render the exception into an HTTP response.
     *
     * @param  \Illuminate\Http\Request
     * @return \Illuminate\Http\Response
     */
    public function render($request)
    {
        return response(...);
    }
}

HTTP Exceptions

Einige Ausnahmen beschreiben HTTP-Fehlercodes vom Server. Dies kann beispielsweise ein "page not found"-Fehler (404), ein "unauthorized error" (401) oder sogar ein vom Entwickler generierter Fehler (500) sein. Um eine solche Antwort von überall in Ihrer Anwendung zu generieren, können Sie den abort-Helfer verwenden:

abort(404);

Der abort-Helfer löst sofort eine Ausnahme aus, die vom exception handler ausgegeben wird. Optional können Sie den Antworttext angeben:

abort(403, 'Unauthorized action.');

Custom HTTP Error Pages

Laravel macht es einfach, benutzerdefinierte Fehlerseiten für verschiedene HTTP-Statuscodes anzuzeigen. Wenn Sie beispielsweise die Fehlerseite für 404 HTTP-Statuscodes anpassen möchten, erstellen Sie eine Ressourcen/Views/Fehler/404.blade.php. Diese Datei wird bei allen 404 Fehlern, die von Ihrer Anwendung generiert wurden, bereitgestellt. Die Views in diesem Verzeichnis sollten benannt werden, um dem HTTP-Statuscode zu entsprechen, dem sie entsprechen. Die durch die abort-Funktion ausgelöste HttpException-Instanz wird als $Exception-Variable an die View übergeben:

<h2>{{ $exception->getMessage() }}</h2>

Sie können die Fehlerseitenvorlagen von Laravel mit dem Befehl vendor:publish Artisan veröffentlichen. Sobald die Vorlagen veröffentlicht wurden, können Sie sie nach Belieben anpassen:

php artisan vendor:publish --tag=laravel-errors