电脑疯子技术论坛|电脑极客社区

微信扫一扫 分享朋友圈

已有 1800 人浏览分享

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

[复制链接]
1800 0
本帖最后由 zhaorong 于 2017-4-17 12:47 编辑

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值如下:

  1. 'log' => 'daily'
复制代码


日志文件最大生命周期

使用daily日志模式的时候,Laravel默认最多为我们保留最近5天的日志,如果你想要修改这个时间,需要添加一个配置log_max_files到app配置文件:

  1. 'log_max_files' => 30
复制代码


日志错误级别

使用Monolog的时候,日志消息可能有不同的错误级别,默认情况下,Laravel将所有日志写到storage目录,但是在生产环境中,你可能想要配置最低错误级别,这可以通过在配置文件app.php中通过添加配置项 log_level 来实现。

该配置项被配置后,Laravel会记录所有错误级别大于等于这个指定级别的日志,例如,默认 log_level 是 error ,则将会记录error、critical、alert以及emergency级别的日志信息:

  1. 'log_level' => env('APP_LOG_LEVEL', 'error'),
复制代码


注:Monolog支持以下错误级别 —— debug、info、notice、warning、error、critical、alert、emergency。
自定义Monolog配置

如果你想要在应用中完全控制Monolog的配置,可以使用configureMonologUsing方法。你需要在bootstrap/app.php文件返回$app变量之前调用该方法:



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

  4. return $app;

复制代码



3、异常处理器
所有异常都由类App\Exceptions\Handler处理,该类包含两个方法:report和render。下面我们详细阐述这两个方法。

report方法

report方法用于记录异常并将其发送给外部服务如Bugsnag或Sentry,默认情况下,report方法只是将异常传递给异常被记录的基类,当然你也可以按自己的需要记录异常并进行相关处理。

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

/
  1. **
  2. * 报告或记录异常
  3. *
  4. * This is a great spot to send exceptions to Sentry, Bugsnag, etc.
  5. *
  6. * @param \Exception $e
  7. * @return void
  8. */
  9. public function report(Exception $e){
  10.   if ($e instanceof CustomException) {
  11.     //
  12.   }

  13.   return parent::report($e);
  14. }
复制代码

通过类型忽略异常

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

  1. /**
  2. * A list of the exception types that should not be reported.
  3. *
  4. * @var array
  5. */
  6. protected $dontReport = [
  7.   \Illuminate\Auth\AuthenticationException::class,
  8.   \Illuminate\Auth\Access\AuthorizationException::class,
  9.   \Symfony\Component\HttpKernel\Exception\HttpException::class,
  10.   \Illuminate\Database\Eloquent\ModelNotFoundException::class,
  11.   \Illuminate\Validation\ValidationException::class,
  12. ];
复制代码

render方法

render方法负责将给定异常转化为发送给浏览器的HTTP响应,默认情况下,异常被传递给为你生成响应的基类。当然,你也可以按照自己的需要检查异常类型或者返回自定义响应:

  1. /**
  2. * 将异常渲染到HTTP响应中
  3. *
  4. * @param \Illuminate\Http\Request $request
  5. * @param \Exception $e
  6. * @return \Illuminate\Http\Response
  7. */
  8. public function render($request, Exception $e){
  9.   if ($e instanceof CustomException) {
  10.     return response()->view('errors.custom', [], 500);
  11.   }

  12.   return parent::render($request, $e);
  13. }
复制代码

4、HTTP异常

有些异常描述来自服务器的HTTP错误码,例如,这可能是一个“页面未找到”错误(404),“认证失败错误”(401)亦或是程序出错造成的500错误,为了在应用中生成这样的响应,可以使用abort方法:

  1. abort(404);
复制代码


abort方法会立即引发一个会被异常处理器渲染的异常,此外,你还可以像这样提供响应描述:

  1. abort(403, 'Unauthorized action.');
复制代码


该方法可在请求生命周期的任何时间点使用。

自定义HTTP错误页面

在Laravel中,返回不同HTTP状态码的错误页面很简单,例如,如果你想要自定义404错误页面,创建一个resources/views/errors/404.blade.php文件,该视图文件用于渲染程序返回的所有404错误。需要注意的是,该目录下的视图命名应该和相应的HTTP状态码相匹配。

5、日志

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

  1. <?php

  2. namespace App\Http\Controllers;

  3. use Log;
  4. use App\User;
  5. use App\Http\Controllers\Controller;

  6. class UserController extends Controller{
  7.   /**
  8.    * 显示指定用户的属性
  9.    *
  10.    * @param int $id
  11.    * @return Response
  12.    */
  13.   public function showProfile($id)
  14.   {
  15.     Log::info('Showing user profile for user: '.$id);
  16.     return view('user.profile', ['user' => User::findOrFail($id)]);
  17.   }
  18. }
复制代码


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

  1. Log::emergency($error);
  2. Log::alert($error);
  3. Log::critical($error);
  4. Log::error($error);
  5. Log::warning($error);
  6. Log::notice($error);
  7. Log::info($error);
  8. Log::debug($error);
复制代码


上下文信息

上下文数据也会以数组形式传递给日志方法,然后和日志消息一起被格式化和显示:

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


访问底层Monolog实例

Monolog有多个可用于日志的处理器,如果需要的话,你可以访问Laravel使用的底层Monolog实例:

  1. $monolog = Log::getMonolog();
复制代码









您需要登录后才可以回帖 登录 | 注册

本版积分规则

1

关注

0

粉丝

9021

主题
精彩推荐
热门资讯
网友晒图
图文推荐

Powered by Pcgho! X3.4

© 2008-2022 Pcgho Inc.