欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  后端开发

[ Lumen 5.2 文档 ] 更多特性 -- 错误 & 日志

程序员文章站 2022-06-06 11:09:19
...

1、简介

开始一个新的Lumen项目的时候,错误和异常处理已经默认为你配置好了。此外,Lumen还集成了提供各种功能强大日志处理器的Monolog日志库。

2、配置

错误详情

配置文件 .env中的 APP_DEBUG配置选项控制浏览器显示的错误详情数量。

对本地开发而言,你应该设置环境变量 APP_DEBUG值为 true。在生产环境,该值应该被设置为 false。

自定义Monolog配置

如果你想要完全控制Monolog的配置,可以使用 configureMonologUsing方法,并且需要在 bootstrap/app.php中调用该方法:

$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.');

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

5、日志

Lumen日志工具基于强大的 Monolog库,默认情况下,Lumen被配置为在 storage/logs目录下每日为应用生成日志文件,你可以使用 Log门面编写日志信息到日志中:

 User::findOrFail($id)]);    }}

该日志记录器提供了 RFC 5424中定义的七种日志级别: alert, critical, error, warning, notice, infodebug

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]);