错误处理

介绍
配置
处理异常
节流报告的异常
HTTP 异常
- 自定义 HTTP 错误页面

介绍

当你开始一个新的 Laravel 项目时，错误和异常处理已经为你配置好；然而，在任何时候，你都可以在应用程序的 bootstrap/app.php 中使用 withExceptions 方法来管理应用程序如何报告和渲染异常。

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

配置

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

在本地开发期间，你应该将 APP_DEBUG 环境变量设置为 true。在生产环境中，此值应始终为 false。如果在生产中将其设置为 true，你可能会将敏感的配置值暴露给应用程序的最终用户。

处理异常

报告异常

在 Laravel 中，异常报告用于记录异常或将其发送到外部服务 Sentry 或 Flare。默认情况下，异常将根据你的 logging 配置进行记录。然而，你可以自由地以任何你希望的方式记录异常。

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

php

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

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

php

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

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

要自定义给定异常的报告，你还可以利用可报告的异常。

全局日志上下文

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

php

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

异常日志上下文

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

php

<?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 助手函数允许你快速报告一个异常，而不向用户呈现错误页面：

php

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

        return false;
    }
}

去重报告的异常

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

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

php

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

现在，当使用相同的异常实例调用 report 助手时，只有第一次调用会被报告：

php

$original = new RuntimeException('哎呀！');

report($original); // 已报告

try {
    throw $original;
} catch (Throwable $caught) {
    report($caught); // 被忽略
}

report($original); // 被忽略
report($caught); // 被忽略

异常日志级别

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

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

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

php

use PDOException;
use Psr\Log\LogLevel;

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

按类型忽略异常

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

php

use App\Exceptions\InvalidOrderException;

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

或者，你可以简单地通过 Illuminate\Contracts\Debug\ShouldntReport 接口标记一个异常类。当异常被标记为此接口时，它将永远不会被 Laravel 的异常处理程序报告：

php

<?php

namespace App\Exceptions;

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

class PodcastProcessingException extends Exception implements ShouldntReport
{
    //
}

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

php

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 将通过检查闭包的类型提示来确定闭包渲染的异常类型：

php

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 将使用默认的异常渲染：

php

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' => '记录未找到。'
            ], 404);
        }
    });
})

将异常渲染为 JSON

在渲染异常时，Laravel 将自动确定异常是应该渲染为 HTML 还是 JSON 响应，具体取决于请求的 Accept 头。如果你希望自定义 Laravel 确定是否渲染 HTML 或 JSON 异常响应的方式，可以利用 shouldRenderJsonWhen 方法：

php

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 方法注册一个响应自定义闭包：

php

use Symfony\Component\HttpFoundation\Response;

->withExceptions(function (Exceptions $exceptions) {
    $exceptions->respond(function (Response $response) {
        if ($response->getStatusCode() === 419) {
            return back()->with([
                'message' => '页面过期，请重试。',
            ]);
        }

        return $response;
    });
})

可报告和可渲染的异常

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

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 响应：

php

/**
 * 将异常渲染为 HTTP 响应。
 */
public function render(Request $request): Response|bool
{
    if (/** 确定异常是否需要自定义渲染 */) {

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

    return false;
}

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

php

/**
 * 报告异常。
 */
public function report(): bool
{
    if (/** 确定异常是否需要自定义报告 */) {

        // ...

        return true;
    }

    return false;
}

你可以在 report 方法中类型提示任何所需的依赖项，Laravel 的服务容器将自动将它们注入到该方法中。

节流报告的异常

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

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

php

use Illuminate\Support\Lottery;
use Throwable;

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

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

php

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 来限制记录或发送到外部错误跟踪服务的异常。这在你希望保护免受突发异常涌入日志的情况下非常有用，例如，当应用程序使用的第三方服务出现故障时：

php

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 方法指定自己的键来进行自定义：

php

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 实例的混合：

php

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 助手：

php

abort(404);

自定义 HTTP 错误页面

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

php

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

你可以使用 vendor:publish Artisan 命令发布 Laravel 的默认错误页面模板。发布模板后，你可以根据自己的喜好进行自定义：

shell

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

回退 HTTP 错误页面

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

在定义回退错误页面时，回退页面不会影响 404、500 和 503 错误响应，因为 Laravel 已经为这些状态代码提供了内部专用页面。要自定义为这些状态代码呈现的页面，你应该单独为每个状态代码定义自定义错误页面。

错误处理 ​

介绍 ​

配置 ​

处理异常 ​

报告异常 ​

全局日志上下文 ​

异常日志上下文 ​

report 助手 ​

去重报告的异常 ​

异常日志级别 ​

按类型忽略异常 ​

渲染异常 ​

将异常渲染为 JSON ​

自定义异常响应 ​

可报告和可渲染的异常 ​

节流报告的异常 ​

HTTP 异常 ​

自定义 HTTP 错误页面 ​

回退 HTTP 错误页面 ​

错误处理

介绍

配置

处理异常

报告异常

全局日志上下文

异常日志上下文

`report` 助手

去重报告的异常

异常日志级别

按类型忽略异常

渲染异常

将异常渲染为 JSON

自定义异常响应

可报告和可渲染的异常

节流报告的异常

HTTP 异常

自定义 HTTP 错误页面

回退 HTTP 错误页面