错误处理

    当你启动一个新的 Laravel 项目时,错误及异常处理是已为你配置好了的。 类负责记录应用程序触发的所有异常并呈现给用户。在本文档中,我们将深入探讨这个类。

    你的 config/app.php 配置文件中的 debug 选项决定了对于一个错误实际上将显示多少信息给用户。默认情况下,该选项的设置将遵照存储在 .env 文件中的 APP_DEBUG 环境变量的值。

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

    所有异常都是由 App\Exceptions\Handler 类处理的。这个类包含两个方法: reportrender 。我们将详细剖析这些方法。 report 方法用于记录异常或将它们发送给如 或 Sentry 等外部服务。默认情况下, report 方法将异常传递给记录异常的基类。不过,你可以任何自己喜欢的方式来记录异常。

    全局日志

    在正常情况下, Laravel 会自动将当前用户的 ID 作为数据添加到每一条异常日志中。 你可以在通过重写 App\Exceptions\Handler 类中的 context 方法来定义你的全局环境变量。 之后,这个变量将包含在每一条异常日志中:

    1. /**
    2. * 定义默认的环境变量
    3. *
    4. * @return array
    5. */
    6. protected function context()
    7. {
    8. return array_merge(parent::context(), [
    9. 'foo' => 'bar',
    10. }

    report 辅助函数

    有时你可能需要报告异常,但又不希望终止当前请求的处理。 report 辅助函数允许你使用异常处理器的 report 方法在不显示错误页面的情况下快速报告异常:

    1. public function isValid($value)
    2. {
    3. // 验证值...
    4. } catch (Exception $e) {
    5. report($e);
    6. return false;
    7. }
    8. }

    按类型忽略异常

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

    render 方法负责将给定的异常转换为将被发送回浏览器的 HTTP 响应。默认情况下,异常将传递给为你生成响应的基类。不过,你可以按自己意愿检查异常类型或返回自己的自定义响应:

    1. /**
    2. * 将异常转换为 HTTP 响应。
    3. *
    4. * @param \Illuminate\Http\Request $request
    5. * @param \Exception $exception
    6. * @return \Illuminate\Http\Response
    7. */
    8. public function render($request, Exception $exception)
    9. {
    10. if ($exception instanceof CustomException) {
    11. return response()->view('errors.custom', [], 500);
    12. }
    13. return parent::render($request, $exception);
    14. }

    1. <?php
    2. use Exception;
    3. class RenderException extends Exception
    4. {
    5. /**
    6. * 报告异常
    7. *
    8. * @return void
    9. */
    10. public function report()
    11. {
    12. //
    13. }
    14. /**
    15. * 转换异常为 HTTP 响应
    16. *
    17. * @param \Illuminate\Http\Request
    18. * @return \Illuminate\Http\Response
    19. */
    20. public function render($request)
    21. {
    22. return response(...);
    23. }
    24. }

    一些异常用于描述产生自服务器的 HTTP 错误代码。例如,「页面未找到」错误 (404), 「未经授权的错误」(401) ,甚至可以是开发人员引起的 500 错误。 你可以使用 abort 辅助函数从应用程序的任何地方生成这样的响应:

    辅助函数 abort 会立即引发一个由异常处理器渲染的异常。你还可选择性地提供响应文本:

    1. abort(403, 'Unauthorized action.');

    Laravel 可以轻松显示各种 HTTP 状态代码的自定义错误页面。例如,如果你希望自定义 404 HTTP 状态码的错误页面,可以创建一个 resources/views/errors/404.blade.php 视图文件。该文件将被用于你的应用程序产生的所有 404 错误。此目录中的视图文件的命名应匹配它们对应的 HTTP 状态码。由 abort 函数引发的 HttpException 实例将作为 $exception 变量传递给视图:

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

    你可以使用 vendor:publish Artisan 命令来定义错误模板页面。模板页面生成后,就可以自定义模板页面的内容: