Laravel 5.5 異常處理 & 錯誤日志的解決
簡介
Laravel 默認(rèn)已經(jīng)為我們配置好了錯誤和異常處理,我們在 App\Exceptions\Handler 類中觸發(fā)異常并將響應(yīng)返回給用戶。
此外,Laravel 還集成了 Monolog 日志庫以便提供各種功能強大的日志處理器,默認(rèn)情況下,Laravel 已經(jīng)為我們配置了一些處理器,我們可以選擇單個日志文件,也可以選擇記錄錯誤信息到系統(tǒng)日志。
配置
調(diào)試模式
配置文件 config/app.php 中的 debug 配置項表示是否開啟調(diào)試模式,調(diào)試模式下會將錯誤信息直接暴露給客戶端。
默認(rèn)情況下,該配置項通過 .env 文件中的環(huán)境變量 APP_DEBUG 進(jìn)行設(shè)置,默認(rèn)值為 true ,即開啟調(diào)試模式。
對本地開發(fā)而言,你應(yīng)該設(shè)置環(huán)境變量 APP_DEBUG 值為 true。在生產(chǎn)環(huán)境,該值應(yīng)該被設(shè)置為 false。如果在生產(chǎn)環(huán)境被設(shè)置為 true,就有可能將一些敏感的信息暴露給終端用戶。
日志存儲
Laravel 支持的日志文件類型為 single, daily, syslog 和 errorlog。
single: 所有的日志信息會記錄到單個日志文件里。
daily:按天生成日志文件。
syslog: 通過系統(tǒng) syslog 服務(wù)處理日志信息。
errorlog: 通過 PHP error_log 處理器處理日志信息。
如果你想要日志文件按天生成而不是生成并記錄到單個文件,應(yīng)該在配置文件 config/app.php 中設(shè)置 log 值如下:
'log' => 'daily'
注:底層處理機制可以參考 Illuminate\Log\LogServiceProvider 中的實現(xiàn)邏輯。
日志文件最大生命周期
使用 daily 日志模式的時候,Laravel 默認(rèn)最多為我們保留最近 5 天的日志,如果你想要修改這個時間,需要添加一個配置 log_max_files 到 app 配置文件:
'log_max_files' => 30
日志錯誤級別
使用 Monolog 的時候,日志消息可能有不同的錯誤級別,默認(rèn)情況下,Laravel 將所有級別日志寫到存儲器,但是在生產(chǎn)環(huán)境中,你可能想要配置最低錯誤級別,這可以通過在配置文件 app.php 中添加配置項 log_level 來實現(xiàn)。
該配置項被配置后,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 配置
如果你想要在應(yīng)用中完全控制 Monolog 的配置,可以使用configureMonologUsing 方法。你需要在 bootstrap/app.php 文件返回 $app 變量之前調(diào)用該方法:
$app->configureMonologUsing(function($monolog) { $monolog->pushHandler(...); }); return $app;
自定義頻道名稱
默認(rèn)情況下,Monolog 會通過一個與當(dāng)前環(huán)境匹配的名字進(jìn)行實例化,例如 production 或 local。如果想修改這個值,需要添加 log_channel 配置項到配置文件 config/app.php:
'log_channel' => env('APP_LOG_CHANNEL', 'my-app-name'),
異常處理器
所有異常都由類 App\Exceptions\Handler 處理,該類包含兩個方法:report 和 render。
report 方法
report 方法用于記錄異常并將其發(fā)送給外部服務(wù)如 Bugsnag 或 Sentry。
默認(rèn)情況下,report 方法只是將異常傳遞給異常被記錄的基類,當(dāng)然你也可以按自己的需要記錄異常并進(jìn)行相關(guān)處理。
例如,如果你需要以不同方式報告不同類型的異常,可使用 PHP 的 instanceof 操作符:
/** * 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 輔助函數(shù)
有時候你可能需要報告一個異常并繼續(xù)處理當(dāng)前請求。輔助函數(shù) report 允許你使用異常處理器的 report 方法快速報告一個異常而不會渲染錯誤頁:
public function isValid($value) { try { // Validate the value... } catch (Exception $e) { report($e); return false; } }
通過類型忽略異常
異常處理器的 $dontReport 屬性包含一個不會被記錄的異常類型數(shù)組,默認(rèn)情況下,404 錯誤異常不會被寫到日志文件,如果需要的話你可以添加其他異常類型到這個數(shù)組:
/** * 不應(yīng)該被報告的異常類型列表. * * @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 方法負(fù)責(zé)將給定異常轉(zhuǎn)化為發(fā)送給瀏覽器的 HTTP 響應(yīng)。
默認(rèn)情況下,異常被傳遞給為你生成響應(yīng)的基類。當(dāng)然,你也可以按照自己的需要檢查異常類型或者返回自定義響應(yīng):
/** * 將異常渲染到HTTP響應(yīng)中 * * @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 方法中進(jìn)行異常類型檢查外,還可以在自定義異常中直接定義 report 和 render 方法。
當(dāng)異常中存在這些方法時,框架會自動調(diào)用它們:
<?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 異常
有些異常描述來自服務(wù)器的 HTTP 錯誤碼,例如,這可能是一個“頁面未找到”錯誤(404),“認(rèn)證失敗錯誤”(401)亦或是程序出錯造成的500錯誤,為了在應(yīng)用中生成這樣的響應(yīng),可以使用 abort 輔助函數(shù):
abort(404);
abort 輔助函數(shù)會立即引發(fā)一個會被異常處理器渲染的異常,此外,你還可以像這樣提供響應(yīng)描述:
abort(403, '未授權(quán)操作');
該方法可在請求生命周期的任何時間點使用。
自定義 HTTP 錯誤頁面
在 Laravel 中,返回不同 HTTP 狀態(tài)碼的錯誤頁面很簡單,例如,如果你想要自定義 404 錯誤頁面,創(chuàng)建一個 resources/views/errors/404.blade.php 文件,該視圖文件用于渲染程序返回的所有 404 錯誤。
需要注意的是,該目錄下的視圖命名應(yīng)該和相應(yīng)的 HTTP 狀態(tài)碼相匹配。abort 函數(shù)觸發(fā)的 HttpException 異常會以 $exception 變量的方式傳遞給視圖:
<h2>{{ $exception->getMessage() }}</h2>
日志
Laravel 基于強大的 Monolog 庫提供了簡單的日志抽象層,默認(rèn)情況下,Laravel 的日志配置是為應(yīng)用記錄單個日志文件。
日志文件的存儲位置是 storage/logs 目錄。
/* |-------------------------------------------------------------------------- | 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'),
應(yīng)用運行過程中,所有級別大于或等于 debug 的錯誤日志都會被自動記錄到 storage/logs 目錄中。
也可以使用 Log 門面,手動記錄日志信息。
<?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);
上下文信息
上下文數(shù)據(jù)也會以數(shù)組形式傳遞給日志方法,然后和日志消息一起被格式化和顯示:
Log::info('User failed to login.', ['id' => $user->id]);
訪問底層 Monolog 實例
Monolog 有多個可用于日志的處理器,如果需要的話,你可以訪問 Laravel 使用的底層 Monolog 實例:
$monolog = Log::getMonolog();
以上這篇Laravel 5.5 異常處理 & 錯誤日志的解決就是小編分享給大家的全部內(nèi)容了,希望能給大家一個參考,也希望大家多多支持腳本之家。
相關(guān)文章
分享PHP函數(shù)實現(xiàn)數(shù)字與文字分頁代碼
這篇文章主要介紹了PHP函數(shù)實現(xiàn)數(shù)字與文字分頁代碼,定義分頁函數(shù)_paging,在核心函數(shù)庫包裝代碼,需要的朋友可以參考下2015-07-07php處理靜態(tài)頁面:頁面設(shè)置緩存時間實例
本篇文章主要介紹了php處理靜態(tài)頁面:頁面設(shè)置緩存時間實例,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2017-06-06Laravel5.1 框架模型多態(tài)關(guān)聯(lián)用法實例分析
這篇文章主要介紹了Laravel5.1 框架模型多態(tài)關(guān)聯(lián)用法,結(jié)合實例形式分析了laravel5.1框架模型多態(tài)關(guān)聯(lián)具體實現(xiàn)、使用方法與操作注意事項,需要的朋友可以參考下2020-01-01詳解laravel passport OAuth2.0的4種模式
這篇文章主要介紹了laravel passport OAuth2.0的4種模式,本文給大家介紹的非常詳細(xì),具有一定的參考借鑒價值,需要的朋友可以參考下2019-11-11讓CodeIgniter數(shù)據(jù)庫緩存自動過期的處理的方法
按官方的說法,緩存設(shè)置后永不過期,除非你調(diào)用方法主動刪除。這篇文章主要介紹了CodeIgniter數(shù)據(jù)庫緩存自動過期的處理,需要的朋友可以參考下2014-06-06PHP中把數(shù)據(jù)庫查詢結(jié)果輸出為json格式簡單實例
這篇文章主要介紹了PHP中把數(shù)據(jù)庫查詢結(jié)果輸出為json格式簡單實例,本文直接給出示例代碼,都是非?;A(chǔ)的寫法,大家應(yīng)該一看就明白,需要的朋友可以參考下2015-04-04PHP如何實現(xiàn)阿里云短信sdk靈活應(yīng)用在項目中的方法
這篇文章主要介紹了PHP如何實現(xiàn)阿里云短信sdk靈活應(yīng)用在項目中的方法,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2019-06-06