重构 tp5 参数校验层

ps:斜体加粗字体为重构的每一个过程

例如我们现在 tp5 项目中有一个名为 Banner 的控制器。里面有一个需要传入 $id 的 getBanner 操作。现在需要对参数 $id 进行正整数校验,直白的做法马上就会映入我们的脑海,以下为伪代码:

public function getBanner($id){
  $data = [
    'id' => $id
  ];
  $validate = new Validate(
    [
      'id' => 'positive integer'
    ]);
  $result = $validate->batch()->check($data);
  if($result){
    // parameter is right and do something;
  } else {
    // error;
  }
}

这样做确实没有任何问题,但是缺点也很明显,如果是有多个参数呢,或者别的控制器也需要进行正整数 $id 检验怎么办?这样直白的做法实际上给我们今后的参数检验会埋下坑。
有的人可能会采取用函数封装一下的方式,到时候进行调用。但这也不是最优的方法。

我们现在来一步一步的做一下,先写一个验证器,进行第一步封装
我们在 controller 的同级目录下新建一个 validate 目录。在里面新建一个名为 IDMustBePositiveInt 的 php class。

<? php
namespace app\api\validate;

use think\Validate;

class IDMustBePositiveInt extends Validate{
  protected $rule = [
    'id' => 'require|isPositiveInteger'
  ];

  protected function isPositiveInteger($value,$rule='',
                                 $data='',$field=''){
    if(is_numeric($value) && is_int($value + 0) && ($value + 0) > 0){
      return true;
    } else {
      return $field.'必须是正整数';
    }
  }
}

require 是 tp5 内置的验证规则,isPositiveInteger 是我们自定义的验证规则。
现在我们来看一下 Banner 控制器如何调用这个验证器。
进行改写 getBanner 方法:

public function getBanner($id){
  $data = [
    'id' => $id
  ];
  $validate = new IDMustBePositiveInt();
  $result = $validate->batch()->check($data);
  if($result){
    // parameter is right and do something;
  } else {
    // error;
  }
}

但是细心的人肯定会发现,我们把独立验证的方式改成验证器的方式后,我们整个代码的逻辑并没有真正的改变,我们之前所提到的问题还是存在的:整个校验器的方法很长,而且代码的复用性不高。
那我们该如何简化呢?
先来看一下我们的最终结果:

public function getBanner($id){
  (new IDMustBePositiveInt())->goCheck()
}

我们最终的目的是仅通过这一行代码来实现参数校验,如果校验成功,则运行下面的代码,否则报错并终止运行。
而且如果还有别的验证器,仅需要添加一行即可:

(new AnotherValidate())->goCheck()

十分方便。
我们现在反推,进行下一步重构,构建接口参数校验层
首先我们来实现 goCheck() 方法:
在 validate 文件夹下新建一个 BaseValidate 的 php Class,所有其他的验证器都继承于该类,而它则继承于 think\Validate 类。

<? php
namespace app\api\validate;

use think\Request;

class BaseValidate extends Validate{
  
  public function goCheck(){
    $request = Request:instance();
    $params= $request->param();
    $result = $this->batch()->check($params);
    if(!result){
      $error = $this->error;
      throw new Exception($error);
    }  else {
       return true;
    }
  }
}

现在我们再回到 getBanner 中,用我们全新的思维进行编写:

public function getBanner($id){
  (new IDMustBePositiveInt())->goCheck()
}

OK!这一行代码看起来就像一个拦截器切面,如果拦截器通过,才会执行下面的代码。
下面是图示:


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

推荐阅读更多精彩内容