ThinkPHP5 驗證器的具體使用
前言:
我們在做API開發(fā)的時候,我們會接受客戶端傳來的參數(shù),大家都知道這個參數(shù)是不可信的,我們后端開發(fā)人員必須對這個參數(shù)進行驗證。我在之前的開發(fā)中只是知道tp5的驗證器,并不知道他的用途,因為之前的開發(fā)驗證,往往都是基于模型字段進行的驗證。而驗證器更適用與API開發(fā),今天就簡單講下驗證器的使用
目錄:
- 創(chuàng)建驗證器
- 書寫單獨驗證器
- 調(diào)用驗證
1.創(chuàng)建驗證器
首先我們需要一個文件夾來存放我們的驗證器,我們在模塊下創(chuàng)建一個同控制器平級的文件夾,取名為validate

然后我們就可以來建立驗證器了,我們只需要創(chuàng)建一個類,繼承tp5的validate類就可以了。
但是熟悉面向?qū)ο笏枷氲呐笥岩欢ㄖ溃?dāng)我們需要一個方法每個驗證器都要用到,但是又不去修改tp5的源碼時。我們就多寫一個類來作為我們的基類。所有的驗證器都繼承這個基類,然后這個基類再去繼承tp5的validate類。
這里我們把他取名為baseValidate

那么現(xiàn)在再創(chuàng)建一個正兒八經(jīng)的驗證器了。舉個例子:
namespace app\index\validate;
use think\Validate;
class User extends Validate
{
protected $rule = [
'name' => 'require|max:25',
'email' => 'email',
];
}
再到控制器或者模型中去實例化再調(diào)用
//虛擬一組數(shù)據(jù),實際開發(fā)中是接受用戶傳遞的數(shù)據(jù)
$data = [
'name'=>'thinkphp',
'email'=>'thinkphp@qq.com'
];
$validate = Loader::validate('User');
if(!$validate->check($data)){
dump($validate->getError());
}
這樣一個驗證器的應(yīng)用就寫好了。我們來看看有沒有什么可以簡化的地方。
- 首先需要被驗證的數(shù)據(jù)是我們從客戶端那接受過來的那么,第一步接受數(shù)據(jù)
- 然后我們要對數(shù)據(jù)進行驗證,如果驗證不通過,返回錯誤信息
這兩部是每次接口被請求都是要做的。那么我們就想把這個封裝到BaseValidate中去
namespace app\home\validate;
use think\Exception;
use think\Request;
use think\Validate;
class BaseValidate extends Validate
{
public function goCheck($data='')
{
//實例化請求對象
$requestObj=Request::instance();
//如果傳入為空則獲取請求里的參數(shù)
empty($data)&&$data=$requestObj->param();
if ($this->check($data)) {
//如果驗證通過了
return true;
}else{
//如果驗證沒通過
$error=$this->getError();
//拋出異常
throw new Exception($error);
}
}
}
這個goCheck方法封裝好后,有人可能會問,這個驗證規(guī)則在哪里呢?
2. 書寫單獨驗證器
之前有說過BaseValidate是用來被繼承的,那么真正的驗證器,我們還沒有開始寫。規(guī)則就制定到這個驗證器中。為了更深入的理解,這里舉例子順便使用了自定義驗證 規(guī)則。其實tp寫好了的驗證規(guī)則應(yīng)該很夠用了
我們就拿最常接受的數(shù)據(jù)來舉例子,那就是 id 同常這個id就代表了我們數(shù)據(jù)庫中某條數(shù)據(jù)的id,這個id我們往往設(shè)計為無符號自動遞增的主鍵,翻譯成人話就是正整數(shù)。那么如果客戶傳來的參數(shù)是負(fù)數(shù)或者小數(shù)那么就不應(yīng)該通過驗證。
我們根據(jù)上述需求,我們來創(chuàng)建一個驗證器。位置還是跟之前的一樣在validate文件夾下

取名為IdMustBePositiveInt.php(名字有點長,不過好在望文知意)
首先肯定是要繼承我們的基礎(chǔ)驗證器
class IdMustBePositiveInt extends BaseValidate
然后制定規(guī)則,為一個固定的成員變量賦值
protected $rule = [
//require是內(nèi)置規(guī)則,而tp5并沒有正整數(shù)的規(guī)則,所以下面這個positiveInt使用自定義的規(guī)則
'id' => 'require|positiveInt'
];
那么自定義規(guī)則怎么干呢,其實也簡單。定義一個被保護的方法
//系統(tǒng)會自動傳入幾個參數(shù) 第一個是 要驗證的值,第二個是規(guī)則,自己可以規(guī)定規(guī)則內(nèi)容或者不寫,第三個是最初傳入的data。其實不只這三個參數(shù),想了解詳細(xì)的可以看看文檔
protected function positiveInt($value, $rule='', $data)
{
if (is_int(($value+0))&&($value+0)>0) {
return true;
}else{
return 'id必須為正整數(shù)';
}
}
?。∽⒁猓哼@里如果判斷失?。悍祷氐牟皇莊alse 返回的是錯誤信息。
3. 調(diào)用驗證
根據(jù)我們之前的封裝,我們需要達到的效果就是接受參數(shù),驗證參數(shù)一體。那么現(xiàn)在我們?nèi)绾握{(diào)用驗證呢
厲害的來了,我們還是以id為例
public function test($id)
{
//在控制器中直接調(diào)用寫上這行代碼就搞定驗證了
(new IdMustBePositiveInt)->goCheck();
}
- 就這樣的一句代碼,直接搞定驗證。當(dāng)我們實例化id驗證器,調(diào)用它父類的goCheck方法。
- goCheck方法會接受參數(shù),并且將參數(shù)傳入validate對象上check方法
- 就會去匹配我們在id驗證器中$rule中規(guī)定的require規(guī)則和我們自定義的規(guī)則。
- 如果都通過就會返回true
- 如果其中一條不匹配則會拋出異常
這次只舉了id為例子,雖然看上去比直接寫?yīng)毩Ⅱ炞C麻煩很多,但是大家仔細(xì)想想,這個驗證規(guī)則其實在很多地方都是一樣的,比如密碼驗證規(guī)則,用戶名驗證規(guī)則等,當(dāng)這個項目寫完了。你已經(jīng)完成了很多驗證器。其實在下個項目中還可以繼續(xù)套用的哦
TP5驗證規(guī)則使用
①靜態(tài)調(diào)用(使用內(nèi)置的規(guī)則驗證單個數(shù)據(jù),返回值為布爾值)
// 日期格式驗證
Validate::dateFormat('2016-03-09','Y-m-d'); // true
// 驗證是否有效的日期
Validate::is('2016-06-03','date'); // true
// 驗證是否有效郵箱地址
Validate::is('thinkphp@qq.com','email'); // true
// 驗證是否在某個范圍
Validate::in('a',['a','b','c']); // true
// 驗證是否大于某個值
Validate::gt(10,8); // true
// 正則驗證
Validate::regex(100,'\d+'); // true
②模型驗證(在模型中的驗證方式)
$User = new User;
$result = $User->validate(
[
'name' => 'require|max:25',
'email' => 'email',
],
[
'name.require' => '名稱必須',
'name.max' => '名稱最多不能超過25個字符',
'email' => '郵箱格式錯誤',
]
)->save($data);
if(false === $result){
// 驗證失敗 輸出錯誤信息
dump($User->getError());
}
③控制器驗證(控制器中進行驗證)
如果你需要在控制器中進行驗證,并且繼承了\think\Controller的話,可以調(diào)用控制器類提供的validate方法進行驗證,如下:
$result = $this->validate(
[
'name' => 'thinkphp',
'email' => 'thinkphp@qq.com',
],
[
'name' => 'require|max:25',
'email' => 'email',
]);
if(true !== $result){
// 驗證失敗 輸出錯誤信息
dump($result);
}
控制器中的驗證代碼可以簡化為:
$result = $this->validate($data,'User');
if(true !== $result){
// 驗證失敗 輸出錯誤信息
dump($result);
}
如果要使用場景,可以使用:
$result = $this->validate($data,'User.edit');
if(true !== $result){
// 驗證失敗 輸出錯誤信息
dump($result);
}
在validate方法中還支持做一些前置的操作回調(diào),使用方式如下:
$result = $this->validate($data,'User.edit',[],[$this,'some']);
if(true !== $result){
// 驗證失敗 輸出錯誤信息
dump($result);
}
好了,本次tp5驗證器的介紹了就寫到這里了,希望對大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
PHP CURL模擬登錄新浪微博抓取頁面內(nèi)容 基于EaglePHP框架開發(fā)
PHP CURL模擬登錄新浪微博抓取頁面內(nèi)容 基于EaglePHP框架開發(fā),需要的朋友可以參考下。2012-01-01
php下關(guān)于中英數(shù)字混排的字符串分割問題
要用到短信平臺的緣故,短信每條又有字?jǐn)?shù)的限制,而短信平臺的服務(wù)端又不會自己分析。短信平臺的后臺會自己分割,但api卻有沒這個功能。2010-04-04
php采集自中央氣象臺范圍覆蓋全國的天氣預(yù)報代碼實例
這篇文章主要介紹了php采集自中央氣象臺范圍覆蓋全國的天氣預(yù)報代碼實例,較為詳細(xì)的分析了采集的技巧及對應(yīng)接口的調(diào)用技巧,具有一定參考借鑒價值,需要的朋友可以參考下2015-01-01
PHP7擴展開發(fā)教程之Hello World實現(xiàn)方法示例
這篇文章主要介紹了PHP7擴展開發(fā)教程之Hello World實現(xiàn)方法,結(jié)合實例形式較為詳細(xì)的分析了針對php7擴展的源碼下載、設(shè)置、代碼編輯及測試運行相關(guān)操作技巧,需要的朋友可以參考下2017-08-08

