Laravel異常上下文解決方案分享

Posted on by

前言

異常時我們通常希望在用戶側給一個友好的提示，但默認使用框架的異常處理方案是不 OK 的。

最近項目遇到一個情況，我們在遇到用戶訪問某個信息沒有權限的時候，希望提示詳細的原因，比如當訪問一個團隊資源時非成員訪問的場景下會提示一個：您不是 [xxxxxx] 團隊的成員，暫時無法查看，可<申請加入>，同時需要顯示打碼後的團隊名稱，以及加入按鈕，可是接口方的邏輯是當沒有權限時直接 abort 瞭：

abort_if(!$user->isMember($resouce->team), 403, '您無權訪問該資源');

得到的響應結果如下：

HTTP/1.0 403 Forbidden

{
	"message": "您無權訪問該資源"
}

我們不可能將 message 用 html 來完成前端提示頁的展示，這樣耦合性太強，違背瞭前後端分離的原則。我們的目標是返回如下的格式即可解決：

HTTP/1.0 403 Forbidden

{
	"message": "您無權訪問該資源",
	"team": {
		"id": "abxT8sioa0Ms",
		"name": "CoDesign****"
	}
}

通過攜帶上下文的方法傳遞數據，方便瞭前端同學自由組合。

開始改造

當然這並不是什麼復雜的事情，直接修改原來的 abort_if 即可解決：

- abort_if(!$user->isMember($resouce->team), 403, '您無權訪問該資源');
+ if (!$user->isMember($resouce->team)) {
+	return response()->json([
+		'message' => '您無權訪問該資源',
+		'team' => [
+			'id' => $resouce->team_id,
+			'name'=> $resouce->team->desensitised_name,
+		]
+	], 403);
+ }

這樣看起來解決瞭問題，可是試想一下，如果是在閉包裡面檢測到異常想要退出，上面這種 return 式的寫法就會比較難搞瞭，畢竟 return 隻會終止最近的上下文環境，我們還是希望像 abort 一樣能終止整個應用的執行，再進行另一番改造。

優化實現

看瞭 abort 源碼，我發現它的第一個參數其實支持 \Symfony\Component\HttpFoundation\Response 實例，而上面👆我們 return 的結果就是它的實例，所以我們隻需要改成這樣就可以瞭：

 if (!$user->isMember($resouce->team)) {
	abort(response()->json([
		'message' => '您無權訪問該資源',
		'team' => [
			'id' => $resouce->team_id,
			'name'=> $resouce->team->desensitised_name,
		]
	], 403));
 }

新的問題來瞭，如果需要復用的時候還是比較尷尬，這段代碼將會重復出現在各種有此權限判斷的地方，這並不是我們想要的。

邏輯復用

為瞭達到邏輯復用，我認證看瞭 \App\Exceptions\Handler 的實現，發現父類的 render 方法還有這麼一個設計：

public function render($request, Throwable $e)
{
    if (method_exists($e, 'render') && $response = $e->render($request)) {
        return Router::toResponse($request, $response);
    } elseif ($e instanceof Responsable) {
        return $e->toResponse($request);
    }

    //...

所以，我們可以將這個邏輯抽離為一個獨立的異常類，實現 render 方法即可：

$ ./artisan make:exception NotTeamMemberException

代碼如下：

<?php

namespace App\Exceptions;

use App\Team;

class NotTeamMemberException extends \Exception
{
    public Team $team;

    public function __construct(Team $team, $message = "")
    {
        $this->team = $team;
        parent::__construct($message, 403);
    }

    public function render()
    {
        return response()->json(
            [
                'message' => !empty($this->message) ? $this->message : '您無權訪問該資源',
                'team' => [
                    'id' => $this->team->id,
                    'name' => $this->team->desensitised_name,
                ],
            ],
            403
        );
    }
}

這樣一來，我們的邏輯就變成瞭：

if (!$user->isMember($resouce->team)) {
 	throw new NotTeamMemberException($resouce->team, '您無權訪問該資源');
}

當然也可以簡化為：

\throw_if(!$user->isMember($resouce->team), NotTeamMemberException::class, $resouce->team, '您無權訪問該資源');

問題到這裡總算以一個比較完美的方式解決瞭，如果你有更好的方案歡迎評論探討。

總結

到此這篇關於Laravel異常上下文解決方案的文章就介紹到這瞭,更多相關Laravel異常上下文解決內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：