Laravel异常上下文解决方案分享

 更新时间:2022年01月06日 16:14:46   作者:overtrue  
异常处理是编程中十分重要但也最容易被人忽视的语言特性,下面这篇文章主要给大家介绍了关于Laravel异常上下文解决方案的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下

前言

异常时我们通常希望在用户侧给一个友好的提示,但默认使用框架的异常处理方案是不 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异常上下文解决内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • PhpStorm 如何优雅的调试Hyperf的方法步骤

    PhpStorm 如何优雅的调试Hyperf的方法步骤

    这篇文章主要介绍了PhpStorm 如何优雅的调试Hyperf的方法步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-11-11
  • ThinkPHP的Widget扩展实例

    ThinkPHP的Widget扩展实例

    这篇文章主要介绍了ThinkPHP的Widget扩展 ,需要的朋友可以参考下
    2014-06-06
  • Laravel中前端js上传图片到七牛云的示例代码

    Laravel中前端js上传图片到七牛云的示例代码

    本篇文章主要介绍了Laravel中前端js上传图片到七牛云的示例代码,具有一定的参考价值,有兴趣的可以了解一下
    2017-09-09
  • php实现在站点里面添加邮件发送的功能

    php实现在站点里面添加邮件发送的功能

    开发了一个简单的空间管理系统,将所有的域名空间保存到数据库里面进行管理,在用户进行续费的时候就进行发送一个邮件来进行通知,然后我这边进行续费操作,正好用到一个邮件发送的功能,那如何实现邮件发送的功能
    2016-04-04
  • PHP Smarty生成EXCEL文档的代码

    PHP Smarty生成EXCEL文档的代码

    PHP结合Smarty产生EXCEL文档 1,首先在EXCEL (office 2003)里生成一个模板,然后存成 xml表格。 2,修改这个 xml 文件,做成 smarty 的模板。 3,然后,就是 绑定变量,输出就行了。
    2008-08-08
  • PHP中为什么使用file_get_contents("php://input")接收微信通知

    PHP中为什么使用file_get_contents("php://input")接收微信通知

    微信用户和公众号产生交互的过程中,用户的某些操作会使得微信服务器事件推送,通知到开发者中心设置的服务器地址(回调url),开发者可以获取到该信息。PHP中为什么使用file_get_contents("php://input")来接收呢?为什么有些场景php://input接收不到?
    2023-07-07
  • thinkPHP5.0框架应用请求生命周期分析

    thinkPHP5.0框架应用请求生命周期分析

    这篇文章主要介绍了thinkPHP5.0框架应用请求生命周期,较为详细的分析了thinkPHP5.0框架应用请求生命周期所涉及的各个执行流程,需要的朋友可以参考下
    2017-03-03
  • php版微信开发之接收消息,自动判断及回复相应消息的方法

    php版微信开发之接收消息,自动判断及回复相应消息的方法

    这篇文章主要介绍了php版微信开发之接收消息,自动判断及回复相应消息的方法,涉及基于微信消息处理接口的调用相关操作技巧,需要的朋友可以参考下
    2016-09-09
  • ajax在joomla中的原生态应用代码

    ajax在joomla中的原生态应用代码

    一般很少看到joomla中使用ajax,笔者以前说到过用jquery来实现,对于那些验证用户名不能重复,邮箱不能重复,以及联动菜单,等等的应用,使用ajax是免不了的
    2012-07-07
  • thinkPHP事务操作简单案例分析

    thinkPHP事务操作简单案例分析

    这篇文章主要介绍了thinkPHP事务操作,结合简单案例形式分析了thinkPHP事务操作的基本原理与使用方法,需要的朋友可以参考下
    2019-10-10

最新评论