# Laravel 的错误和日志记录 - [简介](#introduction) - [配置](#configuration) - [错误的详细信息](#error-detail) - [日志存储](#log-storage) - [日志严重程度级别](#log-severity-levels) - [自定义 Monolog 配置](#custom-monolog-configuration) - [异常处理](#the-exception-handler) - [Report 方法](#report-method) - [Render 方法](#render-method) - [自定义异常的 report & render 方法](#renderable-exceptions) - [HTTP 异常](#http-exceptions) - [自定义 HTTP 错误页面](#custom-http-error-pages) - [日志](#logging) ## 简介 Laravel 默认自带错误和异常处理机制。应用程序触发的所有异常都被 `App\Exceptions\Handler` 类记录下来,然后渲染给用户。 我们将在后续文档中深入介绍此类。 Laravel 使用 [Monolog](https://github.com/Seldaek/monolog) 库为各种强大的日志处理程序提供支持。Laravel 配置了多种日志处理程序,方便你在单个日志文件、多个日志文件或将错误信息写入系统日志之间进行选择。 ## 配置 ### 错误的详细信息 `config/app.php` 配置文件的 `debug` 选项决定了是否向用户显示错误信息。默认情况下,此选项设置为获取存储在 `.env` 文件中的 `APP_DEBUG` 环境变量的值。 对于本地开发,应该将 `APP_DEBUG` 环境变量设置为 `true` 。而在生产环境中,此值应始终保持 `false` 。如果你在生产中将该值设置为 `true` ,则有可能会将敏感的配置信息暴露给应用程序的最终用户。 ### 日志存储 Laravel 支持 `single` 、`daily` 、 `syslog` 和 `errorlog` 四种日志写入模式。通过修改 `config/app.php` 配置文件中的 `log` 选项来配置 Laravel 使用的存储机制。如果你希望每天产生日志都存放在不同的文件中,则应将 `app` 配置文件中的 `log` 值设置为 `daily`: 'log' => 'daily' #### 最大日志文件数 在使用 `daily` 日志模式时,Laravel 默认只保留五天份的日志文件。如果要调整保留文件的数量,就在 `app` 配置文件中添加一个 `log_max_files` 配置项: 'log_max_files' => 30 ### 日志严重程度级别 使用 Monolog 时,日志消息可能具有不同程度的严重级别。默认情况下,Laravel 将存储所有级别的日志。你也可以在生产环境中通过将 `log_level` 选项添加到 `app.php` 配置文件中来配置应当记录的严重程度最低的日志级别。 配置之后,Laravel 就只会记录大于或等于指定严重级别的所有级别的错误。例如,默认的 `log_level` 被设置为 `error`,那么 Laravel 只会记录 **error**、**critical**、**alert** 和 **emergency** 级别的日志信息: 'log_level' => env('APP_LOG_LEVEL', 'error'), > {tip} Monolog 识别以下严重程度的级别,从低到高为: `debug`、 `info`、`notice`、 `warning`、`error`、`critical`、`alert`、`emergency`。 ### 自定义 Monolog 配置 你可以使用 `configureMonologUsing` 方法来配置应用程序对 Monolog 的完全控制。在 `$app` 变量返回之前,在 `bootstrap/app.php` 文件中调用此方法: $app->configureMonologUsing(function ($monolog) { $monolog->pushHandler(...); }); return $app; #### 自定义渠道名称 默认情况下,Monolog 用与当前环境匹配的名称进行实例化,如 `production` 或 `local`。要更改此值,可将 `log_channel` 选项添加到 `app.php` 配置文件中: ``` 'log_channel' => env('APP_LOG_CHANNEL', 'my-app-name'), ``` ## 异常处理 ### Report 方法 所有异常都由 `App\Exceptions\Handler` 类处理。 这个类包含两个方法:`report` 和 `render`。`report` 方法用于记录异常或将其发送到外部服务,如 [Bugsnag](https://bugsnag.com) 或 [Sentry](https://github.com/getsentry/sentry-laravel)。默认情况下,`report` 方法只是简单地将异常传递给记录异常的基类。你可以根据需要来记录异常。 例如,如果你需要以不同的方式报告不同类型的异常,你可以使用 PHP 的比较运算符 `instanceof`: /** * 报告或记录一个异常 * * 这是个给 Bugsnag 或 Sentry 发送异常的好地方 * * @param \Exception $exception * @return void */ public function report(Exception $exception) { if ($exception instanceof CustomException) { // } return parent::report($exception); } #### 辅助函数 `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 方法 `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` 方法中处理不同类型的异常,可以直接在自定义的异常处理程序中定义 `report` 和 `render` 方法。如果这些方法存在的话,框架会自动调用他们: ## 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` 变量传递给视图。