错误处理

• 介绍
• 配置
• 异常处理器
  • 报告方法
  • 渲染方法
  • 可报告和可渲染的异常
• HTTP 异常
  • 自定义 HTTP 错误页面

介绍

当你开始一个新的 Laravel 项目时，错误和异常处理已经为你配置好了。App\Exceptions\Handler 类是所有由你的应用程序触发的异常被记录并渲染回用户的地方。我们将在本文档中更深入地探讨这个类。

配置

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

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

异常处理器

报告方法

所有异常都由 App\Exceptions\Handler 类处理。这个类包含两个方法：report 和 render。我们将详细检查这两个方法。report 方法用于记录异常或将其发送到外部服务，如 Bugsnag 或 Sentry。默认情况下，report 方法将异常传递给基类，在那里记录异常。然而，你可以自由地以任何你希望的方式记录异常。

例如，如果你需要以不同的方式报告不同类型的异常，可以使用 PHP 的 instanceof 比较运算符：

/**
 * 报告或记录异常。
 *
 * 这是一个将异常发送到 Sentry、Bugsnag 等的好地方。
 *
 * @param  \Exception  $exception
 * @return void
 */
public function report(Exception $exception)
{
    if ($exception instanceof CustomException) {
        //
    }

    return parent::report($exception);
}

与其在 report 方法中进行大量的 instanceof 检查，不如考虑使用 可报告的异常

report 辅助函数

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

public function isValid($value)
{
    try {
        // 验证值...
    } catch (Exception $e) {
        report($e);

        return false;
    }
}

按类型忽略异常

异常处理器的 $dontReport 属性包含一个不被记录的异常类型数组。例如，由 404 错误以及其他几种类型的错误导致的异常不会被写入日志文件。你可以根据需要将其他异常类型添加到此数组中：

/**
 * 不应报告的异常类型列表。
 *
 * @var array
 */
protected $dontReport = [
    \Illuminate\Auth\AuthenticationException::class,
    \Illuminate\Auth\Access\AuthorizationException::class,
    \Symfony\Component\HttpKernel\Exception\HttpException::class,
    \Illuminate\Database\Eloquent\ModelNotFoundException::class,
    \Illuminate\Validation\ValidationException::class,
];

渲染方法

render 方法负责将给定的异常转换为应发送回浏览器的 HTTP 响应。默认情况下，异常被传递给基类，基类为你生成响应。然而，你可以自由地检查异常类型或返回你自己的自定义响应：

/**
 * 将异常渲染为 HTTP 响应。
 *
 * @param  \Illuminate\Http\Request  $request
 * @param  \Exception  $exception
 * @return \Illuminate\Http\Response
 */
public function render($request, Exception $exception)
{
    if ($exception instanceof CustomException) {
        return response()->view('errors.custom', [], 500);
    }

    return parent::render($request, $exception);
}

可报告和可渲染的异常

与其在异常处理器的 report 和 render 方法中进行类型检查，不如可以直接在自定义异常上定义 report 和 render 方法。当这些方法存在时，框架会自动调用它们：

<?php

namespace App\Exceptions;

use Exception;

class RenderException extends Exception
{
    /**
     * 报告异常。
     *
     * @return void
     */
    public function report()
    {
        //
    }

    /**
     * 将异常渲染为 HTTP 响应。
     *
     * @param  \Illuminate\Http\Request
     * @return \Illuminate\Http\Response
     */
    public function render($request)
    {
        return response(...);
    }
}

HTTP 异常

一些异常描述了来自服务器的 HTTP 错误代码。例如，这可能是一个“页面未找到”错误（404）、一个“未授权错误”（401）甚至是一个开发人员生成的 500 错误。为了从应用程序的任何地方生成这样的响应，你可以使用 abort 辅助函数：

abort(404);

abort 辅助函数将立即引发一个异常，该异常将由异常处理器渲染。可选地，你可以提供响应文本：

abort(403, 'Unauthorized action.');

自定义 HTTP 错误页面

Laravel 使得为各种 HTTP 状态代码显示自定义错误页面变得容易。例如，如果你希望自定义 404 HTTP 状态代码的错误页面，请创建一个 resources/views/errors/404.blade.php。此文件将在应用程序生成的所有 404 错误时提供。此目录中的视图应命名为与它们对应的 HTTP 状态代码相匹配。abort 函数引发的 HttpException 实例将作为 $exception 变量传递给视图：

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