错误&日志
1、简介
Laravel 默认已经为我们配置好了错误和异常处理，我们在 App\Exceptions\Handler 类中触发异常并将响应返回给用户。本教程我们将深入探讨这个类。
此外，Laravel 还集成了 Monolog日志库以便提供各种功能强大的日志处理器，默认情况下，Laravel 已经为我们配置了一些处理器，我们可以选择单个日志文件，也可以选择记录错误信息到系统日志。
2、配置
错误详情显示
配置文件 config/app.php 中的 debug 配置项控制浏览器显示的错误信息数量。默认情况下，该配置项通过 .env 文件中的环境变量 APP_DEBUG 进行设置。
对本地开发而言，你应该设置环境变量 APP_DEBUG 值为 true。在生产环境，该值应该被设置为false。如果在生产环境被设置为true，就有可能将一些敏感的配置值暴露给终端用户。
日志存储
默认情况下，Laravel 支持日志方法single, daily, syslog 和 errorlog。如果你想要日志文件按天生成而不是生成并记录到单个文件，应该在配置文件 config/app.php 中设置 log 值如下：
'log' => 'daily'
日志文件最大生命周期
使用 daily 日志模式的时候，Laravel 默认最多为我们保留最近 5 天的日志，如果你想要修改这个时间，需要添加一个配置log_max_files 到 app 配置文件：
'log_max_files' => 30
日志错误级别
使用 Monolog 的时候，日志消息可能有不同的错误级别，默认情况下，Laravel 将所有日志写到 storage 目录，但是在生产环境中，你可能想要配置最低错误级别，这可以通过在配置文件 app.php 中添加配置项 log_level 来实现。
该配置项被配置后，Laravel 会记录所有错误级别大于等于这个指定级别的日志，例如，默认 log_level 是 error ，则将会记录 error、critical、alert以及emergency级别的日志信息：
'log_level' => env('APP_LOG_LEVEL', 'error'),
注：Monolog 支持以下错误级别 ——debug、info、notice、warning、error、critical、alert、emergency。
自定义Monolog配置
如果你想要在应用中完全控制Monolog 的配置，可以使用configureMonologUsing方法。你需要在bootstrap/app.php文件返回$app变量之前调用该方法：
$app->configureMonologUsing(function($monolog) {
$monolog->pushHandler(...);
});
return $app;
3、异常处理器
所有异常都由类App\Exceptions\Handler处理，该类包含两个方法：report和render。下面我们详细阐述这两个方法。
report方法
report 方法用于记录异常并将其发送给外部服务如 Bugsnag 或Sentry，默认情况下，report方法只是将异常传递给异常被记录的基类，当然你也可以按自己的需要记录异常并进行相关处理。
例如，如果你需要以不同方式报告不同类型的异常，可使用PHP的instanceof 比较操作符：
/**
* 报告或记录异常
*
* This is a great spot to send exceptions to Sentry, Bugsnag, etc.
*
* @param \Exception $e
* @return void
* @translator laravelacademy.org
*/
public function report(Exception $e){
if ($e instanceof CustomException) {
//
}
return parent::report($e);
}
通过类型忽略异常
异常处理器的 $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 $e
* @return \Illuminate\Http\Response
*/
public function render($request, Exception $e){
if ($e instanceof CustomException) {
return response()->view('errors.custom', [], 500);
}
return parent::render($request, $e);
}
4、HTTP异常
有些异常描述来自服务器的 HTTP 错误码，例如，这可能是一个“页面未找到”错误（404），“认证失败错误”（401）亦或是程序出错造成的500错误，为了在应用中生成这样的响应，可以使用 abort 辅助函数：
abort(404);
abort辅助函数会立即引发一个会被异常处理器渲染的异常，此外，你还可以像这样提供响应描述：
abort(403, 'Unauthorized action.');
该方法可在请求生命周期的任何时间点使用。
自定义HTTP错误页面
在 Laravel 中，返回不同 HTTP 状态码的错误页面很简单，例如，如果你想要自定义404错误页面，创建一个resources/views/errors/404.blade.php文件，该视图文件用于渲染程序返回的所有404错误。需要注意的是，该目录下的视图命名应该和相应的HTTP状态码相匹配。abort函数触发的HttpException异常会以$exception变量的方式传递给视图。
5、日志
Laravel 基于强大的 Monolog 库提供了简单的日志抽象层，默认情况下，Laravel 被配置为在 storage/logs 目录下每天为应用生成日志文件，你可以使用 Log 门面记录日志信息到日志中：
<?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($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]);
访问底层Monolog实例
Monolog 有多个可用于日志的处理器，如果需要的话，你可以访问Laravel 使用的底层 Monolog 实例：
$monolog = Log::getMonolog();
No Comments