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