一种 Laravel 异常上下文解决方案

最近项目遇到一个情况,我们在遇到用户访问某个信息没有权限的时候,希望提示详细的原因,比如当访问一个团队资源时非成员访问的场景下会提示一个:您不是 [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, '您无权访问该资源');

问题到这里总算以一个比较完美的方式解决了,如果你有更好的方案欢迎评论探讨。

本作品采用《CC 协议》,转载必须注明作者和本文链接
本帖由系统于 3个月前 自动加精
《L02 从零构建论坛系统》
以构建论坛项目 LaraBBS 为线索,展开对 Laravel 框架的全面学习。应用程序架构思路贴近 Laravel 框架的设计哲学。
《L05 电商实战》
从零开发一个电商项目,功能包括电商后台、商品 & SKU 管理、购物车、订单管理、支付宝支付、微信支付、订单退款流程、优惠券等
讨论数量: 16
yjrowe

大佬牛逼

3个月前 评论
godruoyi

距离上一篇文章已经一年了,超哥终于来产出了 :speak_no_evil:

不过要是这样返回,怎么区分呢,比如团队成员试图修改项目信息,这时候可能也会返回 403,那前端同事如何处理呢?

HTTP/1.0 403 Forbidden

{
    "message": "您无权访问该资源",
    "code": 4030010  // 是不是加个错误码好些
    "team": {
        "id": "abxT8sioa0Ms",
        "name": "CoDesign****"
    }
}
3个月前 评论

@godruoyi 已经明确的知道我在操作一个什么对象的时候,直接 403 + message 足以表达原因,本文举例的场景是当我访问不了,也不知道这个链接背后是什么内容时,显示一些辅助信息用于访客接下来寻找解决方案。所以你这种情况我们会直接用 message 表达就足够了。

3个月前 评论
godruoyi

@overtrue 不,我的意思是因为你可能在多个地方都返回 403 response,而前端同事的错误处理基本都是拦截器里实现的,那是不是意味着前端同事得根据下面这种方式来判断如何提示呢?

axios.interceptors.response.use(function (response) {
    return response;
}, function (error) {
    if (error.response.status == 403) {
        if (error.response.team) {// 那是不是意味这前端同事只能依靠这个 team 来判断呢
            // 执行带 button 的错误提示
        } else {
           // 执行基本的只带错误消息的错误提示
        }
    }         
    return Promise.reject(error);
});
3个月前 评论
overtrue (楼主) 3个月前
godruoyi (作者) 3个月前

嗐... 进厂后产出明显少了许多...

3个月前 评论

超哥 我现在用的解决方案是注解 抛出异常即可 如果用about的话 是可以满足很多带有参数的错误消息抑制


$className = get_class($exception);
        if (Str::contains($className, 'App\\Exceptions')) {
            $code = (string)$exception->getMessage();
            $class = get_class($exception);
            $ref = new \ReflectionClass($exception);
            $constants = array_flip($ref->getConstants());
            $message = $constants[$code];
            if ($message) {
                $doc = $ref->getReflectionConstant($message)->getDocComment();
                preg_match("/Message\(\'(.*?)\'\)(\\r\\n|\\r|\\n)/U", $doc, $doc);
                $code = $exception->getMessage();

                $errMsg = $doc[1];

                if (!empty($errMsg)) {
                    return Response::fail($code, $errMsg, []);
                }
            }
        }

用的时候 直接抛出 throw new UserException(UserException::MOBILE_IS_EXISTS );

    /**
     * @Message('用户名已经存在')
     */
    const MOBILE_IS_EXISTS = '130000000';

不过不支持携带其他参数了 仅仅支持 直接返回错误并且回头修改错误提示的时候可以直接修改后端的注释就好

希望超哥点评一手 下次去腾讯面试的时候也好 tree new bee

3个月前 评论

@xiaochen52113 性能会不会有问题,如果你这种定错误码,感觉直接弄一个配置文件是不是更方便一些?

3个月前 评论

@overtrue 注解并不慢. 测试的话还不错,可能是我这边项目不大 如果真在意性能的话,注解可以做缓存,也有对应的方案,不过我开发环境,懒得做缓存 超哥有空可以试试

3个月前 评论

我的方式 :stuck_out_tongue_winking_eye: 因为直接http状态码,我觉得前端难判断,我是直接和前端约定好了自定义的状态码

if (Request::ajax()) {
    $response =  response()->json([
            'code' => $code,
            'msg' => $message,
    ]);
    throw new HttpResponseException($response);
} else {
    throw new ErrorExceptions($message, $code);
}
3个月前 评论
aa24615 1个月前
秦晓武
  1. 实现
  2. 优化
  3. 复用

过程清晰明了,在特定的场景,利用现有的工具,快速实现想要的结果。

怎么写代码不重要,怎么思考,怎么把思维进行实现,才是此文章的核心。

3个月前 评论

思路清晰,分析透彻 👍

注意到 Laravel 官方提供 Renderable 接口,
NotTeamMemberException 实现 Renderable 接口,是不是更优雅?

好奇为什么 Handler::render() 中没采用 $e instanceof Renderable 而是用 method_exists($e, 'render')

3个月前 评论
LiamHao 3个月前
好好先森V5 (作者) 3个月前
gema 1个月前

乍一看还以为超哥又发论文了

3个月前 评论
小李世界

慕名前来手动四连,点赞、收藏、评论、关注 :see_no_evil:

3个月前 评论

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!