Laravel 5.5 异常处理 & 错误日志的解决

吾爱主题阅读：116 2021-09-07 16:06:00 评论：0

简介

Laravel 默认已经为我们配置好了错误和异常处理，我们在 App\Exceptions\Handler 类中触发异常并将响应返回给用户。

此外，Laravel 还集成了 Monolog 日志库以便提供各种功能强大的日志处理器，默认情况下，Laravel 已经为我们配置了一些处理器，我们可以选择单个日志文件，也可以选择记录错误信息到系统日志。

配置

调试模式

配置文件 config/app.php 中的 debug 配置项表示是否开启调试模式，调试模式下会将错误信息直接暴露给客户端。

默认情况下，该配置项通过 .env 文件中的环境变量 APP_DEBUG 进行设置，默认值为 true ，即开启调试模式。

对本地开发而言，你应该设置环境变量 APP_DEBUG 值为 true。在生产环境，该值应该被设置为 false。如果在生产环境被设置为 true，就有可能将一些敏感的信息暴露给终端用户。

日志存储

Laravel 支持的日志文件类型为 single, daily, syslog 和 errorlog。

single：所有的日志信息会记录到单个日志文件里。

daily：按天生成日志文件。

syslog：通过系统 syslog 服务处理日志信息。

errorlog：通过 PHP error_log 处理器处理日志信息。

如果你想要日志文件按天生成而不是生成并记录到单个文件，应该在配置文件 config/app.php 中设置 log 值如下：

1	`'log'` `=>` `'daily'`

注：底层处理机制可以参考 Illuminate\Log\LogServiceProvider 中的实现逻辑。

日志文件最大生命周期

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

1	`'log_max_files'` `=> 30`

日志错误级别

使用 Monolog 的时候，日志消息可能有不同的错误级别，默认情况下，Laravel 将所有级别日志写到存储器，但是在生产环境中，你可能想要配置最低错误级别，这可以通过在配置文件 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 2 3 4 5 $app ->configureMonologUsing( function ( $monolog ) { $monolog ->pushHandler(...); }); return $app ;

自定义频道名称

默认情况下，Monolog 会通过一个与当前环境匹配的名字进行实例化，例如 production 或 local。如果想修改这个值，需要添加 log_channel 配置项到配置文件 config/app.php：

1	`'log_channel'` `=> env(` `'APP_LOG_CHANNEL'` `,` `'my-app-name'` `),`

异常处理器

所有异常都由类 App\Exceptions\Handler 处理，该类包含两个方法：report 和 render。

report 方法

report 方法用于记录异常并将其发送给外部服务如 Bugsnag 或 Sentry。

默认情况下，report 方法只是将异常传递给异常被记录的基类，当然你也可以按自己的需要记录异常并进行相关处理。

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

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 /** * Report or log an exception. * * This is a great spot to send exceptions to Sentry, Bugsnag, etc. * * @param \Exception $exception * @return void */ public function report(Exception $exception ) { if ( $exception instanceof CustomException) { // } parent::report( $exception ); }

report 辅助函数

有时候你可能需要报告一个异常并继续处理当前请求。辅助函数 report 允许你使用异常处理器的 report 方法快速报告一个异常而不会渲染错误页：

1 2 3 4 5 6 7 8 9 10 public function isValid( $value ) { try { // Validate the value... } catch (Exception $e ) { report( $e ); return false; } }

通过类型忽略异常

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

1 2 3 4 5 6 7 8 9 10 11 12 /** * 不应该被报告的异常类型列表. * * @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 响应。

默认情况下，异常被传递给为你生成响应的基类。当然，你也可以按照自己的需要检查异常类型或者返回自定义响应：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 /** * 将异常渲染到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 ); }

可报告 & 可渲染异常

除了在异常处理器的 report 和 render 方法中进行异常类型检查外，还可以在自定义异常中直接定义 report 和 render 方法。

当异常中存在这些方法时，框架会自动调用它们：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 <?php namespace App\Exceptions; use Exception; class RenderException extends Exception { /** * Report the exception. * * @return void */ public function report() { // } /** * Render the exception into an HTTP response. * * @param \Illuminate\Http\Request * @return \Illuminate\Http\Response */ public function render( $request ) { return response(...); } }

HTTP 异常

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

1	`abort(404);`

abort 辅助函数会立即引发一个会被异常处理器渲染的异常，此外，你还可以像这样提供响应描述：

1	`abort(403,` `'未授权操作'` `);`

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

自定义 HTTP 错误页面

在 Laravel 中，返回不同 HTTP 状态码的错误页面很简单，例如，如果你想要自定义 404 错误页面，创建一个 resources/views/errors/404.blade.php 文件，该视图文件用于渲染程序返回的所有 404 错误。

需要注意的是，该目录下的视图命名应该和相应的 HTTP 状态码相匹配。abort 函数触发的 HttpException 异常会以 $exception 变量的方式传递给视图：

1	`<h2>{{` `$exception` `->getMessage() }}</h2>`

日志

Laravel 基于强大的 Monolog 库提供了简单的日志抽象层，默认情况下，Laravel 的日志配置是为应用记录单个日志文件。

日志文件的存储位置是 storage/logs 目录。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 /* |-------------------------------------------------------------------------- | Logging Configuration |-------------------------------------------------------------------------- | | Here you may configure the log settings for your application. Out of | the box, Laravel uses the Monolog PHP logging library. This gives | you a variety of powerful log handlers / formatters to utilize. | | Available Settings: "single", "daily", "syslog", "errorlog" | */ 'log' => env( 'APP_LOG' , 'single' ), 'log_level' => env( 'APP_LOG_LEVEL' , 'debug' ),

应用运行过程中，所有级别大于或等于 debug 的错误日志都会被自动记录到 storage/logs 目录中。

也可以使用 Log 门面，手动记录日志信息。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 <?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);

上下文信息

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