错误处理
介绍
当您开始一个新的 Laravel 项目时，错误和异常处理已经为您配置好了；然而，您可以在任何时候在应用程序的 bootstrap/app.php 文件中使用 withExceptions 方法来管理应用程序如何报告和渲染异常。
提供给 withExceptions 闭包的 $exceptions 对象是 Illuminate\Foundation\Configuration\Exceptions 类的一个实例，负责管理应用程序中的异常处理。我们将在本文件的后续内容中深入探讨这个对象。
配置
config/app.php 配置文件中的 debug 选项决定了关于错误的多少信息会显示给用户。默认情况下，此选项会根据存储在 .env 文件中的 APP_DEBUG 环境变量的值来设置。
在本地开发过程中，您应将 APP_DEBUG 环境变量设置为 true。在生产环境中，该值应始终设置为 false。如果在生产环境中将该值设置为 true，您可能会将敏感的配置值暴露给应用程序的最终用户。
处理异常
报告异常
如果您需要以不同的方式报告不同类型的异常，可以在应用程序的 bootstrap/app.php 文件中使用 report 方法来注册一个闭包，处理特定类型的异常报告。Laravel 会通过检查闭包的类型提示来确定该闭包报告的是哪种类型的异常：
->withExceptions(function (Exceptions $exceptions) {
$exceptions->report(function (InvalidOrderException $e) {
// ...
});
})当您使用 report 方法注册自定义的异常报告回调时，Laravel 仍然会使用应用程序的默认日志配置来记录异常。如果您希望停止异常向默认日志堆栈的传播，可以在定义报告回调时使用 stop 方法，或者从回调中返回 false：
->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
{
// ...
/**
* 获取异常的上下文信息。
*
* @return array<string, mixed>
*/
public function context(): array
{
return ['order_id' => $this->orderId];
}
}report 辅助函数
有时您可能需要报告异常，但继续处理当前请求。report 辅助函数允许您快速报告异常，而不向用户渲染错误页面：
public function isValid(string $value): bool
{
try {
// 验证值...
} 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); // 已报告
try {
throw $original;
} catch (Throwable $caught) {
report($caught); // 被忽略
}
report($original); // 被忽略
report($caught); // 被忽略异常日志级别
当消息被写入应用程序的【日志】时，这些消息会以指定的【日志级别】写入，日志级别表示消息的严重性或重要性。
如前所述，即使您使用 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
{
//
}在内部，Laravel 已经为您忽略了一些类型的错误，例如由 404 HTTP 错误或由无效 CSRF token 生成的 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;
});
})可报告和可渲染的异常
您可以直接在应用程序的异常类中定义 report 和 render 方法，而不是在应用程序的 bootstrap/app.php 文件中定义自定义的报告和渲染行为。当这些方法存在时，框架将自动调用它们：
<?php
namespace App\Exceptions;
use Exception;
use Illuminate\Http\Request;
use Illuminate\Http\Response;
class InvalidOrderException extends Exception
{
/**
* 报告异常。
*/
public function report(): void
{
// ...
}
/**
* 将异常渲染为 HTTP 响应。
*/
public function render(Request $request): Response
{
return response(/* ... */);
}
}如果您的异常继承了已经可渲染的异常（例如 Laravel 或 Symfony 内置异常），您可以从异常的 render 方法中返回 false，以渲染该异常的默认 HTTP 响应：
/**
* 将异常渲染为 HTTP 响应。
*/
public function render(Request $request): Response|bool
{
if (/** 判断异常是否需要自定义渲染 */) {
return response(/* ... */);
}
return false;
}如果您的异常包含仅在某些条件下才需要的自定义报告逻辑，您可能需要指示 Laravel 在某些情况下使用默认的异常处理配置报告异常。为此，您可以从异常的 report 方法中返回 false：
/**
* 报告异常。
*/
public function report(): bool
{
if (/** 判断异常是否需要自定义报告 */) {
// ...
return true;
}
return false;
}|
您可以在 |
限制报告的异常
如果您的应用程序报告了大量异常，您可能希望限制实际记录或发送到应用程序外部错误跟踪服务的异常数量。
为了对异常进行随机采样，您可以在应用程序的 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 状态码。例如，404 错误对应的视图文件应命名为 404.blade.php。由 abort 函数引发的 Symfony\Component\HttpKernel\Exception\HttpException 实例将作为 $exception 变量传递给视图：
<h2>{{ $exception->getMessage() }}</h2>您可以使用 vendor:publish Artisan 命令发布 Laravel 的默认错误页面模板。发布模板后，您可以根据自己的需要进行自定义：
php artisan vendor:publish --tag=laravel-errors