Lumen提供了多種方法來(lái)驗(yàn)證應(yīng)用輸入數(shù)據(jù)。默認(rèn)情況下,Lumen的控制器基類使用ValidatesRequests
trait,該trait提供了便利的方法通過(guò)各種功能強(qiáng)大的驗(yàn)證規(guī)則來(lái)驗(yàn)證輸入的HTTP請(qǐng)求。
要學(xué)習(xí)Lumen強(qiáng)大的驗(yàn)證特性,讓我們先看一個(gè)完整的驗(yàn)證表單并返回錯(cuò)誤信息給用戶的例子。
首先,我們假定在app/Http/routes.php
文件中包含如下路由:
// 顯示創(chuàng)建博客文章表單...
$app->get('post/create', 'PostController@create');
// 存儲(chǔ)新的博客文章...
$app->post('post', 'PostController@store');
當(dāng)然,GET路由為用戶顯示了一個(gè)創(chuàng)建新的博客文章的表單,POST路由將新的博客文章存儲(chǔ)到數(shù)據(jù)庫(kù)。
接下來(lái),讓我們看一個(gè)處理這些路由的簡(jiǎn)單控制器示例。我們先將store
方法留空:
<?php
namespace App\Http\Controllers;
use Illuminate\Http\Request;
use App\Http\Controllers\Controller;
class PostController extends Controller{
/**
* 顯示創(chuàng)建新的博客文章的表單
*
* @return Response
*/
public function create()
{
return view('post.create');
}
/**
* 存儲(chǔ)新的博客文章
*
* @param Request $request
* @return Response
*/
public function store(Request $request)
{
// 驗(yàn)證并存儲(chǔ)博客文章...
}
}
現(xiàn)在我們準(zhǔn)備用驗(yàn)證新博客文章輸入的邏輯填充store
方法。如果你檢查應(yīng)用的控制器基類(App\Http\Controllers\Controller
),你會(huì)發(fā)現(xiàn)該類使用了ValidatesRequests
trait,這個(gè)trait在所有控制器中提供了一個(gè)便利的validate
方法。
validate
方法接收一個(gè)HTTP請(qǐng)求輸入數(shù)據(jù)和驗(yàn)證規(guī)則,如果驗(yàn)證規(guī)則通過(guò),代碼將會(huì)繼續(xù)往下執(zhí)行;然而,如果驗(yàn)證失敗,將會(huì)拋出一個(gè)異常,相應(yīng)的錯(cuò)誤響應(yīng)也會(huì)自動(dòng)發(fā)送給用戶。在一個(gè)傳統(tǒng)的HTTP請(qǐng)求案例中,將會(huì)生成一個(gè)重定向響應(yīng),如果是AJAX請(qǐng)求則會(huì)返回一個(gè)JSON響應(yīng)。
要更好的理解validate
方法,讓我們回到store
方法:
/**
* 存儲(chǔ)博客文章
*
* @param Request $request
* @return Response
*/
public function store(Request $request){
$this->validate($request, [
'title' => 'required|unique:posts|max:255',
'body' => 'required',
]);
// 驗(yàn)證通過(guò),存儲(chǔ)到數(shù)據(jù)庫(kù)...
}
正如你所看到的,我們只是傳遞輸入的HTTP請(qǐng)求和期望的驗(yàn)證規(guī)則到validate
方法,在強(qiáng)調(diào)一次,如果驗(yàn)證失敗,相應(yīng)的響應(yīng)會(huì)自動(dòng)生成。如果驗(yàn)證通過(guò),控制器將會(huì)繼續(xù)正常執(zhí)行。
嵌套屬性注意事項(xiàng)
如果HTTP請(qǐng)求中包含“嵌套”參數(shù),可以使用“.”在驗(yàn)證規(guī)則中指定它們:
$this->validate($request, [
'title' => 'required|unique:posts|max:255',
'author.name' => 'required',
'author.description' => 'required',
]);
那么,如果請(qǐng)求輸入?yún)?shù)沒有通過(guò)給定驗(yàn)證規(guī)則怎么辦?正如前面所提到的,Lumen將會(huì)自動(dòng)將用戶重定向回上一個(gè)位置。此外,所有驗(yàn)證錯(cuò)誤信息會(huì)自動(dòng)一次性存放到session。
注意我們并沒有在GET路由中明確綁定錯(cuò)誤信息到視圖。這是因?yàn)長(zhǎng)umen總是從session數(shù)據(jù)中檢查錯(cuò)誤信息,而且如果有的話會(huì)自動(dòng)將其綁定到視圖。所以,值得注意的是每次請(qǐng)求的所有視圖中總是存在一個(gè)$errors
變量,從而允許你在視圖中方便而又安全地使用。$errors
變量是的一個(gè)Illuminate\Support\MessageBag
實(shí)例。想要了解更多關(guān)于該對(duì)象的信息,查看其文檔。
所以,在我們的例子中,驗(yàn)證失敗的話用戶將會(huì)被重定向到控制器的create方法,從而允許我們?cè)谝晥D中顯示錯(cuò)誤信息:
<!-- /resources/views/post/create.blade.php -->
<h1>Create Post</h1>
@if (count($errors) > 0)
<div class="alert alert-danger">
<ul>
@foreach ($errors->all() as $error)
<li>{{ $error }}</li>
@endforeach
</ul>
</div>
@endif
<!-- Create Post Form -->
自定義錯(cuò)誤格式
如果你想要自定義驗(yàn)證失敗時(shí)被一次性存到session中的錯(cuò)誤信息的格式,重寫控制器基類中的formatValidationErrors方
法,不要忘記在文件頂部導(dǎo)入Illuminate\Contracts\Validation\Validator
類:
<?php
namespace App\Http\Controllers;
use Illuminate\Contracts\Validation\Validator;
use Laravel\Lumen\Routing\Controller as BaseController;
abstract class Controller extends BaseController{
/**
* {@inheritdoc}
*/
protected function formatValidationErrors(Validator $validator)
{
return $validator->errors()->all();
}
}
在這個(gè)例子中,我們使用傳統(tǒng)的表單來(lái)發(fā)送數(shù)據(jù)到應(yīng)用。然而,很多應(yīng)用使用AJAX請(qǐng)求。在AJAX請(qǐng)求中使用validate
方法時(shí),Lumen不會(huì)生成重定向響應(yīng)。取而代之的,Lumen生成一個(gè)包含驗(yàn)證錯(cuò)誤信息的JSON響應(yīng)。該JSON響應(yīng)會(huì)帶上一個(gè)HTTP狀態(tài)碼422
。
如果你不想使用ValidatesRequests
trait的validate
方法,可以使用Validator
門面手動(dòng)創(chuàng)建一個(gè)驗(yàn)證器實(shí)例,該門面上的make
方法用于生成一個(gè)新的驗(yàn)證器實(shí)例:
<?php
namespace App\Http\Controllers;
use Validator;
use Illuminate\Http\Request;
use App\Http\Controllers\Controller;
class PostController extends Controller{
/**
* 存儲(chǔ)新的博客文章
*
* @param Request $request
* @return Response
*/
public function store(Request $request)
{
$validator = Validator::make($request->all(), [
'title' => 'required|unique:posts|max:255',
'body' => 'required',
]);
if ($validator->fails()) {
return redirect('post/create')
->withErrors($validator)
->withInput();
}
// 存儲(chǔ)博客文章...
}
}
傳遞給make
方法的第一個(gè)參數(shù)是需要驗(yàn)證的數(shù)據(jù),第二個(gè)參數(shù)是要應(yīng)用到數(shù)據(jù)上的驗(yàn)證規(guī)則。
檢查請(qǐng)求是夠通過(guò)驗(yàn)證后,可以使用withErrors
方法將錯(cuò)誤數(shù)據(jù)一次性存放到session,使用該方法時(shí),$errors
變量重定向后自動(dòng)在視圖間共享,從而允許你輕松將其顯示給用戶,withErrors
方法接收一個(gè)驗(yàn)證器、或者一個(gè)MessageBag,又或者一個(gè)PHP數(shù)組。
命名錯(cuò)誤包
如果你在單個(gè)頁(yè)面上有多個(gè)表單,可能需要命名MessageBag,從而允許你為指定表單獲取錯(cuò)誤信息。只需要傳遞名稱作為第二個(gè)參數(shù)給withErrors
即可:
return redirect('register')
->withErrors($validator, 'login');
然后你就可以從$errors
變量中訪問(wèn)命名的MessageBag實(shí)例:
{{ $errors->login->first('email') }}
驗(yàn)證鉤子之后
驗(yàn)證器允許你在驗(yàn)證完成后添加回調(diào),這種機(jī)制允許你輕松執(zhí)行更多驗(yàn)證,甚至添加更多錯(cuò)誤信息到消息集合。使用驗(yàn)證器實(shí)例上的after
方法即可:
$validator = Validator::make(...);
$validator->after(function($validator) {
if ($this->somethingElseIsInvalid()) {
$validator->errors()->add('field', 'Something is wrong with this field!');
}
});
if ($validator->fails()) {
//
}
調(diào)用Validator實(shí)例上的errors
方法之后,將會(huì)獲取一個(gè)Illuminate\Support\MessageBag
實(shí)例,該實(shí)例中包含了多種處理錯(cuò)誤信息的便利方法。
獲取某字段的第一條錯(cuò)誤信息
要獲取指定字段的第一條錯(cuò)誤信息,可以使用first
方法:
$messages = $validator->errors();
echo $messages->first('email');
獲取指定字段的所有錯(cuò)誤信息
如果你想要簡(jiǎn)單獲取指定字段的所有錯(cuò)誤信息數(shù)組,使用get
方法:
foreach ($messages->get('email') as $message) {
//
}
獲取所有字段的所有錯(cuò)誤信息
要獲取所有字段的所有錯(cuò)誤信息,可以使用all
方法:
foreach ($messages->all() as $message) {
//
}
判斷消息中是否存在某字段的錯(cuò)誤信息
if ($messages->has('email')) {
//
}
獲取指定格式的錯(cuò)誤信息
echo $messages->first('email', '<p>:message</p>');
獲取指定格式的所有錯(cuò)誤信息
foreach ($messages->all('<li>:message</li>') as $message) {
//
}
如果需要的話,你可以使用自定義錯(cuò)誤信息替代默認(rèn)的,有多種方法來(lái)指定自定義信息。首先,你可以傳遞自定義信息作為第三方參數(shù)給Validator::make
方法:
$messages = [
'required' => 'The :attribute field is required.',
];
$validator = Validator::make($input, $rules, $messages);
在本例中,:attribute
占位符將會(huì)被驗(yàn)證時(shí)實(shí)際的字段名替換,你還可以在驗(yàn)證消息中使用其他占位符,例如:
$messages = [
'same' => 'The :attribute and :other must match.',
'size' => 'The :attribute must be exactly :size.',
'between' => 'The :attribute must be between :min - :max.',
'in' => 'The :attribute must be one of the following types: :values',
];
為給定屬性指定自定義信息
有時(shí)候你可能只想為特定字段指定自定義錯(cuò)誤信息,可以通過(guò)”.”來(lái)實(shí)現(xiàn),首先指定屬性名,然后是規(guī)則:
$messages = [
'email.required' => 'We need to know your e-mail address!',
];
在語(yǔ)言文件中指定自定義消息
在很多案例中,你可能想要在語(yǔ)言文件中指定屬性特定自定義消息而不是將它們直接傳遞給Validator
。要實(shí)現(xiàn)這個(gè),添加消息到resources/lang/xx/validation.php
語(yǔ)言文件的custom數(shù)組:
'custom' => [
'email' => [
'required' => 'We need to know your e-mail address!',
],
],
下面是有效規(guī)則及其函數(shù)列表:
在驗(yàn)證中該字段的值必須是yes
、on
、1
或true
,這在“同意服務(wù)協(xié)議”時(shí)很有用。
該字段必須是一個(gè)基于PHP函數(shù)checkdnsrr
的有效URL
該字段必須是給定日期后的一個(gè)值,日期將會(huì)通過(guò)PHP函數(shù)strtotime
傳遞:
'start_date' => 'required|date|after:tomorrow'
你可以指定另外一個(gè)比較字段而不是使用strtotime驗(yàn)證傳遞的日期字符串:
'finish_date' => 'required|date|after:start_date'
該字段必須是字母
該字段可以包含字母和數(shù)字,以及破折號(hào)和下劃線
該字段必須是字母或數(shù)字
該字段必須是PHP數(shù)組
驗(yàn)證字段必須是指定日期之前的一個(gè)數(shù)值,該日期將會(huì)傳遞給PHP strtotime
函數(shù)。
驗(yàn)證字段尺寸在給定的最小值和最大值之間,字符串、數(shù)值和文件都可以使用該規(guī)則
驗(yàn)證字段必須可以被轉(zhuǎn)化為boolean
,接收true
, false
, 1
,0
, "1"
, 和 "0"
等輸入。
驗(yàn)證字段必須有一個(gè)匹配字段foo_confirmation
,例如,如果驗(yàn)證字段是password
,必須輸入一個(gè)與之匹配的password_confirmation
字段
驗(yàn)證字段必須是一個(gè)基于PHP strtotime
函數(shù)的有效日期
驗(yàn)證字段必須匹配指定格式,該格式將使用PHP函數(shù)date_parse_from_format
進(jìn)行驗(yàn)證。你應(yīng)該在驗(yàn)證字段時(shí)使用date
或date_format
驗(yàn)證字段必須是一個(gè)和指定字段不同的值
驗(yàn)證字段必須是數(shù)字且長(zhǎng)度為value
指定的值
驗(yàn)證字段數(shù)值長(zhǎng)度必須介于最小值和最大值之間
驗(yàn)證字段必須是格式化的電子郵件地址
驗(yàn)證字段必須存在于指定數(shù)據(jù)表
基本使用:
'state' => 'exists:states'
指定自定義列名:
'state' => 'exists:states,abbreviation'
還可以添加更多查詢條件到where
查詢子句:
'email' => 'exists:staff,email,account_id,1'
傳遞NULL作為where
子句的值將會(huì)判斷數(shù)據(jù)庫(kù)值是否為NULL:
'email' => 'exists:staff,email,deleted_at,NULL'
驗(yàn)證文件必須是圖片(jpeg、png、bmp、gif或者svg)
驗(yàn)證字段值必須在給定的列表中
驗(yàn)證字段必須是整型
驗(yàn)證字段必須是IP地址
驗(yàn)證字段必須小于等于最大值,和字符串、數(shù)值、文件字段的size規(guī)則一起使用
驗(yàn)證文件的MIMIE類型必須是該規(guī)則列出的擴(kuò)展類型中的一個(gè)
MIMIE規(guī)則的基本使用:
'photo' => 'mimes:jpeg,bmp,png'
驗(yàn)證字段的最小值,和字符串、數(shù)值、文件字段的size規(guī)則一起使用
驗(yàn)證字段值不在給定列表中
驗(yàn)證字段必須是數(shù)值
驗(yàn)證字段必須匹配給定正則表達(dá)式
注意:使用
regex
模式時(shí),規(guī)則必須放在數(shù)組中,而不能使用管道分隔符,尤其是正則表達(dá)式中使用管道符號(hào)時(shí)。
驗(yàn)證字段時(shí)必須的
驗(yàn)證字段在另一個(gè)字段等于指定值value時(shí)是必須的
驗(yàn)證字段只有在任一其它指定字段存在的話才是必須的
驗(yàn)證字段只有在所有指定字段存在的情況下才是必須的
驗(yàn)證字段只有當(dāng)任一指定字段不存在的情況下才是必須的
驗(yàn)證字段只有當(dāng)所有指定字段不存在的情況下才是必須的
給定字段和驗(yàn)證字段必須匹配
驗(yàn)證字段必須有和給定值相value匹配的尺寸,對(duì)字符串而言,value
是相應(yīng)的字符數(shù)目;對(duì)數(shù)值而言,value
是給定整型值;對(duì)文件而言,value
是相應(yīng)的文件字節(jié)數(shù)
驗(yàn)證字段必須是字符串
驗(yàn)證字符必須是基于PHP函數(shù)timezone_identifiers_list
的有效時(shí)區(qū)標(biāo)識(shí)
驗(yàn)證字段在給定數(shù)據(jù)表上必須是唯一的,如果不指定column
選項(xiàng),字段名將作為默認(rèn)column
。
指定自定義列名:
'email' => 'unique:users,email_address'
自定義數(shù)據(jù)庫(kù)連接
有時(shí)候,你可能需要自定義驗(yàn)證器生成的數(shù)據(jù)庫(kù)連接,正如上面所看到的,設(shè)置unique:users
作為驗(yàn)證規(guī)則將會(huì)使用默認(rèn)數(shù)據(jù)庫(kù)連接來(lái)查詢數(shù)據(jù)庫(kù)。要覆蓋默認(rèn)連接,在數(shù)據(jù)表名后使用”.“指定連接:
'email' => 'unique:connection.users,email_address'
強(qiáng)制一個(gè)唯一規(guī)則來(lái)忽略給定ID:
有時(shí)候,你可能希望在唯一檢查時(shí)忽略給定ID,例如,考慮一個(gè)包含用戶名、郵箱地址和位置的”更新屬性“界面,當(dāng)然,你將會(huì)驗(yàn)證郵箱地址是唯一的,然而,如果用戶只改變用戶名字段而并沒有改變郵箱字段,你不想要因?yàn)橛脩粢呀?jīng)擁有該郵箱地址而拋出驗(yàn)證錯(cuò)誤,你只想要在用戶提供的郵箱已經(jīng)被別人使用的情況下才拋出驗(yàn)證錯(cuò)誤,要告訴唯一規(guī)則忽略用戶ID,可以傳遞ID作為第三個(gè)參數(shù):
'email' => 'unique:users,email_address,'.$user->id
添加額外的where
子句:
還可以指定更多條件給where
子句:
'email' => 'unique:users,email_address,NULL,id,account_id,1'
驗(yàn)證字段必須是基于PHP函數(shù)filter_var
過(guò)濾的的有效URL
在某些場(chǎng)景下,你可能想要只有某個(gè)字段存在的情況下運(yùn)行驗(yàn)證檢查,要快速完成這個(gè),添加sometimes
規(guī)則到規(guī)則列表:
$v = Validator::make($data, [
'email' => 'sometimes|required|email',
]);
在上例中,email字段只有存在于$data
數(shù)組時(shí)才會(huì)被驗(yàn)證。
復(fù)雜條件驗(yàn)證
有時(shí)候你可能想要基于更復(fù)雜的條件邏輯添加驗(yàn)證規(guī)則。例如,你可能想要只有在另一個(gè)字段值大于100
時(shí)才要求一個(gè)給定字段是必須的,或者,你可能需要只有當(dāng)另一個(gè)字段存在時(shí)兩個(gè)字段才都有給定值。添加這個(gè)驗(yàn)證規(guī)則并不是一件頭疼的事。首先,創(chuàng)建一個(gè)永遠(yuǎn)不會(huì)改變的靜態(tài)規(guī)則到Validator實(shí)例:
$v = Validator::make($data, [
'email' => 'required|email',
'games' => 'required|numeric',
]);
讓我們假定我們的web應(yīng)用服務(wù)于游戲收集者。如果一個(gè)游戲收集者注冊(cè)了我們的應(yīng)用并擁有超過(guò)100
個(gè)游戲,我們想要他們解釋為什么他們會(huì)有這么多游戲,例如,也許他們?cè)谶\(yùn)營(yíng)一個(gè)游戲二手店,又或者他們只是喜歡收集。要添加這種條件,我們可以使用Validator實(shí)例上的sometimes
方法:
$v->sometimes('reason', 'required|max:500', function($input) {
return $input->games >= 100;
});
傳遞給sometimes
方法的第一個(gè)參數(shù)是我們需要有條件驗(yàn)證的名稱字段,第二個(gè)參數(shù)是我們想要添加的規(guī)則,如果作為第三個(gè)參數(shù)的閉包返回true
,規(guī)則被添加。該方法讓構(gòu)建復(fù)雜條件驗(yàn)證變得簡(jiǎn)單,你甚至可以一次為多個(gè)字段添加條件驗(yàn)證:
$v->sometimes(['reason', 'cost'], 'required', function($input) {
return $input->games >= 100;
});
注意:傳遞給閉包的
$input
參數(shù)是Illuminate\Support\Fluent
的一個(gè)實(shí)例,可用于訪問(wèn)輸入和文件。
Lumen提供了多種有用的驗(yàn)證規(guī)則;然而,你可能還是想要指定一些自己的驗(yàn)證規(guī)則。注冊(cè)驗(yàn)證規(guī)則的一種方法是使用Validator
門面的extend方法。讓我們?cè)?a rel="external nofollow" target="_blank" rel="external nofollow" target="_blank" target="_blank">服務(wù)提供者中使用這種方法來(lái)注冊(cè)一個(gè)自定義的驗(yàn)證規(guī)則:
<?php
namespace App\Providers;
use Validator;
use Illuminate\Support\ServiceProvider;
class AppServiceProvider extends ServiceProvider{
/**
* 啟動(dòng)應(yīng)用服務(wù)
*
* @return void
*/
public function boot()
{
Validator::extend('foo', function($attribute, $value, $parameters) {
return $value == 'foo';
});
}
/**
* 注冊(cè)服務(wù)提供者
*
* @return void
*/
public function register()
{
//
}
}
自定義驗(yàn)證器閉包接收三個(gè)參數(shù):要驗(yàn)證的屬性名稱,屬性值和傳遞給規(guī)則的參數(shù)數(shù)組。
你還可以傳遞類和方法到extend
方法而不是閉包:
Validator::extend('foo', 'FooValidator@validate');
定義錯(cuò)誤信息
你還需要為自定義規(guī)則定義錯(cuò)誤信息。你可以使用內(nèi)聯(lián)自定義消息數(shù)組或者在驗(yàn)證語(yǔ)言文件中添加條目來(lái)實(shí)現(xiàn)這一目的。消息應(yīng)該被放到數(shù)組的第一維,而不是在只用于存放屬性指定錯(cuò)誤信息的custom數(shù)組內(nèi):
"foo" => "Your input was invalid!",
"accepted" => "The :attribute must be accepted.",
// 驗(yàn)證錯(cuò)誤信息其它部分...
當(dāng)創(chuàng)建一個(gè)自定義驗(yàn)證規(guī)則時(shí),你可能有時(shí)候需要為錯(cuò)誤信息定義自定義占位符,可以通過(guò)創(chuàng)建自定義驗(yàn)證器然后調(diào)用Validator
門面上的replacer
方法來(lái)實(shí)現(xiàn)。可以在服務(wù)提供者的boot
方法中編寫代碼:
/**
* 啟動(dòng)應(yīng)用服務(wù)
*
* @return void
*/
public function boot(){
Validator::extend(...);
Validator::replacer('foo', function($message, $attribute, $rule, $parameters) {
return str_replace(...);
});
}
更多建議: