错误处理

简介
配置
处理异常
限制报告异常的频率
HTTP 异常
- 自定义 HTTP 错误页面

简介

当您启动一个新的 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。默认情况下，异常将根据您的日志记录配置进行记录。但是，您可以自由地以任何您希望的方式记录异常。

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

1->withExceptions(function (Exceptions $exceptions) {
2    $exceptions->report(function (InvalidOrderException $e) {
3        // ...
4    });
5})

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

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

1->withExceptions(function (Exceptions $exceptions) {
2    $exceptions->report(function (InvalidOrderException $e) {
3        // ...
4    })->stop();
5 
6    $exceptions->report(function (InvalidOrderException $e) {
7        return false;
8    });
9})

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

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

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

全局日志上下文

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

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

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

异常日志上下文

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

 1<?php
 2 
 3namespace App\Exceptions;
 4 
 5use Exception;
 6 
 7class InvalidOrderException extends Exception
 8{
 9    // ...
10 
11    /**
12     * Get the exception's context information.
13     *
14     * @return array<string, mixed>
15     */
16    public function context(): array
17    {
18        return ['order_id' => $this->orderId];
19    }
20}

<?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 辅助函数允许您快速报告异常，而无需向用户呈现错误页面

 1public function isValid(string $value): bool
 2{
 3    try {
 4        // Validate the value...
 5    } catch (Throwable $e) {
 6        report($e);
 7 
 8        return false;
 9    }
10}

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

        return false;
    }
}

重复数据删除报告的异常

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

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

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

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

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

 1$original = new RuntimeException('Whoops!');
 2 
 3report($original); // reported
 4 
 5try {
 6    throw $original;
 7} catch (Throwable $caught) {
 8    report($caught); // ignored
 9}
10 
11report($original); // ignored
12report($caught); // ignored

$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 异常方法。此方法接收异常类型作为其第一个参数，日志级别作为其第二个参数

1use PDOException;
2use Psr\Log\LogLevel;
3 
4->withExceptions(function (Exceptions $exceptions) {
5    $exceptions->level(PDOException::class, LogLevel::CRITICAL);
6})

use PDOException;
use Psr\Log\LogLevel;

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

按类型忽略异常

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

1use App\Exceptions\InvalidOrderException;
2 
3->withExceptions(function (Exceptions $exceptions) {
4    $exceptions->dontReport([
5        InvalidOrderException::class,
6    ]);
7})

use App\Exceptions\InvalidOrderException;

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

或者，您也可以简单地使用 Illuminate\Contracts\Debug\ShouldntReport 接口“标记”异常类。当异常使用此接口标记时，Laravel 的异常处理程序将永远不会报告它

 1<?php
 2 
 3namespace App\Exceptions;
 4 
 5use Exception;
 6use Illuminate\Contracts\Debug\ShouldntReport;
 7 
 8class PodcastProcessingException extends Exception implements ShouldntReport
 9{
10    //
11}

<?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 异常方法

1use Symfony\Component\HttpKernel\Exception\HttpException;
2 
3->withExceptions(function (Exceptions $exceptions) {
4    $exceptions->stopIgnoring(HttpException::class);
5})

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

1use App\Exceptions\InvalidOrderException;
2use Illuminate\Http\Request;
3 
4->withExceptions(function (Exceptions $exceptions) {
5    $exceptions->render(function (InvalidOrderException $e, Request $request) {
6        return response()->view('errors.invalid-order', status: 500);
7    });
8})

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 的默认异常渲染

 1use Illuminate\Http\Request;
 2use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 3 
 4->withExceptions(function (Exceptions $exceptions) {
 5    $exceptions->render(function (NotFoundHttpException $e, Request $request) {
 6        if ($request->is('api/*')) {
 7            return response()->json([
 8                'message' => 'Record not found.'
 9            ], 404);
10        }
11    });
12})

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 方法

 1use Illuminate\Http\Request;
 2use Throwable;
 3 
 4->withExceptions(function (Exceptions $exceptions) {
 5    $exceptions->shouldRenderJsonWhen(function (Request $request, Throwable $e) {
 6        if ($request->is('admin/*')) {
 7            return true;
 8        }
 9 
10        return $request->expectsJson();
11    });
12})

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

 1use Symfony\Component\HttpFoundation\Response;
 2 
 3->withExceptions(function (Exceptions $exceptions) {
 4    $exceptions->respond(function (Response $response) {
 5        if ($response->getStatusCode() === 419) {
 6            return back()->with([
 7                'message' => 'The page expired, please try again.',
 8            ]);
 9        }
10 
11        return $response;
12    });
13})

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 文件中定义自定义报告和渲染行为。当这些方法存在时，框架将自动调用它们

 1<?php
 2 
 3namespace App\Exceptions;
 4 
 5use Exception;
 6use Illuminate\Http\Request;
 7use Illuminate\Http\Response;
 8 
 9class InvalidOrderException extends Exception
10{
11    /**
12     * Report the exception.
13     */
14    public function report(): void
15    {
16        // ...
17    }
18 
19    /**
20     * Render the exception into an HTTP response.
21     */
22    public function render(Request $request): Response
23    {
24        return response(/* ... */);
25    }
26}

<?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 into an HTTP response.
     */
    public function render(Request $request): Response
    {
        return response(/* ... */);
    }
}

如果你的异常继承自一个已经可渲染的异常，例如 Laravel 或 Symfony 内置的异常，你可以从该异常的 render 方法中返回 false，以便渲染异常的默认 HTTP 响应。

 1/**
 2 * Render the exception into an HTTP response.
 3 */
 4public function render(Request $request): Response|bool
 5{
 6    if (/** Determine if the exception needs custom rendering */) {
 7 
 8        return response(/* ... */);
 9    }
10 
11    return false;
12}

/**
 * Render the exception into 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。

 1/**
 2 * Report the exception.
 3 */
 4public function report(): bool
 5{
 6    if (/** Determine if the exception needs custom reporting */) {
 7 
 8        // ...
 9 
10        return true;
11    }
12 
13    return false;
14}

/**
 * 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 实例。

1use Illuminate\Support\Lottery;
2use Throwable;
3 
4->withExceptions(function (Exceptions $exceptions) {
5    $exceptions->throttle(function (Throwable $e) {
6        return Lottery::odds(1, 1000);
7    });
8})

use Illuminate\Support\Lottery;
use Throwable;

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

也可以根据异常类型有条件地进行抽样。如果你只想对特定异常类的实例进行抽样，你可以仅针对该类返回一个 Lottery 实例。

 1use App\Exceptions\ApiMonitoringException;
 2use Illuminate\Support\Lottery;
 3use Throwable;
 4 
 5->withExceptions(function (Exceptions $exceptions) {
 6    $exceptions->throttle(function (Throwable $e) {
 7        if ($e instanceof ApiMonitoringException) {
 8            return Lottery::odds(1, 1000);
 9        }
10    });
11})

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 来限制记录或发送到外部错误跟踪服务的异常速率。如果你想防止突发的异常洪流淹没你的日志，例如当你的应用程序使用的第三方服务宕机时，这非常有用。

 1use Illuminate\Broadcasting\BroadcastException;
 2use Illuminate\Cache\RateLimiting\Limit;
 3use Throwable;
 4 
 5->withExceptions(function (Exceptions $exceptions) {
 6    $exceptions->throttle(function (Throwable $e) {
 7        if ($e instanceof BroadcastException) {
 8            return Limit::perMinute(300);
 9        }
10    });
11})

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 方法来指定你自己的键来自定义此行为。

 1use Illuminate\Broadcasting\BroadcastException;
 2use Illuminate\Cache\RateLimiting\Limit;
 3use Throwable;
 4 
 5->withExceptions(function (Exceptions $exceptions) {
 6    $exceptions->throttle(function (Throwable $e) {
 7        if ($e instanceof BroadcastException) {
 8            return Limit::perMinute(300)->by($e->getMessage());
 9        }
10    });
11})

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

 1use App\Exceptions\ApiMonitoringException;
 2use Illuminate\Broadcasting\BroadcastException;
 3use Illuminate\Cache\RateLimiting\Limit;
 4use Illuminate\Support\Lottery;
 5use Throwable;
 6 
 7->withExceptions(function (Exceptions $exceptions) {
 8    $exceptions->throttle(function (Throwable $e) {
 9        return match (true) {
10            $e instanceof BroadcastException => Limit::perMinute(300),
11            $e instanceof ApiMonitoringException => Lottery::odds(1, 1000),
12            default => Limit::none(),
13        };
14    });
15})

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 辅助函数。

1abort(404);

abort(404);

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

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

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

你可以使用 vendor:publish Artisan 命令发布 Laravel 的默认错误页面模板。一旦模板发布，你就可以根据自己的喜好自定义它们。

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

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

回退 HTTP 错误页面

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

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

序言

快速入门

架构概念

基础知识

深入探讨

安全性

数据库

Eloquent ORM

测试

扩展包

错误处理

简介

配置

处理异常

报告异常

全局日志上下文

异常日志上下文

`report` 辅助函数

重复数据删除报告的异常

异常日志级别

按类型忽略异常

渲染异常

将异常渲染为 JSON

自定义异常响应

可报告和可渲染的异常

限制报告异常的频率

HTTP 异常

自定义 HTTP 错误页面

回退 HTTP 错误页面

产品

扩展包

资源