错误处理
导言
当您启动一个新的 Laravel 项目时，错误和异常处理已经为您配置好了；但是，在任何时候，您都可以在应用程序的 bootstrap/app.php 文件中使用 withExceptions 方法来管理应用程序如何报告和渲染异常。
提供给 withExceptions 闭包的 $exceptions 对象是 Illuminate\Foundation\Configuration\Exceptions 的一个实例，负责管理应用程序中的异常处理。我们将在本文档中更深入地探讨这个对象。
配置
config/app.php 配置文件中的 debug 选项决定了向用户实际显示多少关于错误的信息。默认情况下，此选项设置为遵循 APP_DEBUG 环境变量的值，该变量存储在您的 .env 文件中。
在本地开发期间，您应该将 APP_DEBUG 环境变量设置为 true。在您的生产环境中，此值应始终为 false。如果该值在生产环境中设置为 true，您将面临向应用程序的最终用户公开敏感配置值的风险。
处理异常
报告异常
在 Laravel 中，异常报告用于记录异常或将它们发送到外部服务，如 Sentry 或 Flare。默认情况下，异常将根据您的 logging 配置进行记录。但是，您可以自由地以任何您希望的方式记录异常。
如果您需要以不同的方式报告不同类型的异常，您可以在应用程序的 bootstrap/app.php 文件中使用 report 异常方法来注册一个闭包，当给定类型的异常需要报告时，该闭包应该被执行。Laravel 将通过检查闭包的类型提示来确定闭包报告的异常类型：
use App\Exceptions\InvalidOrderException;
->withExceptions(function (Exceptions $exceptions) {
$exceptions->report(function (InvalidOrderException $e) {
// ...
});
})
当您使用 report 方法注册自定义异常报告回调时，Laravel 仍将使用应用程序的默认日志配置记录异常。如果您希望停止异常向默认日志堆栈的传播，您可以在定义报告回调时使用 stop 方法，或从回调中返回 false：
use App\Exceptions\InvalidOrderException;
->withExceptions(function (Exceptions $exceptions) {
$exceptions->report(function (InvalidOrderException $e) {
// ...
})->stop();
$exceptions->report(function (InvalidOrderException $e) {
return false;
});
})
全局日志上下文
如果可用，Laravel 会自动将当前用户的 ID 作为上下文数据添加到每个异常的日志消息中。您可以在应用程序的 bootstrap/app.php 文件中使用 context 异常方法定义您自己的全局上下文数据。此信息将包含在您的应用程序编写的每个异常的日志消息中：
->withExceptions(function (Exceptions $exceptions) {
$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) {
$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) {
$exceptions->level(PDOException::class, LogLevel::CRITICAL);
})
按类型忽略异常
在构建应用程序时，有些类型的异常是您永远不想报告的。要忽略这些异常，您可以在应用程序的 bootstrap/app.php 文件中使用 dontReport 异常方法。提供给此方法的任何类都不会被报告；但是，它们可能仍具有自定义渲染逻辑：
use App\Exceptions\InvalidOrderException;
->withExceptions(function (Exceptions $exceptions) {
$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) {
$exceptions->dontReportWhen(function (Throwable $e) {
return $e instanceof PodcastProcessingException &&
$e->reason() === 'Subscription expired';
});
})
在内部，Laravel 已经为您忽略了一些类型的错误，例如由 404 HTTP 错误或由无效 CSRF 令牌生成的 419 HTTP 响应导致的异常。如果您想指示 Laravel 停止忽略给定类型的异常，您可以在应用程序的 bootstrap/app.php 文件中使用 stopIgnoring 异常方法：
use Symfony\Component\HttpKernel\Exception\HttpException;
->withExceptions(function (Exceptions $exceptions) {
$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) {
$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) {
$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) {
$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) {
$exceptions->respond(function (Response $response) {
if ($response->getStatusCode() === 419) {
return back()->with([
'message' => 'The page expired, please try again.',
]);
}
return $response;
});
})
可报告和可渲染异常
除了在应用程序的 bootstrap/app.php 文件中定义自定义报告和渲染行为，您还可以在应用程序的异常上直接定义 report 和 render 方法。当这些方法存在时，框架会自动调用它们：
<?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;
}
report 方法的任何所需依赖项进行类型提示，它们将由 Laravel 的 服务容器 自动注入到该方法中。节流报告的异常
如果您的应用程序报告了大量异常，您可能希望限制实际记录或发送到应用程序外部错误跟踪服务的异常数量。
要对异常进行随机抽样，您可以在应用程序的 bootstrap/app.php 文件中使用 throttle 异常方法。throttle 方法接收一个闭包，该闭包应返回一个 Lottery 实例：
use Illuminate\Support\Lottery;
use Throwable;
->withExceptions(function (Exceptions $exceptions) {
$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) {
$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) {
$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) {
$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) {
$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 为这些状态码提供了内部的专用页面。要自定义为这些状态码渲染的页面，您应该分别为它们中的每一个定义一个自定义错误页面。