错误处理

介绍

当你开始一个新的 Laravel 项目时, 它已经为您配置了错误和异常处理. app\exceptions\handler 类用于记录应用程序触发的所有异常,然后将其呈现回用户。我们将在本文中深入讨论这个类。

配置

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

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

异常处理

Report 方法

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

例如,如果你需要以不同方式报告不同类型的异常,则可以使用 PHPinstanceof 比较运算符:

  1. /**
  2. * 报告或记录异常
  3. *
  4. * 这是一个向 Sentry、Bugsnag 等外部服务发送异常信息的好位置
  5. *
  6. * @param \Exception $exception
  7. * @return void
  8. */
  9. public function report(Exception $exception)
  10. {
  11. if ($exception instanceof CustomException) {
  12. //
  13. }
  14. parent::report($exception);
  15. }

Tip:不要在 report 方法中进行太多的 instanceof 检查,而应考虑使用 可报告异常(Reportable exception)

全局日志

在正常情况下,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. ]);
  11. }

report 辅助函数

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

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

按类型忽略异常

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

  1. /**
  2. * 不应被报告的异常类型清单render 方法负责将给定的异常转换为将被发送回浏览器的 HTTP 响应。默认情况下,异常将传递给为你生成响应的基类。不过,你可以按自己意愿检查异常类型或返回自己的自定义响应:render 方法负责将给定的异常转换为将被发送回浏览器的 HTTP 响应。默认情况下,异常将传递给为你生成响应的基类。不过,你可以按自己意愿检查异常类型或返回自己的自定义响应:
  3. *
  4. * @var array
  5. */
  6. protected $dontReport = [
  7. \Illuminate\Auth\AuthenticationException::class,
  8. \Illuminate\Auth\Access\AuthorizationException::class,
  9. \Symfony\Component\HttpKernel\Exception\HttpException::class,
  10. \Illuminate\Database\Eloquent\ModelNotFoundException::class,
  11. \Illuminate\Validation\ValidationException::class,
  12. ];

Render 方法

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. }

Reportable & Renderable 异常

除了在异常处理器的 reportrender 方法中检查异常类型,你还可以直接在自定义异常上定义 reportrender 方法。当定义了这些方法时,它们会被框架自动调用:

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

Tip:你可以声明 report 方法和必要参数,它们将通过 Laravel 的 服务容器 自动注入方法中 .

HTTP 异常

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

  1. abort(404);

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

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

自定义 HTTP 错误页面

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

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

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

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

本文章首发在 LearnKu.com 网站上。

本文中的所有译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接 我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。