Menu

错误与日志

错误与日志

简介

当你开始一个新的 Lumen 项目时,Lumen 已经帮你配置好错误和异常处理的操作。另外,Lumen 也集成了 Monolog 日志函数库,Monolog 支持和提供多种强大的日志处理功能。

设置

错误细节

你的应用程序通过 .env 配置文件中的 APP_DEBUG 设置选项来控制浏览器对错误的细节显示。

在开发的时候,你应该将 APP_DEBUG 环境变量设置为 true。在你的上线环境中,这个值应该永远为 false

自定义 Monolog 设置

如果你想要完全控制 Monolog,则使用应用程序的 configureMonologUsing 方法。此方法应该在 bootstrap/app.php 文件返回 $app 变量之前被调用:

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

return $app;

错误处理

所有的异常处理都是通过 App\Exceptions\Handler 类。这个类包含了两个方法:reportrender。我们将具体研究这些方法的细节。

报告方法

report 方法用来记录异常或将它们发送到像是 BugSnag 的外部服务上。默认情况下,当异常被记录时,report 方法只是简单的发送异常到基类,当然你也可以随意的来记录这些异常。

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

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

    return parent::report($e);
}

借助类型忽略异常

异常处理中的 $dontReport 属性是一个数组,包含不需要被记录的异常类型。默认情况下,由 404 错误导致的异常结果并不会被记录到日志文件。你可以根据你的需求增加其它异常类型到这个数组中。

呈现方法

render 方法负责将指定的异常转换成 HTTP 响应再发送到浏览器。默认情况下,异常会被发送到基类并帮你生成响应。但你可以随意检查异常类型或返回自定义的响应:

/**
 * 呈现异常到 HTTP 响应。
 *
 * @param  \Illuminate\Http\Request  $request
 * @param  \Exception  $e
 * @return \Illuminate\Http\Response
 */
public function render($request, Exception $e)
{
    if ($e instanceof CustomException) {
        return response('Custom Message');
    }

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

HTTP 异常

有一些异常是用于描述来自服务器的 HTTP 错误码。例如,这可能是个「找不到页面」错误(404),「未授权错误」(401),或甚至是开发者导致的 500 错误。你可以使用以下方法在应用程序的任何地方生成响应:

abort(404);

abort 方法通过错误处理将会立即引发异常,并且呈现错误。或者,你可以提供响应的文本消息:

abort(403, 'Unauthorized action.');

你可以在请求的生命周期中的任何时间点使用这个方法。

日志

Lumen 日志工具在强大的 Monolog 函数库上提供多一层简单的功能。Lumen 默认为应用程序创建每日的日志文件并保存在 storage/logs 目录。你可以使用 Log 来将信息写入到日志上:

<?php

namespace App\Http\Controllers;

use Log;
use App\User;
use App\Http\Controllers\Controller;

class UserController extends Controller
{
    /**
     * Show the user for the given ID.
     *
     * @param  int  $id
     * @return Response
     */
    public function show($id)
    {
        Log::info('Showing user: '.$id);

        return User::findOrFail($id);
    }
}

注意: 在使用 Log facade 前,请在 bootstrap/app.php 中把 $app->withFacades() 这行调用的注释去除掉。

日志工具提供了定义在 RFC 5424 的八个级别: emergencyalertcriticalerrorwarningnoticeinfodebug

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

上下文消息

传入上下文相关的数据数组到日志方法里。此上下文的相关数据会进行格式化并显示在日志消息上:

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

本文章首发在 Laravel China 社区
上一篇 下一篇
讨论数量: 0
发起讨论


暂无话题~
刻意练习,每日精进。
0
点赞
431
浏览
0
讨论

维护者
20