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 相关文章推荐
PHP伪造referer实例代码
Sep 20 PHP
PHP安全技术之 实现php基本安全
Sep 04 PHP
探讨如何在php168_cms中提取验证码
Jun 08 PHP
深入file_get_contents函数抓取内容失败的原因分析
Jun 25 PHP
使用淘宝IP库获取用户ip地理位置
Oct 27 PHP
php打开远程文件的方法和风险及解决方法
Nov 12 PHP
C#静态方法与非静态方法实例分析
Sep 22 PHP
Thinkphp中数据按分类嵌套循环实现方法
Oct 30 PHP
Yii框架获取当前controlle和action对应id的方法
Dec 03 PHP
Yii框架表单提交验证功能分析
Jan 07 PHP
thinkphp5.1框架模板赋值与变量输出示例
May 25 PHP
PHP实现简单注册登录系统
Dec 28 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过滤危险html代码
2008/08/18 PHP
php下图片文字混合水印与缩略图实现代码
2009/12/11 PHP
修改ThinkPHP缓存为Memcache的方法
2014/06/25 PHP
php数组实现根据某个键值将相同键值合并生成新二维数组的方法
2017/04/26 PHP
PHP+Session防止表单重复提交的解决方法
2018/04/09 PHP
javascript textarea光标定位方法(兼容IE和FF)
2011/03/12 Javascript
javascript中的数字与字符串相加实例分析
2011/08/14 Javascript
ie8本地图片上传预览示例代码
2014/01/12 Javascript
JQuery $.each遍历JavaScript数组对象实例
2014/09/01 Javascript
node.js中的fs.fstat方法使用说明
2014/12/15 Javascript
解决jQuery uploadify在非IE核心浏览器下无法上传
2015/08/05 Javascript
js如何判断输入字符串长度
2015/12/16 Javascript
jQuery中show与hide方法用法示例
2016/09/16 Javascript
JavaScript比较两个数组的内容是否相同(推荐)
2017/05/02 Javascript
jQuery实现对网页节点的增删改查功能示例
2017/09/18 jQuery
[01:33:07]VGJ.T vs Newbee Supermajor 败者组 BO3 第一场 6.6
2018/06/07 DOTA
Python 列表(List)操作方法详解
2014/03/11 Python
wxPython窗口的继承机制实例分析
2014/09/28 Python
Django实现快速分页的方法实例
2017/10/22 Python
python读取.mat文件的数据及实例代码
2019/07/12 Python
Django 项目通过加载不同env文件来区分不同环境
2020/02/17 Python
Python几种常见算法汇总
2020/06/02 Python
opencv 图像腐蚀和图像膨胀的实现
2020/07/07 Python
python 常用日期处理-- datetime 模块的使用
2020/09/02 Python
突袭HTML5之Javascript API扩展4—拖拽(Drag/Drop)概述
2013/01/31 HTML / CSS
美国艺术和工艺品商店:Hobby Lobby
2020/12/09 全球购物
如何实现jdbc性能优化
2012/07/30 面试题
教师廉洁自律承诺书
2014/05/26 职场文书
2014年便民服务中心工作总结
2014/12/20 职场文书
员工评语范文
2014/12/31 职场文书
2015年财政局工作总结
2015/05/21 职场文书
西柏坡观后感
2015/06/08 职场文书
先进党支部事迹材料2016
2016/02/26 职场文书
Python 如何解决稀疏矩阵运算
2021/05/26 Python
零基础学java之循环语句的使用
2022/04/10 Java/Android
Win10服务全部禁用了怎么启动?Win10服务全部禁用解决方法
2022/09/23 数码科技