Laravel 5.3 学习笔记之 错误&日志


Posted in PHP onAugust 28, 2016

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
 */
public function report(Exception $e){
  if ($e instanceof CustomException) {
    //
  }

  return parent::report($e);
}

通过类型忽略异常

异常处理器的$dontReport属性包含一个不会被记录的异常类型数组,默认情况下,404错误异常不会被写到日志文件,如果需要的话你可以添加其他异常类型到这个数组:

/**
 * A list of the exception types that should not be reported.
 *
 * @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状态码相匹配。

5、日志

Laravel基于强大的Monolog库提供了简单的日志抽象层,默认情况下,Laravel被配置为在storage/logs目录下每天为应用生成日志文件,你可以使用Log门面记录日志信息到日志中:

<?php

namespace App\Http\Controllers;

use Log;
use App\User;
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();

PHP 相关文章推荐
层叠菜单的动态生成
Oct 09 PHP
关于Intype一些小问题的解决办法
Mar 28 PHP
PHP下一个非常全面获取图象信息的函数
Nov 20 PHP
PHP对象转换为数组函数(递归方法)
Feb 04 PHP
php preg_replace替换实例讲解
Nov 04 PHP
linux使用crontab实现PHP执行计划定时任务
May 10 PHP
php中simplexml_load_file函数用法实例
Nov 12 PHP
php实现读取和写入tab分割的文件
Jun 01 PHP
php自定义类fsocket模拟post或get请求的方法
Jul 31 PHP
PHP模拟asp.net的StringBuilder类实现方法
Aug 08 PHP
PHP基于回溯算法解决n皇后问题的方法示例
Nov 07 PHP
php实现的PDO异常处理操作分析
Dec 27 PHP
Laravel 5.3 学习笔记之 配置
Aug 28 #PHP
Laravel 5.3 学习笔记之 安装
Aug 28 #PHP
PHP实现导出带样式的Excel
Aug 28 #PHP
Linux系统中为php添加pcntl扩展
Aug 28 #PHP
mac系统下为 php 添加 pcntl 扩展
Aug 28 #PHP
PHP编写简单的App接口
Aug 28 #PHP
PHP导出带样式的Excel示例代码
Aug 28 #PHP
You might like
php socket方式提交的post详解
2008/07/19 PHP
php自动给文章加关键词链接的函数代码
2012/11/29 PHP
Session服务器配置指南与使用经验的深入解析
2013/06/17 PHP
php过滤XSS攻击的函数
2013/11/12 PHP
9个比较实用的php代码片段
2016/03/15 PHP
javascript 伪数组实现方法
2010/10/11 Javascript
js获取日期:昨天今天和明天、后天
2014/06/11 Javascript
限制上传文件大小和格式的jQuery插件实例
2015/01/24 Javascript
jQuery插件EnPlaceholder实现输入框提示文字
2015/06/05 Javascript
jQuery增加自定义函数的方法
2015/07/18 Javascript
如何实现移动端浏览器不显示 pc 端的广告
2015/10/15 Javascript
jQuery实现鼠标滚动图片延迟加载效果附源码下载
2016/06/28 Javascript
文本框只能输入数字的js代码(含小数点)
2016/07/10 Javascript
switch语句的妙用(必看篇)
2016/10/03 Javascript
js 转json格式的字符串为对象或数组(前后台)的方法
2016/11/02 Javascript
js 公式编辑器 - 自定义匹配规则 - 带提示下拉框 - 动态获取光标像素坐标
2018/01/04 Javascript
vue实现动态按钮功能
2019/05/13 Javascript
cordova+vue+webapp使用html5获取地理位置的方法
2019/07/06 Javascript
JS插件amCharts实现绘制柱形图默认显示数值功能示例
2019/11/26 Javascript
[04:11]DOTA2亚洲邀请赛小组赛第一日 TOP10精彩集锦
2015/01/30 DOTA
Python制作爬虫抓取美女图
2016/01/20 Python
python strip() 函数和 split() 函数的详解及实例
2017/02/03 Python
Python 2与Python 3版本和编码的对比
2017/02/14 Python
浅谈Python实现2种文件复制的方法
2018/01/19 Python
python破解zip加密文件的方法
2018/05/31 Python
python程序封装为win32服务的方法
2021/03/07 Python
python内存监控工具memory_profiler和guppy的用法详解
2019/07/29 Python
numpy实现RNN原理实现
2021/03/02 Python
video结合canvas实现视频在线截图功能
2018/06/25 HTML / CSS
Paradigit比利时电脑卖场:购买笔记本、电脑、平板和外围设备
2016/11/28 全球购物
司机岗位职责
2013/11/15 职场文书
城管执法人员个人对照检查材料思想汇报
2014/09/29 职场文书
2015年新教师个人工作总结
2015/10/14 职场文书
python数据分析之用sklearn预测糖尿病
2021/04/22 Python
仅仅使用 HTML/CSS 实现各类进度条的方式汇总
2021/11/11 HTML / CSS
Elasticsearch 配置详解
2022/04/19 Java/Android