如何重寫Laravel異常處理類詳解
現(xiàn)在開發(fā)前后端分離變得越來(lái)越流行了，后端只提供接口返回json格式的數(shù)據(jù)，即使是錯(cuò)誤信息也要以json格式來(lái)返回，然而目前無(wú)論是Laravel框架還是ThinkPHP框架，都只提供了返回json數(shù)據(jù)的方法，對(duì)異常的處理并不是以json格式來(lái)返回給我們，所以這里就需要我們自己來(lái)改寫。
首先我們?cè)赼pp/Exceptions目錄新建一個(gè)ExceptionHandler.php繼承自Handler.php
namespace App\Exceptions;
class ExceptionHandler extends Handler
{
}
然后我們?cè)赽ootstrap/app.php中，使用我們自定義的異常處理類ExceptionHandler替換掉默認(rèn)的Handler類
//改為我們自定義的ExceptionHandler類 $app->singleton( Illuminate\Contracts\Debug\ExceptionHandler::class, App\Exceptions\ExceptionHandler::class );
接下來(lái)我們就開始重寫渲染方法
在render方法里，我們根據(jù).env文件中的APP_DEBUG來(lái)判斷，如果是調(diào)試模式，我們還是按照默認(rèn)方式來(lái)渲染錯(cuò)誤，如果是非調(diào)試模式，我們就返回JSON格式的信息
namespace App\Exceptions;
use Exception;
class ExceptionHandler extends Handler
{
public function render($request, Exception $exception)
{
if (env('APP_DEBUG')) {
return parent::render($request, $exception);
}
return response()->json([
'code' => $exception->getCode(),
'msg' => $exception->getMessage()
]);
}
}
這樣我們就可以根據(jù)APP_DEBUG的值設(shè)置是否返回JSON格式的數(shù)據(jù)了，現(xiàn)在我們把.env的APP_DEBUG的值設(shè)為false來(lái)測(cè)試一下，然后我們故意把代碼寫錯(cuò)，通過(guò)postman或?yàn)g覽器來(lái)訪問(wèn)接口
Route::get('/', function () {
//這是一段缺少了分號(hào)的代碼，會(huì)報(bào)異常
echo 'Hello World!'
});
在APP_DEBUG=true的情況下還仍然是默認(rèn)渲染，方便我們查找錯(cuò)誤排錯(cuò)
異常類默認(rèn)會(huì)把異常以日志的形式記錄在storage/logs目錄下，并且以laravel-日期(YYYY-MM-DD)命名的形式，.log為后綴保存錯(cuò)誤日志
我們打開這個(gè)日志文件查看記錄的錯(cuò)誤信息，我們可以發(fā)現(xiàn)錯(cuò)誤信息記錄的非常詳細(xì)，除了錯(cuò)誤說(shuō)明之外，還記錄了調(diào)用棧，如下圖所示
基本上紅框里的信息就夠我們排錯(cuò)了，不需要像現(xiàn)在這樣記錄的這么詳細(xì)，所以要想不記錄調(diào)用棧，我們可以重寫report方法
首先我們看一下框架的report方法，代碼在(src/Illuminate/Foundation/Exceptions/Handler.php),我用紅框框起來(lái)的代碼就是調(diào)用棧信息，我們?cè)谥貙戇@個(gè)方法時(shí)只需要完全拷貝這個(gè)方法里的所有代碼到我們自定義的report方法里，然后把紅框里的代碼去掉即可
我們?cè)谖覀冏远x的異常處理類ExceptionHandler.php中重寫report方法
public function report(Exception $exception)
{
if ($this->shouldntReport($exception)) {
return;
}
if (Reflector::isCallable($reportCallable = [$exception, 'report'])) {
return $this->container->call($reportCallable);
}
try {
$logger = $this->container->make(LoggerInterface::class);
} catch (Exception $ex) {
throw $exception;
}
$logger->error(
$exception->getMessage()
);
}
然后我們?cè)僦匦抡?qǐng)求一下接口再去查看錯(cuò)誤日志的記錄，可以發(fā)現(xiàn)確實(shí)沒有記錄調(diào)用棧信息了，但是下面的信息還是不夠，我們沒法根據(jù)下面的信息判斷錯(cuò)誤發(fā)生在哪一個(gè)文件和哪一行，如果能在記錄錯(cuò)誤信息的時(shí)候同時(shí)記錄發(fā)生錯(cuò)誤的文件和行就更好了，所以借著修改report方法
public function report(Exception $exception)
{
if ($this->shouldntReport($exception)) {
return;
}
if (Reflector::isCallable($reportCallable = [$exception, 'report'])) {
return $this->container->call($reportCallable);
}
try {
$logger = $this->container->make(LoggerInterface::class);
} catch (Exception $ex) {
throw $exception;
}
$logger->error(
$exception->getMessage()." at ".$exception->getFile().":".$exception->getLine()
);
}
在代碼里我通過(guò)exception的getFile()、getLine()方法加上了文件和行數(shù)，保存代碼再次訪問(wèn)接口，查看錯(cuò)誤日志文件我們可以看到發(fā)生錯(cuò)誤的文件和行數(shù)已經(jīng)記錄下來(lái)了，有了這些信息基本我們就可以找到錯(cuò)誤
截止到這里實(shí)現(xiàn)最初的需求我們的ExceptionHandler.php只需要有這些代碼
namespace App\Exceptions;
use Exception;
use Illuminate\Support\Reflector;
use Psr\Log\LoggerInterface;
class ExceptionHandler extends Handler
{
public function render($request, Exception $exception)
{
if (env('APP_DEBUG')) {
return parent::render($request, $exception);
}
return response()->json([
'code' => $exception->getCode(),
'msg' => $exception->getMessage()
]);
}
public function report(Exception $exception)
{
if ($this->shouldntReport($exception)) {
return;
}
if (Reflector::isCallable($reportCallable = [$exception, 'report'])) {
return $this->container->call($reportCallable);
}
try {
$logger = $this->container->make(LoggerInterface::class);
} catch (Exception $ex) {
throw $exception;
}
$logger->error(
$exception->getMessage()." at ".$exception->getFile().":".$exception->getLine()
);
}
}
然后還不夠，我們發(fā)現(xiàn)剛剛我們把服務(wù)器端的錯(cuò)誤信息以JSON格式返回給客戶端了，這是不允許的，我們應(yīng)該只把一些客戶端錯(cuò)誤返回給客戶端，比如密碼不足六位、身份證不合法諸如此類，而服務(wù)端出現(xiàn)錯(cuò)誤時(shí)我們只返回給客戶端一個(gè)模糊的信息即可，比如“服務(wù)器錯(cuò)誤”，把真實(shí)的服務(wù)器錯(cuò)誤信息記錄在日志里面方便開發(fā)人員排查錯(cuò)誤
所以我們需要定義一個(gè)客戶端異常專門用戶返回客戶端錯(cuò)誤,使用如下命令在app/Exceptions目錄下生成一個(gè)ClientException.php文件
php artisan make:exception ClientException
修改為構(gòu)造方法為如下代碼
namespace App\Exceptions;
use Exception;
class ClientException extends Exception
{
public function __construct($code, $msg)
{
parent::__construct($msg, $code);
}
}
接著我們繼續(xù)修改ExceptionHandler.php
namespace App\Exceptions;
use Exception;
use Illuminate\Support\Reflector;
use Psr\Log\LoggerInterface;
class ExceptionHandler extends Handler
{
/**
* @var int 錯(cuò)誤碼
*/
protected $code;
/**
* @var string 錯(cuò)誤信息
*/
protected $message;
protected $dontReport = [
ClientException::class
];
public function render($request, Exception $exception)
{
if ($exception instanceof ClientException) {
$this->code = $exception->getCode();
$this->message = $exception->getMessage();
} else {
if (env('APP_DEBUG')) {
return parent::render($request, $exception);
}
$this->code = 500;
$this->message = '服務(wù)器錯(cuò)誤';
}
return response()->json([
'code' => $this->code,
'msg' => $this->message
]);
}
public function report(Exception $exception)
{
if ($this->shouldntReport($exception)) {
return;
}
if (Reflector::isCallable($reportCallable = [$exception, 'report'])) {
return $this->container->call($reportCallable);
}
try {
$logger = $this->container->make(LoggerInterface::class);
} catch (Exception $ex) {
throw $exception;
}
$logger->error(
$exception->getMessage()." at ".$exception->getFile().":".$exception->getLine()
);
}
}
對(duì)于上面的修改做一下說(shuō)明，laravel的$dontReport屬性的異常類都不會(huì)被上報(bào)，因?yàn)榭蛻舳隋e(cuò)誤信息我們不需要記錄，所以將其添加到$dontReport屬性里，并且在render方法里把異常大概分為了兩大類，一大類就是客戶端異常，另一大類就是服務(wù)器異常，我們把服務(wù)器異常統(tǒng)一code為500，錯(cuò)誤信息為服務(wù)器錯(cuò)誤，將真實(shí)的錯(cuò)誤信息記錄在了錯(cuò)誤日志里，避免把服務(wù)器信息暴露給了客戶端。
現(xiàn)在我們來(lái)測(cè)試我們重寫異常的結(jié)果
假如我們想返回客戶端異常，比如沒有權(quán)限,這類客戶端異常在錯(cuò)誤日志里都不會(huì)產(chǎn)生記錄，我們本身也不需要記錄
Route::get('/', function () {
throw new \App\Exceptions\ClientException(403, '你沒有權(quán)限');
});
對(duì)于服務(wù)器端的錯(cuò)誤，如少些了分號(hào),客戶端就只會(huì)知道服務(wù)器的某個(gè)接口出了問(wèn)題，但是不清楚具體問(wèn)題是什么
Route::get('/', function () {
echo 'Hello World!'
});
但是真實(shí)的錯(cuò)誤信息會(huì)記錄在錯(cuò)誤日志里，我們?nèi)耘f可以通過(guò)錯(cuò)誤日志來(lái)修改我們服務(wù)端的錯(cuò)誤
我們還可以在render方法中加入告警代碼，如果是服務(wù)端錯(cuò)誤就給管理員發(fā)送郵件。
至此，我們的重寫Laravel異常處理類就算完成啦，希望對(duì)正在準(zhǔn)備使用Laravel做前后端分離項(xiàng)目的你有所幫助。
到此這篇關(guān)于如何重寫Laravel異常處理類的文章就介紹到這了,更多相關(guān)重寫Laravel異常處理類內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
laravel框架實(shí)現(xiàn)后臺(tái)登錄、退出功能示例
這篇文章主要介紹了laravel框架實(shí)現(xiàn)后臺(tái)登錄、退出功能,結(jié)合實(shí)例形式詳細(xì)分析了Laravel框架后臺(tái)登錄、退出相關(guān)的請(qǐng)求發(fā)送、驗(yàn)證、session讀寫與刪除等相關(guān)操作技巧,需要的朋友可以參考下2019-10-10
這篇文章主要介紹了PHP保存帶BOM文件的方法,本文相當(dāng)簡(jiǎn)短,因?yàn)榉椒ㄒ埠芎?jiǎn)單,不需要過(guò)多描述,需要的朋友可以參考下2015-02-02
這篇文章主要為大家詳細(xì)介紹了搜索附近的人PHP實(shí)現(xiàn)代碼，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2018-02-02
php分頁(yè)思路以及在Zend?Framework框架中的使用
php分頁(yè)思路以及在Zend?Framework框架中的使用,需要的朋友可以參考下2012-05-05
實(shí)例講解php數(shù)據(jù)訪問(wèn)
這篇文章主要以實(shí)例講解的方式為大家詳細(xì)介紹了php數(shù)據(jù)訪問(wèn)，數(shù)據(jù)訪問(wèn)有兩種方式，本文為大家揭曉，感興趣的小伙伴們可以參考一下2016-05-05
Yii實(shí)現(xiàn)簡(jiǎn)單分頁(yè)的方法
這篇文章主要介紹了Yii實(shí)現(xiàn)簡(jiǎn)單分頁(yè)的方法,涉及Yii模型調(diào)用讀取數(shù)據(jù)及視圖操作相關(guān)技巧,需要的朋友可以參考下2016-04-04
jQuery向下滾動(dòng)即時(shí)加載內(nèi)容實(shí)現(xiàn)的瀑布流效果
下拉滾動(dòng)條或鼠標(biāo)滾輪滾動(dòng)到頁(yè)面底部時(shí)， 動(dòng)態(tài)即時(shí)加載新內(nèi)容，通過(guò)本文給大家介紹jQuery向下滾動(dòng)即時(shí)加載內(nèi)容實(shí)現(xiàn)的瀑布流效果，感興趣的朋友參考下2016-01-01
php 多文件上傳的實(shí)現(xiàn)實(shí)例
在php中，實(shí)現(xiàn)文件上傳時(shí)一個(gè)很簡(jiǎn)單的事情，但是如果我們要一次上傳多個(gè)文件，那又該如何編寫代碼呢？,需要的朋友可以參考下2016-10-10
php-fpm重啟導(dǎo)致的程序執(zhí)行中斷問(wèn)題詳解
這篇文章主要給大家介紹了關(guān)于php-fpm重啟導(dǎo)致的程序執(zhí)行中斷問(wèn)題的相關(guān)資料，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-04-04
這篇文章主要介紹了thinkphp模板用法和內(nèi)容輸出,以實(shí)例形式分析了模板的常見用法與使用過(guò)程中經(jīng)常遇到的問(wèn)題以及內(nèi)容輸出的各種技巧,對(duì)于ThinkPHP開發(fā)具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2014-11-11