重構(gòu) tp5 參數(shù)校驗(yàn)層

ps:斜體加粗字體為重構(gòu)的每一個(gè)過(guò)程

例如我們現(xiàn)在 tp5 項(xiàng)目中有一個(gè)名為 Banner 的控制器。里面有一個(gè)需要傳入 $id 的 getBanner 操作?,F(xiàn)在需要對(duì)參數(shù) $id 進(jìn)行正整數(shù)校驗(yàn),直白的做法馬上就會(huì)映入我們的腦海,以下為偽代碼:

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;
  }
}

這樣做確實(shí)沒(méi)有任何問(wèn)題,但是缺點(diǎn)也很明顯,如果是有多個(gè)參數(shù)呢,或者別的控制器也需要進(jìn)行正整數(shù) $id 檢驗(yàn)怎么辦?這樣直白的做法實(shí)際上給我們今后的參數(shù)檢驗(yàn)會(huì)埋下坑。
有的人可能會(huì)采取用函數(shù)封裝一下的方式,到時(shí)候進(jìn)行調(diào)用。但這也不是最優(yōu)的方法。

我們現(xiàn)在來(lái)一步一步的做一下,先寫一個(gè)驗(yàn)證器,進(jìn)行第一步封裝
我們?cè)?controller 的同級(jí)目錄下新建一個(gè) validate 目錄。在里面新建一個(gè)名為 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.'必須是正整數(shù)';
    }
  }
}

require 是 tp5 內(nèi)置的驗(yàn)證規(guī)則,isPositiveInteger 是我們自定義的驗(yàn)證規(guī)則。
現(xiàn)在我們來(lái)看一下 Banner 控制器如何調(diào)用這個(gè)驗(yàn)證器。
進(jìn)行改寫 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;
  }
}

但是細(xì)心的人肯定會(huì)發(fā)現(xiàn),我們把獨(dú)立驗(yàn)證的方式改成驗(yàn)證器的方式后,我們整個(gè)代碼的邏輯并沒(méi)有真正的改變,我們之前所提到的問(wèn)題還是存在的:整個(gè)校驗(yàn)器的方法很長(zhǎng),而且代碼的復(fù)用性不高。
那我們?cè)撊绾魏?jiǎn)化呢?
先來(lái)看一下我們的最終結(jié)果:

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

我們最終的目的是僅通過(guò)這一行代碼來(lái)實(shí)現(xiàn)參數(shù)校驗(yàn),如果校驗(yàn)成功,則運(yùn)行下面的代碼,否則報(bào)錯(cuò)并終止運(yùn)行。
而且如果還有別的驗(yàn)證器,僅需要添加一行即可:

(new AnotherValidate())->goCheck()

十分方便。
我們現(xiàn)在反推,進(jìn)行下一步重構(gòu),構(gòu)建接口參數(shù)校驗(yàn)層
首先我們來(lái)實(shí)現(xiàn) goCheck() 方法:
在 validate 文件夾下新建一個(gè) BaseValidate 的 php Class,所有其他的驗(yàn)證器都繼承于該類,而它則繼承于 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;
    }
  }
}

現(xiàn)在我們?cè)倩氐?getBanner 中,用我們?nèi)碌乃季S進(jìn)行編寫:

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

OK!這一行代碼看起來(lái)就像一個(gè)攔截器切面,如果攔截器通過(guò),才會(huì)執(zhí)行下面的代碼。
下面是圖示:


AOP思想
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容