Laravel中使用FormRequest進(jìn)行表單驗(yàn)證方法及問題匯總
在`Laravel`中,每一個(gè)請(qǐng)求都會(huì)被封裝為一個(gè)`Request`對(duì)象,`Form Request`對(duì)象就是包含了額外驗(yàn)證邏輯(以及訪問權(quán)限控制)的自定義`Request`類。 本文分析了FormRequest異常的處理流程并提出了自定義處理FormRequest驗(yàn)證失敗的思路。
所有示例基于Laravel 5.1.39 (LTS)
今天天氣不錯(cuò),我們來說說表單驗(yàn)證。
Controller中做表單驗(yàn)證
有的同學(xué)把表單驗(yàn)證邏輯寫在Controller中,例如這個(gè)對(duì)用戶提交評(píng)論內(nèi)容的驗(yàn)證:
<?php // ... use Validator; class CommentController { public function postStoreComment(Request $request) { $validator = Validator::make($request->all(), [ 'comment' => 'required', // 只是實(shí)例,就寫個(gè)簡(jiǎn)單的規(guī)則,你的網(wǎng)站要是這么寫歡迎在評(píng)論里貼網(wǎng)址 ]); if ($validator->fails()) { return redirect() ->back() ->withErrors($validator) ->withInput(); } }
這樣寫的話,表單驗(yàn)證和業(yè)務(wù)邏輯擠在一起,我們的Controller中就會(huì)有太多的代碼,而且重復(fù)的驗(yàn)證規(guī)則基本也是復(fù)制粘貼。
我們可以利用Form Request來封裝表單驗(yàn)證代碼,從而精簡(jiǎn)Controller中的代碼邏輯,使其專注于業(yè)務(wù)。而獨(dú)立出去的表單驗(yàn)證邏輯甚至可以復(fù)用到其它請(qǐng)求中,例如修改評(píng)論。
什么是Form Request
在Laravel中,每一個(gè)請(qǐng)求都會(huì)被封裝為一個(gè)Request對(duì)象,F(xiàn)orm Request對(duì)象就是包含了額外驗(yàn)證邏輯(以及訪問權(quán)限控制)的自定義Request類。
如何使用Form Request做表單驗(yàn)證
Laravel提供了生成Form Request的Artisan命令:
<code>$ php artisan make:request StoreCommentRequest</code>
于是就生成了app/Http/Requests/StoreCommentRequest.php,讓我們來分析一下內(nèi)容:
<?php namespace App\Http\Requests; use App\Http\Requests\Request; // 可以看到,這個(gè)基類是在我們的項(xiàng)目中的,這意味著我們可以修改它 class StoreCommentRequest extends Request { /** * Determine if the user is authorized to make this request. * * @return bool */ public function authorize() // 這個(gè)方法可以用來控制訪問權(quán)限,例如禁止未付費(fèi)用戶評(píng)論… { return false; // 注意!這里默認(rèn)是false,記得改成true } /** * Get the validation rules that apply to the request. * * @return array */ public function rules() // 這個(gè)方法返回驗(yàn)證規(guī)則數(shù)組,也就是Validator的驗(yàn)證規(guī)則 { return [ // ]; } }
那么很容易,我們除了讓authorize方法返回true之外,還得讓rules方法返回我們的驗(yàn)證規(guī)則:
<?php // ... public function rules() { return [ ]; } // ...
接著修改我們的Controller:
<?php // ... // 之前:public function postStoreComment(Request $request) public function postStoreComment(\App\Http\Requests\StoreCommentRequest $request) { // ... } // ...
這樣Laravel便會(huì)自動(dòng)調(diào)用StoreCommentRequest進(jìn)行表單驗(yàn)證了。
異常處理
如果表單驗(yàn)證失敗,Laravel會(huì)重定向到之前的頁面,并且將錯(cuò)誤寫到Session中,如果是AJAX請(qǐng)求,則會(huì)返回一段HTTP狀態(tài)為422的JSON數(shù)據(jù),類似這樣:
<code>{comment: ["The comment field is required."]}</code>
這里就不細(xì)說提示信息怎么修改了,如果有人想看相關(guān)教程,可以留言。
我們主要來說說怎么定制錯(cuò)誤處理。
通常來說,Laravel中的錯(cuò)誤都是異常(Exception),我們都可以在app\Exceptions\handler.php中進(jìn)行統(tǒng)一處理。Form Request確實(shí)也拋出了一個(gè)Illuminate\Http\Exception\HttpResponseException異常,但這個(gè)異常是在路由邏輯中就被特殊處理了。
首先我們來看看Form Request是如何被執(zhí)行的:
Illuminate\Validation\ValidationServiceProvider:
<?php namespace Illuminate\Validation; use Illuminate\Support\ServiceProvider; use Illuminate\Contracts\Validation\ValidatesWhenResolved; class ValidationServiceProvider extends ServiceProvider { /** * Register the service provider. * * @return void */ public function register() { $this->registerValidationResolverHook(); // 看我看我看我 $this->registerPresenceVerifier(); $this->registerValidationFactory(); } /** * Register the "ValidatesWhenResolved" container hook. * * @return void */ protected function registerValidationResolverHook() // 對(duì),就是我 { // 這里可以看到對(duì)`ValidatesWhenResolved`的實(shí)現(xiàn)做了一個(gè)監(jiān)聽 $this->app->afterResolving(function (ValidatesWhenResolved $resolved) { $resolved->validate(); // 然后調(diào)用了它的`validate`方法進(jìn)行驗(yàn)證 }); } // ...
你猜對(duì)了,F(xiàn)orm Request就實(shí)現(xiàn)了這個(gè)Illuminate\Contracts\Validation\ValidatesWhenResolved接口:
<?php namespace Illuminate\Foundation\Http; use Illuminate\Http\Request; use Illuminate\Http\Response; use Illuminate\Http\JsonResponse; use Illuminate\Routing\Redirector; use Illuminate\Container\Container; use Illuminate\Contracts\Validation\Validator; use Illuminate\Http\Exception\HttpResponseException; use Illuminate\Validation\ValidatesWhenResolvedTrait; use Illuminate\Contracts\Validation\ValidatesWhenResolved; // 是你 use Illuminate\Contracts\Validation\Factory as ValidationFactory; // 我們`app\Http\Requests\Request`便是繼承于這個(gè)`FormRequest`類 class FormRequest extends Request implements ValidatesWhenResolved // 就是你 { use ValidatesWhenResolvedTrait; // 這個(gè)我們待會(huì)兒也要看看 // ...
FormRequest基類中的validate方法是由這個(gè)Illuminate\Validation\ValidatesWhenResolvedTrait實(shí)現(xiàn)的:
Illuminate\Validation\ValidatesWhenResolvedTrait:
<?php namespace Illuminate\Validation; use Illuminate\Contracts\Validation\ValidationException; use Illuminate\Contracts\Validation\UnauthorizedException; /** * Provides default implementation of ValidatesWhenResolved contract. */ trait ValidatesWhenResolvedTrait { /** * Validate the class instance. * * @return void */ public function validate() // 這里實(shí)現(xiàn)了`validate`方法 { $instance = $this->getValidatorInstance(); // 這里獲取了`Validator`實(shí)例 if (! $this->passesAuthorization()) { $this->failedAuthorization(); // 這是調(diào)用了訪問授權(quán)的失敗處理 } elseif (! $instance->passes()) { $this->failedValidation($instance); // 這里調(diào)用了驗(yàn)證失敗的處理,我們主要看這里 } } // ...
在validate里,如果驗(yàn)證失敗了就會(huì)調(diào)用$this->failedValidation(),繼續(xù):
Illuminate\Foundation\Http\FormRequest:
<?php // ... /** * Handle a failed validation attempt. * * @param \Illuminate\Contracts\Validation\Validator $validator * @return mixed */ protected function failedValidation(Validator $validator) { throw new HttpResponseException($this->response( // 這里拋出了傳說中的異常 $this->formatErrors($validator) )); }
終于看到異常了!可是這個(gè)異常在另一個(gè)地方被處理了:
Illuminate\Routing\Route:
<?php // ... /** * Run the route action and return the response. * * @param \Illuminate\Http\Request $request * @return mixed */ public function run(Request $request) { $this->container = $this->container ?: new Container; try { if (! is_string($this->action['uses'])) { return $this->runCallable($request); } if ($this->customDispatcherIsBound()) { return $this->runWithCustomDispatcher($request); } return $this->runController($request); } catch (HttpResponseException $e) { // 就是這里 return $e->getResponse(); // 這里直接返回了Response給客戶端 } } // ...
至此,整個(gè)思路已然清晰,不過我們還是看看這里生成的HttpResponseException異常中的Response是怎么生成的:
Illuminate\Foundation\Http\FormRequest:
<?php // ... // 132行: if ($this->ajax() || $this->wantsJson()) { // 對(duì)AJAX請(qǐng)求的處理 return new JsonResponse($errors, 422); } return $this->redirector->to($this->getRedirectUrl()) // 對(duì)普通表單提交的處理 ->withInput($this->except($this->dontFlash)) ->withErrors($errors, $this->errorBag); // ...
相信你都看明白了。
如何實(shí)現(xiàn)自定義錯(cuò)誤處理,這里提供兩個(gè)思路,都需要重寫app\Http\Requests\Request的failedValidation:
拋出一個(gè)新異常,繼承HttpResponseException異常,重新實(shí)現(xiàn)getResponse方法,這個(gè)異常類我們可以放到app/Exceptions/下便于管理,錯(cuò)誤返回依然交給Laravel;
拋出一個(gè)我們自定義的異常,在app\Exceptions\handler中處理。
具體實(shí)現(xiàn)這里就不寫啦(參閱Laravel文檔中關(guān)于錯(cuò)誤處理部分,中文文檔傳送門),如果你有別的方法或者想法可以在評(píng)論中和我交流。
補(bǔ)充
如果你的Controller使用Illuminate\Foundation\Validation\ValidatesRequests這個(gè)Trait的validate方法進(jìn)行驗(yàn)證,同樣的,這里驗(yàn)證失敗也會(huì)拋出Illuminate\Http\Exception\HttpResponseException異常,可以參考上面的解決方案進(jìn)行處理。
- 關(guān)于laravel后臺(tái)模板laravel-admin select框的使用詳解
- laravel-admin select框默認(rèn)選中的方法
- laravel-admin解決表單select聯(lián)動(dòng)時(shí),編輯默認(rèn)沒選上的問題
- 在Laravel中使用DataTables插件的方法
- PHP框架Laravel插件Pagination實(shí)現(xiàn)自定義分頁
- 推薦幾款用 Sublime Text 開發(fā) Laravel 所用到的插件
- Laravel框架表單驗(yàn)證詳解
- Laravel 5框架學(xué)習(xí)之表單
- Laravel實(shí)現(xiàn)表單提交
- Laravel 5框架學(xué)習(xí)之表單驗(yàn)證
- Laravel 5框架學(xué)習(xí)之子視圖和表單復(fù)用
- laravel框架select2多選插件初始化默認(rèn)選中項(xiàng)操作示例
相關(guān)文章
發(fā)一個(gè)php簡(jiǎn)單的偽原創(chuàng)程序,配合商城采集用的
在網(wǎng)上搜了一個(gè)偽原創(chuàng)的程序,下下來,結(jié)果太令人驚奇的。以前也在為如何將一段文字里的某些詞替換掉而苦惱,原來php有個(gè)strtr函數(shù).2010-10-10PHP合并數(shù)組+與array_merge的區(qū)別分析
PHP中兩個(gè)數(shù)組合并可以使用+或者array_merge,但之間還是有區(qū)別的,而且這些區(qū)別如果了解不清楚項(xiàng)目中會(huì)要命的!2010-08-08php循環(huán)語句 for()與foreach()用法區(qū)別介紹
下面我用兩個(gè)實(shí)例來介紹一下關(guān)于在php中foreach與for語句用法區(qū)別介紹,有需要的朋友可參考一下2012-09-09