Laravel 的错误和日志记录

• 简介
• 配置
  • 显示错误信息
  • 日志存储
  • 日志级别
  • 自定义 Monolog 日志
• 异常处理
  • Report 方法
  • Render 方法
  • 自定义异常的 report & render 方法
• HTTP 异常
  • 自定义 HTTP 错误页面
• 记录

简介

当您启动一个新的 Laravel 项目时，错误和异常处理就已为您配置就绪。应用程序触发的所有异常都被 App\Exceptions\Handler 类记录下来，然后渲染给用户。 我们将在本文档中深入介绍此类。

Laravel 使用 Monolog 库进行日志处理，它能为各种强大的日志处理程序提供支持。Laravel 配置了多几种日志处理程序，方便您在单个日志文件、多个交替日志文件之间进行选择写入，或将错误信息写入系统日志。

配置

显示错误信息

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

本地开发环境下，应该将 APP_DEBUG 环境变量设置为 true 。在您的生产环境中，此值应始终保持 false 。如果你在生产中将该值设置为 true ，则可能会将敏感的配置值暴露给应用程序的最终用户。

日志存储

Laravel 的日志存储功能开箱即用，它支持 single 、daily 、 syslog 和 errorlog 日志写入模式。要配置 Laravel 使用的存储机制，应该修改 config/app.php 配置文件中的 log 选项。例如，如果您希望每天产生一个日志文件而不是单个文件，则应将 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 那么将会记录 error , critical , alert 和 emergency 日志信息：

'log_level' => env('APP_LOG_LEVEL', 'error'),

{tip} Monolog 识别以下严重级别 - 从低到高为: debug, info, notice, warning, error, critical, alert, emergency。

自定义 Monolog 日志

如果你想让你的应用程序完全控制 Monolog ，可以使用应用程序的 configureMonologUsing 方法。你应该放置一个回调方法到 bootstrap/app.php 文件中，在文件返回 $app 变量之前，调用这个方法：

$app->configureMonologUsing(function ($monolog) {
    $monolog->pushHandler(...);
});

return $app;

异常处理

Report 方法

所有异常都由 App\Exceptions\Handler 类处理。 这个类包含两个方法：report 和 render 。 我们将详细研究这些方法。 report 方法用于记录异常或将其发送到外部服务，如 Bugsnag 或 Sentry。默认情况下，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 辅助函数允许您使用异常 handler 的 report 方法快速报告一个异常而不抛出一个错误页面：

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

        return false;
    }
}

通过类型忽略异常

异常 handler 的 $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 方法

您并不一定要在异常 handler 中的 report 和 render 方法中处理异常，而是可以直接在自定义异常中定义 report 和 render 方法。如果这些方法存的在话，框架会自动调用他们：

<?php

namespace App\Exceptions;

use Exception;

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

    /**
     * 报告异常
     *
     * @param  \Illuminate\Http\Request
     * @return void
     */
    public function render($request)
    {
        return response(...);
    }
}

HTTP 异常

一些异常描述了来自服务器的 HTTP 错误代码。例如这可能是「找不到页面」 错误（404），「未授权错误」（401）甚至是由开发者造成的 500 错误。你可以使用 abort 辅助函数，在应用程序中的任何地方生成这样的响应：

abort(404);

abort 辅助函数将立即创建一个被异常 handler 渲染过的异常。此外，您还可以提供响应文本：

abort(403, 'Unauthorized action.');

自定义 HTTP 错误页面

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

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

记录

Laravel 在强大的 Monolog 库上提供了一个简单的抽象层。默认情况下，Laravel 日志文件的存储目录被配置为 storage/logs 。您可以使用 Log facade 将信息写入日志：

<?php

namespace App\Http\Controllers;

use App\User;
use Illuminate\Support\Facades\Log;
use App\Http\Controllers\Controller;

class UserController extends Controller
{
    /**
     * 显示给用户的配置.
     *
     * @param  int  $id
     * @return Response
     */
    public function showProfile($id)
    {
        Log::info('Showing user profile for user: '.$id);

        return view('user.profile', ['user' => User::findOrFail($id)]);
    }
}

该日志记录器提供八种 RFC 5424 定义的日志级别：emergency，alert，critical，error，warning，notice，info 和 debug。

Log::emergency($message);
Log::alert($message);
Log::critical($message);
Log::error($message);
Log::warning($message);
Log::notice($message);
Log::info($message);
Log::debug($message);

上下文信息

上下文数据也可以以数组格式传递给日志方法。此上下文数据将被格式化并与日志消息一起显示：

Log::info('User failed to login.', ['id' => $user->id]);

访问底层 Monolog 实例

Monolog 还提供了多种额外的 handler 用来记录日志。如果需要，您可以访问 Laravel 底层的 Monolog 实例：

$monolog = Log::getMonolog();

译者署名

用户名	头像	职能	签名
@ChrisonWang		翻译	@王欣 at LinkedIn

---

{note} 欢迎任何形式的转载，但请务必注明出处，尊重他人劳动共创开源社区。

转载请注明：本文档由 Laravel China 社区 laravel-china.org 组织翻译，详见 翻译召集帖。

文档永久地址： https://d.laravel-china.org