tp5 API 自定义全局异常处理(上)

我们接着重构 tp5 参数校验层的项目进行下面的代码:
在全局异常处理之前,我们先来实现一下 Banner 控制器的功能:
我们在 controller 的同级目录下新建一个 model 文件夹。在其下面新建一个 Banner 类。
(这里为了简洁,我们的控制器类和业务类都叫做 Banner,我们通过所属在不同的文件夹下进行区分即可)

<?php

namespace app\api\model;

class Banner{
  public static function getBannerById($id){
    //TODO: 根据 Banner ID 号,获取 Banner 信息
    return 'banner info';
  }
}

接着我们进行编辑控制器的类。由于控制器和业务类重名,所以需要在引入的时候注意:

<?php

namespace app\api\controller\v1;

use app\api\validate\IDMustBePositiveInt;
use app\api\model\Banner as BannerModel;

class Banner{
  public function getBanner($id){
    (new IDMustBePositiveInt())->goCheck();
    
    $banner = BannerModel::getBannerByID($id);
    return $banner;
  }
}

现在我们来假设这一种情况,客户端传来了 id 为 50,由于 50 是正整数,所以通过了参数校验,但我们的数据库中没有 id 号为 50 的 banner,这时候我们就需要进行相应的异常处理。
为了进行演示我们在 model\Banner 中加入以下错误的代码:

try{
  1/0;
}
catch(Exception $e){
  throw $e;
}

现在我们在业务类中抛出了异常,假如我们控制器中不做处理,那么就会抛给全局异常处理器处理,并返回以下 html 页面:

错误信息的 html 截图

这个页面适合后端调试,但是不适合给客户端来看,尤其是作为接口的返回来说。
有的人可能会说,返回 html 是因为开启了 tp5 调试模式,那么我们将 config.php 中的 'app_debug' 的值改为 false,又会返回一个这样的页面:
这个页面当然也不适合API返回给客户端

那么我们在设计接口的时候该如何向客户端返回错误信息呢?
基于 RESTFul 规范,我们需要定义一个统一的错误返回消息。
我们改写一下控制器中的代码:

class Banner{
  public function getBanner($id){
    (new IDMustBePositiveInt())->goCheck();

    try{
      $banner = BannerModel::getBannerByID($id);
    } 
    catch(Exception $e)
    {
      $err = [
        'error_code' => 10001,
        'msg' => $e->getMessage()
      ];
      return json($err,400); // 注意不能直接返回数组,而应该用json包一下
    }

    return $banner;

  }
}

我们再在 Postman 里看一下返回结果:


客户端可以处理的返回结果

400状态码

这样我们这种直白的方法就写出来了,但我们反思一下,如果每一个控制器我们都要这样繁琐地处理异常,那么我们今后编写代码的思路一定难以保证十分流畅,而是会在这些异常的处理上耗费大量精力。而且这个仅仅是一个示例,实际上我们很多情况下是不可预知是否会有异常的,可能还会返回 tp5 自己的错误的网页,对于我们 API 来说是不合适的。

现在我们花了大量的篇幅展示了一种错误的、复用性差的直白写法,比起直接展示最终的结果,演示这些错误的写法我认为也是很有必要的,因为这是我们一步一步思路的体现。重构代码不是一蹴而就的,期间代码的写法也会越来越抽象,所以我们需要静下心来,不断地完善。

tp5 API 自定义全局异常处理(中)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,793评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,567评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,342评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,825评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,814评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,680评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,033评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,687评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,175评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,668评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,775评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,419评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,020评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,206评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,092评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,510评论 2 343

推荐阅读更多精彩内容

  • 理工寝室商店-微信小程序 疑问小结 当时在XAMMP下mysql目录下的bin下 php -v 不起作用.到ph...
    这个超人不会飞阿阅读 1,693评论 1 1
  • 前言: 说到异常控制,也许很多会比较陌生,我身边很少人会去写抛异常的代码。但是异常用好了是非常的方便大家开发。首先...
    祥哥去哪里阅读 5,629评论 2 7
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,455评论 25 707
  • 说实话,刚报名完参与写作班,我就后悔了!倒不是觉得自己的文字有多难看,而是怕自己根本不能坚持。 回家前一天,兄弟发...
    人里面哪有你阅读 386评论 0 2
  • 民族团结 维吾尔族老阿爸 赶着马车去工地 我在建设和田 你不认识我 没关系 我们都是一家人 共同的名子叫中国 你快...
    李家长安阅读 209评论 0 2