ps:斜體加粗字體為重構(gòu)的每一個(gè)過程
例如我們現(xiàn)在 tp5 項(xiàng)目中有一個(gè)名為 Banner 的控制器。里面有一個(gè)需要傳入 $id
的 getBanner 操作“奔。現(xiàn)在需要對參數(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í)沒有任何問題荒给,但是缺點(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)在來一步一步的做一下宾尚,先寫一個(gè)驗(yàn)證器丙笋,進(jìn)行第一步封裝。
我們在 controller 的同級目錄下新建一個(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)在我們來看一下 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è)代碼的邏輯并沒有真正的改變笙各,我們之前所提到的問題還是存在的:整個(gè)校驗(yàn)器的方法很長钉答,而且代碼的復(fù)用性不高。
那我們該如何簡化呢杈抢?
先來看一下我們的最終結(jié)果:
public function getBanner($id){
(new IDMustBePositiveInt())->goCheck()
}
我們最終的目的是僅通過這一行代碼來實(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)層:
首先我們來實(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)在我們再回到 getBanner 中颂翼,用我們?nèi)碌乃季S進(jìn)行編寫:
public function getBanner($id){
(new IDMustBePositiveInt())->goCheck()
}
OK!這一行代碼看起來就像一個(gè)攔截器切面慨灭,如果攔截器通過朦乏,才會(huì)執(zhí)行下面的代碼。
下面是圖示: