Laravel異常上下文解決方案

這篇文章主要介紹了Laravel異常上下文解決方案，具有一定借鑒價(jià)值，感興趣的朋友可以參考下，希望大家閱讀完這篇文章之后大有收獲，下面讓小編帶著大家一起了解一下。

最近項(xiàng)目遇到一個(gè)情況，我們?cè)谟龅接脩粼L問(wèn)某個(gè)信息沒(méi)有權(quán)限的時(shí)候，希望提示詳細(xì)的原因，比如當(dāng)訪問(wèn)一個(gè)團(tuán)隊(duì)資源時(shí)非成員訪問(wèn)的場(chǎng)景下會(huì)提示一個(gè)：您不是 [xxxxxx] 團(tuán)隊(duì)的成員，暫時(shí)無(wú)法查看，可<申請(qǐng)加入>，同時(shí)需要顯示打碼后的團(tuán)隊(duì)名稱，以及加入按鈕，可是接口方的邏輯是當(dāng)沒(méi)有權(quán)限時(shí)直接 abort 了：

abort_if(!$user->isMember($resouce->team), 403, '您無(wú)權(quán)訪問(wèn)該資源');

得到的響應(yīng)結(jié)果如下：

HTTP/1.0 403 Forbidden{
    "message": "您無(wú)權(quán)訪問(wèn)該資源"}

我們不可能將 message 用 html 來(lái)完成前端提示頁(yè)的展示，這樣耦合性太強(qiáng)，違背了前后端分離的原則。我們的目標(biāo)是返回如下的格式即可解決：

HTTP/1.0 403 Forbidden{
    "message": "您無(wú)權(quán)訪問(wèn)該資源",
    "team": {
        "id": "abxT8sioa0Ms",
        "name": "CoDesign****"
    }}

通過(guò)攜帶上下文的方法傳遞數(shù)據(jù)，方便了前端同學(xué)自由組合。

開始改造

當(dāng)然這并不是什么復(fù)雜的事情，直接修改原來(lái)的 abort_if 即可解決：

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

這樣看起來(lái)解決了問(wèn)題，可是試想一下，如果是在閉包里面檢測(cè)到異常想要退出，上面這種 return 式的寫法就會(huì)比較難搞了，畢竟 return 只會(huì)終止最近的上下文環(huán)境，我們還是希望像 abort 一樣能終止整個(gè)應(yīng)用的執(zhí)行，再進(jìn)行另一番改造。

優(yōu)化實(shí)現(xiàn)

看了 abort 源碼，我發(fā)現(xiàn)它的第一個(gè)參數(shù)其實(shí)支持 \Symfony\Component\HttpFoundation\Response 實(shí)例，而上面我們 return 的結(jié)果就是它的實(shí)例，所以我們只需要改成這樣就可以了：

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

看起來(lái)實(shí)現(xiàn)了異常中斷，可是新的問(wèn)題來(lái)了，如果需要復(fù)用的時(shí)候還是比較尷尬，這段代碼將會(huì)重復(fù)出現(xiàn)在各種有此權(quán)限判斷的地方，這并不是我們想要的。

邏輯復(fù)用

為了達(dá)到邏輯復(fù)用，看了 \App\Exceptions\Handler 的實(shí)現(xiàn)，發(fā)現(xiàn)父類的 render 方法還有這么一個(gè)設(shè)計(jì)：

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);
    }
    //...

所以，我們可以將這個(gè)邏輯抽離為一個(gè)獨(dú)立的異常類，實(shí)現(xiàn) render 方法即可：

我們先創(chuàng)建一個(gè)異常類：

$ ./artisan make:exception NotTeamMemberException

實(shí)現(xiàn)代碼如下：

<?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 : '您無(wú)權(quán)訪問(wèn)該資源',
                'team' => [
                    'id' => $this->team->id,
                    'name' => $this->team->desensitised_name,
                ],
            ],
            403
        );
    }
}

這樣一來(lái)，我們的邏輯就變成了：

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

當(dāng)然也可以簡(jiǎn)寫為：

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

感謝你能夠認(rèn)真閱讀完這篇文章，希望小編分享的“Laravel異常上下文解決方案”這篇文章對(duì)大家有幫助，同時(shí)也希望大家多多支持億速云，關(guān)注億速云行業(yè)資訊頻道，更多相關(guān)知識(shí)等著你來(lái)學(xué)習(xí)!