错误&日志
1、简介
Laravel默认已经为我们配置好了错误和异常处理,此外,Laravel还集成了Monolog日志库以便提供多种功能强大的日志处理器。
2、配置
错误详情显示
配置文件config/app.php
中的debug
配置选项控制浏览器显示的错误详情数量。默认情况下,该配置选项被设置在.env
文件中的环境变量APP_DEBUG
。
对本地开发而言,你应该设置环境变量APP_DEBUG
值为true
。在生产环境,该值应该被设置为false
。
日志模式
Laravel支持日志方法single
, daily
, syslog
和 errorlog
。例如,如果你想要日志文件按日生成而不是生成单个文件,应该在配置文件config/app.php
中设置log
值如下:
'log' => 'daily'
自定义Monolog配置
如果你想要在应用中完全控制Monolog的配置,可以使用应用的configureMonologUsing
方法。你应该在bootstrap/app.php
文件返回$app
变量之前调用该方法:
$app->configureMonologUsing(function($monolog) {
$monolog->pushHandler(...);
});
return $app;
3、异常处理器
所有异常都由类App\Exceptions\Handler
处理,该类包含两个方法:report
和render
。下面我们详细阐述这两个方法。
3.1 report方法
report
方法用于记录异常并将其发送给外部服务如Bugsnag。默认情况下,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
错误异常不会被写到日志文件,如果需要的话你可以添加其他异常类型到这个数组。
3.2 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(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有多个可用于日志的处理器,如果需要的话,你可以访问底层Monolog实例:
$monolog = Log::getMonolog();
14 Comments
调试/Debug、信息/Info、提示/Notice、警告/Warning、错误/Error、严重/Critical、警报/Alert、紧急/Emergency,mark一下