重构 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思想