错误处理

简介

当你启动一个新的 Laravel 项目时，错误和异常处理已经为你预先配置好了；不过，你可以随时使用应用程序 bootstrap/app.php 中的 withExceptions 方法来管理应用程序如何报告和渲染异常。

提供给 withExceptions 闭包的 $exceptions 对象是 Illuminate\Foundation\Configuration\Exceptions 的实例，负责管理应用程序中的异常处理。我们将在本文档中深入探讨这个对象。

配置

config/app.php 配置文件中的 debug 选项决定了向用户实际显示多少错误信息。默认情况下，此选项设置为遵循存储在 .env 文件中的 APP_DEBUG 环境变量的值。

在本地开发期间，你应该将 APP_DEBUG 环境变量设置为 true。

WARNING

在生产环境中，APP_DEBUG 的值应始终为 false。如果在生产环境中将该值设置为 true，你可能会将敏感的配置值暴露给应用程序的最终用户。

异常处理

报告异常

在 Laravel 中，异常报告用于记录异常或将其发送到外部服务，如 Sentry 或 Flare。默认情况下，异常将根据你的日志配置进行记录。不过，你可以按自己的方式记录异常。

如果你需要以不同的方式报告不同类型的异常，可以在应用程序的 bootstrap/app.php 中使用 report 异常方法注册一个闭包，该闭包将在需要报告给定类型的异常时执行。Laravel 将通过检查闭包的类型提示来确定闭包报告的异常类型：

use App\Exceptions\InvalidOrderException;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->report(function (InvalidOrderException $e) {
        // ...
    });
})

当你使用 report 方法注册自定义异常报告回调时，Laravel 仍然会使用应用程序的默认日志配置记录异常。如果你希望阻止异常传播到默认日志堆栈，可以在定义报告回调时使用 stop 方法，或者从回调中返回 false：

use App\Exceptions\InvalidOrderException;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->report(function (InvalidOrderException $e) {
        // ...
    })->stop();

    $exceptions->report(function (InvalidOrderException $e) {
        return false;
    });
})

NOTE

要自定义给定异常的异常报告，你也可以使用可报告和可渲染异常。

全局日志上下文

如果可用，Laravel 会自动将当前用户的 ID 作为上下文数据添加到每条异常的日志消息中。你可以在应用程序的 bootstrap/app.php 文件中使用 context 异常方法定义自己的全局上下文数据。此信息将包含在应用程序编写的每条异常日志消息中：

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->context(fn () => [
        'foo' => 'bar',
    ]);
})

异常日志上下文

虽然向每条日志消息添加上下文可能很有用，但有时特定的异常可能具有你希望包含在日志中的独特上下文。通过在应用程序的某个异常上定义 context 方法，你可以指定与该异常相关的数据，这些数据应添加到异常的日志条目中：

<?php

namespace App\Exceptions;

use Exception;

class InvalidOrderException extends Exception
{
    // ...

    /**
     * Get the exception's context information.
     *
     * @return array<string, mixed>
     */
    public function context(): array
    {
        return ['order_id' => $this->orderId];
    }
}

report 辅助函数

有时你可能需要报告一个异常但继续处理当前请求。report 辅助函数允许你快速报告异常而不向用户渲染错误页面：

public function isValid(string $value): bool
{
    try {
        // Validate the value...
    } catch (Throwable $e) {
        report($e);

        return false;
    }
}

异常报告去重

如果你在整个应用程序中使用 report 函数，偶尔可能会多次报告同一个异常，从而在日志中创建重复条目。

如果你希望确保同一个异常实例只被报告一次，可以在应用程序的 bootstrap/app.php 文件中调用 dontReportDuplicates 异常方法：

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->dontReportDuplicates();
})

现在，当使用同一个异常实例调用 report 辅助函数时，只有第一次调用会被报告：

$original = new RuntimeException('Whoops!');

report($original); // reported

try {
    throw $original;
} catch (Throwable $caught) {
    report($caught); // ignored
}

report($original); // ignored
report($caught); // ignored

异常日志级别

当消息被写入应用程序的日志时，消息会以指定的日志级别写入，该级别指示所记录消息的严重性或重要性。

如上所述，即使你使用 report 方法注册了自定义异常报告回调，Laravel 仍然会使用应用程序的默认日志配置记录异常；然而，由于日志级别有时会影响消息记录到哪些通道，你可能希望配置某些异常记录时使用的日志级别。

要实现此目的，你可以在应用程序的 bootstrap/app.php 文件中使用 level 异常方法。此方法接收异常类型作为第一个参数，日志级别作为第二个参数：

use PDOException;
use Psr\Log\LogLevel;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->level(PDOException::class, LogLevel::CRITICAL);
})

按类型忽略异常

在构建应用程序时，会有一些类型的异常你永远不想报告。要忽略这些异常，你可以在应用程序的 bootstrap/app.php 文件中使用 dontReport 异常方法。提供给此方法的任何类都不会被报告；但是，它们仍然可能具有自定义渲染逻辑：

use App\Exceptions\InvalidOrderException;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->dontReport([
        InvalidOrderException::class,
    ]);
})

或者，你可以简单地用 Illuminate\Contracts\Debug\ShouldntReport 接口"标记"异常类。当异常被标记了此接口时，它将永远不会被 Laravel 的异常处理器报告：

<?php

namespace App\Exceptions;

use Exception;
use Illuminate\Contracts\Debug\ShouldntReport;

class PodcastProcessingException extends Exception implements ShouldntReport
{
    //
}

如果你需要对何时忽略特定类型的异常有更多控制，可以向 dontReportWhen 方法提供一个闭包：

use App\Exceptions\InvalidOrderException;
use Throwable;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->dontReportWhen(function (Throwable $e) {
        return $e instanceof PodcastProcessingException &&
               $e->reason() === 'Subscription expired';
    });
})

在内部，Laravel 已经为你忽略了一些类型的错误，例如 404 HTTP 错误导致的异常、来源不匹配生成的 403 HTTP 响应，或无效 CSRF 令牌生成的 419 HTTP 响应。如果你希望指示 Laravel 停止忽略给定类型的异常，可以在应用程序的 bootstrap/app.php 文件中使用 stopIgnoring 异常方法：

use Symfony\Component\HttpKernel\Exception\HttpException;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->stopIgnoring(HttpException::class);
})

渲染异常

默认情况下，Laravel 异常处理器会将异常转换为 HTTP 响应。不过，你可以自由注册针对给定类型异常的自定义渲染闭包。你可以通过在应用程序的 bootstrap/app.php 文件中使用 render 异常方法来实现。

传递给 render 方法的闭包应返回 Illuminate\Http\Response 的实例，该实例可以通过 response 辅助函数生成。Laravel 将通过检查闭包的类型提示来确定闭包渲染的异常类型：

use App\Exceptions\InvalidOrderException;
use Illuminate\Http\Request;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->render(function (InvalidOrderException $e, Request $request) {
        return response()->view('errors.invalid-order', status: 500);
    });
})

你也可以使用 render 方法覆盖内置 Laravel 或 Symfony 异常（如 NotFoundHttpException）的渲染行为。如果提供给 render 方法的闭包没有返回值，将使用 Laravel 的默认异常渲染：

use Illuminate\Http\Request;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->render(function (NotFoundHttpException $e, Request $request) {
        if ($request->is('api/*')) {
            return response()->json([
                'message' => 'Record not found.'
            ], 404);
        }
    });
})

将异常渲染为 JSON

渲染异常时，Laravel 会根据请求的 Accept 头自动确定异常应该渲染为 HTML 还是 JSON 响应。如果你想自定义 Laravel 如何确定是渲染 HTML 还是 JSON 异常响应，可以使用 shouldRenderJsonWhen 方法：

use Illuminate\Http\Request;
use Throwable;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->shouldRenderJsonWhen(function (Request $request, Throwable $e) {
        if ($request->is('admin/*')) {
            return true;
        }

        return $request->expectsJson();
    });
})

自定义异常响应

在极少数情况下，你可能需要自定义 Laravel 异常处理器渲染的整个 HTTP 响应。要实现此目的，你可以使用 respond 方法注册一个响应自定义闭包：

use Symfony\Component\HttpFoundation\Response;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->respond(function (Response $response) {
        if ($response->getStatusCode() === 419) {
            return back()->with([
                'message' => 'The page expired, please try again.',
            ]);
        }

        return $response;
    });
})

可报告和可渲染异常

你可以直接在应用程序的异常上定义 report 和 render 方法，而不是在应用程序的 bootstrap/app.php 文件中定义自定义报告和渲染行为。当这些方法存在时，框架会自动调用它们：

<?php

namespace App\Exceptions;

use Exception;
use Illuminate\Http\Request;
use Illuminate\Http\Response;

class InvalidOrderException extends Exception
{
    /**
     * Report the exception.
     */
    public function report(): void
    {
        // ...
    }

    /**
     * Render the exception as an HTTP response.
     */
    public function render(Request $request): Response
    {
        return response(/* ... */);
    }
}

如果你的异常继承了一个已经可渲染的异常（例如内置的 Laravel 或 Symfony 异常），你可以从异常的 render 方法返回 false 来渲染异常的默认 HTTP 响应：

/**
 * Render the exception as an HTTP response.
 */
public function render(Request $request): Response|bool
{
    if (/** Determine if the exception needs custom rendering */) {

        return response(/* ... */);
    }

    return false;
}

如果你的异常包含仅在特定条件下才需要的自定义报告逻辑，你可能需要指示 Laravel 有时使用默认异常处理配置来报告异常。要实现此目的，你可以从异常的 report 方法返回 false：

/**
 * Report the exception.
 */
public function report(): bool
{
    if (/** Determine if the exception needs custom reporting */) {

        // ...

        return true;
    }

    return false;
}

NOTE

你可以对 report 方法的任何必需依赖进行类型提示，它们将由 Laravel 的 service container 自动注入到该方法中。

限流异常报告

如果你的应用程序报告了大量异常，你可能希望限制实际记录或发送到应用程序外部错误跟踪服务的异常数量。

要对异常进行随机采样，你可以在应用程序的 bootstrap/app.php 文件中使用 throttle 异常方法。throttle 方法接收一个应返回 Lottery 实例的闭包：

use Illuminate\Support\Lottery;
use Throwable;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->throttle(function (Throwable $e) {
        return Lottery::odds(1, 1000);
    });
})

也可以根据异常类型有条件地采样。如果你只想采样特定异常类的实例，可以仅为该类返回 Lottery 实例：

use App\Exceptions\ApiMonitoringException;
use Illuminate\Support\Lottery;
use Throwable;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->throttle(function (Throwable $e) {
        if ($e instanceof ApiMonitoringException) {
            return Lottery::odds(1, 1000);
        }
    });
})

你也可以通过返回 Limit 实例而不是 Lottery 来对记录或发送到外部错误跟踪服务的异常进行速率限制。这在你想防止异常突发洪水般淄没日志时很有用，例如当应用程序使用的第三方服务宕机时：

use Illuminate\Broadcasting\BroadcastException;
use Illuminate\Cache\RateLimiting\Limit;
use Throwable;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->throttle(function (Throwable $e) {
        if ($e instanceof BroadcastException) {
            return Limit::perMinute(300);
        }
    });
})

默认情况下，限制将使用异常的类作为速率限制键。你可以通过在 Limit 上使用 by 方法指定自己的键来自定义：

use Illuminate\Broadcasting\BroadcastException;
use Illuminate\Cache\RateLimiting\Limit;
use Throwable;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->throttle(function (Throwable $e) {
        if ($e instanceof BroadcastException) {
            return Limit::perMinute(300)->by($e->getMessage());
        }
    });
})

当然，你可以为不同的异常返回 Lottery 和 Limit 实例的混合：

use App\Exceptions\ApiMonitoringException;
use Illuminate\Broadcasting\BroadcastException;
use Illuminate\Cache\RateLimiting\Limit;
use Illuminate\Support\Lottery;
use Throwable;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->throttle(function (Throwable $e) {
        return match (true) {
            $e instanceof BroadcastException => Limit::perMinute(300),
            $e instanceof ApiMonitoringException => Lottery::odds(1, 1000),
            default => Limit::none(),
        };
    });
})

HTTP 异常

某些异常描述来自服务器的 HTTP 错误代码。例如，这可能是“页面未找到”错误 (404)、“未授权错误” (401)，甚至是开发人员生成的 500 错误。要从应用程序的任何位置生成此类响应，你可以使用 abort 辅助函数：

abort(404);

自定义 HTTP 错误页面

Laravel 可以轻松地为各种 HTTP 状态码显示自定义错误页面。例如，要自定义 404 HTTP 状态码的错误页面，请创建 resources/views/errors/404.blade.php 视图模板。此视图将为应用程序生成的所有 404 错误进行渲染。此目录中的视图应命名为与其对应的 HTTP 状态码相匹配。由 abort 函数引发的 Symfony\Component\HttpKernel\Exception\HttpException 实例将作为 $exception 变量传递给视图：

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

你可以使用 vendor:publish Artisan 命令发布 Laravel 的默认错误页面模板。模板发布后，你可以根据需要自定义它们：

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

回退 HTTP 错误页面

你也可以为给定系列的 HTTP 状态码定义一个“回退”错误页面。如果没有与发生的特定 HTTP 状态码对应的页面，将渲染此页面。要实现此目的，请在应用程序的 resources/views/errors 目录中定义 4xx.blade.php 模板和 5xx.blade.php 模板。

定义回退错误页面时，回退页面不会影响 404、500 和 503 错误响应，因为 Laravel 对这些状态码有内部专用页面。要自定义这些状态码渲染的页面，你应该为它们各自单独定义自定义错误页面。