《PHP實戰:Laravel中使用FormRequest進行表單驗證方法及問題匯總》要點:
本文介紹了PHP實戰:Laravel中使用FormRequest進行表單驗證方法及問題匯總,希望對您有用。如果有疑問,可以聯系我們。
PHP應用在`Laravel`中,每一個請求都會被封裝為一個`Request`對象,`Form Request`對象就是包含了額外驗證邏輯(以及訪問權限控制)的自定義`Request`類. 本文分析了FormRequest異常的處理流程并提出了自定義處理FormRequest驗證失敗的思路.
PHP應用所有示例基于Laravel 5.1.39 (LTS)
PHP應用今天天氣不錯,我們來說說表單驗證.
PHP應用Controller中做表單驗證
PHP應用有的同學把表單驗證邏輯寫在Controller中,例如這個對用戶提交評論內容的驗證:
PHP應用
<?php
// ...
use Validator;
class CommentController
{
public function postStoreComment(Request $request)
{
$validator = Validator::make($request->all(), [
'comment' => 'required', // 只是實例,就寫個簡單的規則,你的網站要是這么寫歡迎在評論里貼網址
]);
if ($validator->fails()) {
return redirect()
->back()
->withErrors($validator)
->withInput();
}
}
PHP應用這樣寫的話,表單驗證和業務邏輯擠在一起,我們的Controller中就會有太多的代碼,而且重復的驗證規則基本也是復制粘貼.
PHP應用我們可以利用Form Request來封裝表單驗證代碼,從而精簡Controller中的代碼邏輯,使其專注于業務.而獨立出去的表單驗證邏輯甚至可以復用到其它請求中,例如修改評論.
PHP應用什么是Form Request
PHP應用在Laravel中,每一個請求都會被封裝為一個Request對象,Form Request對象就是包含了額外驗證邏輯(以及訪問權限控制)的自定義Request類.
PHP應用如何使用Form Request做表單驗證
PHP應用Laravel提供了生成Form Request的Artisan命令:
PHP應用<code>$ php artisan make:request StoreCommentRequest</code>
PHP應用于是就生成了app/Http/Requests/StoreCommentRequest.php,讓我們來分析一下內容:
PHP應用
<?php
namespace App\Http\Requests;
use App\Http\Requests\Request; // 可以看到,這個基類是在我們的項目中的,這意味著我們可以修改它
class StoreCommentRequest extends Request
{
/**
* Determine if the user is authorized to make this request.
*
* @return bool
*/
public function authorize() // 這個方法可以用來控制訪問權限,例如禁止未付費用戶評論…
{
return false; // 注意!這里默認是false,記得改成true
}
/**
* Get the validation rules that apply to the request.
*
* @return array
*/
public function rules() // 這個方法返回驗證規則數組,也就是Validator的驗證規則
{
return [
//
];
}
}
PHP應用那么很容易,我們除了讓authorize方法返回true之外,還得讓rules方法返回我們的驗證規則:
PHP應用
<?php
// ...
public function rules()
{
return [
];
}
// ...
PHP應用接著修改我們的Controller:
PHP應用
<?php
// ...
// 之前:public function postStoreComment(Request $request)
public function postStoreComment(\App\Http\Requests\StoreCommentRequest $request)
{
// ...
}
// ...
PHP應用這樣Laravel便會自動調用StoreCommentRequest進行表單驗證了.
PHP應用異常處理
PHP應用如果表單驗證失敗,Laravel會重定向到之前的頁面,并且將錯誤寫到Session中,如果是AJAX請求,則會返回一段HTTP狀態為422的JSON數據,類似這樣:
PHP應用<code>{comment: ["The comment field is required."]}</code>
PHP應用這里就不細說提示信息怎么修改了,如果有人想看相關教程,可以留言.
PHP應用我們主要來說說怎么定制錯誤處理.
PHP應用通常來說,Laravel中的錯誤都是異常(Exception),我們都可以在app\Exceptions\handler.php中進行統一處理.Form Request確實也拋出了一個Illuminate\Http\Exception\HttpResponseException異常,但這個異常是在路由邏輯中就被特殊處理了.
PHP應用首先我們來看看Form Request是如何被執行的:
PHP應用Illuminate\Validation\ValidationServiceProvider:
PHP應用
<?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() // 對,就是我
{
// 這里可以看到對`ValidatesWhenResolved`的實現做了一個監聽
$this->app->afterResolving(function (ValidatesWhenResolved $resolved) {
$resolved->validate(); // 然后調用了它的`validate`方法進行驗證
});
}
// ...
PHP應用你猜對了,Form Request就實現了這個Illuminate\Contracts\Validation\ValidatesWhenResolved接口:
PHP應用
<?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`便是繼承于這個`FormRequest`類
class FormRequest extends Request implements ValidatesWhenResolved // 就是你
{
use ValidatesWhenResolvedTrait; // 這個我們待會兒也要看看
// ...
PHP應用FormRequest基類中的validate方法是由這個Illuminate\Validation\ValidatesWhenResolvedTrait實現的:
PHP應用Illuminate\Validation\ValidatesWhenResolvedTrait:
PHP應用
<?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() // 這里實現了`validate`方法
{
$instance = $this->getValidatorInstance(); // 這里獲取了`Validator`實例
if (! $this->passesAuthorization()) {
$this->failedAuthorization(); // 這是調用了訪問授權的失敗處理
} elseif (! $instance->passes()) {
$this->failedValidation($instance); // 這里調用了驗證失敗的處理,我們主要看這里
}
}
// ...
PHP應用在validate里,如果驗證失敗了就會調用$this->failedValidation(),繼續:
PHP應用Illuminate\Foundation\Http\FormRequest:
PHP應用
<?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)
));
}
PHP應用終于看到異常了!可是這個異常在另一個地方被處理了:
PHP應用Illuminate\Routing\Route:
PHP應用
<?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給客戶端
}
}
// ...
PHP應用至此,整個思路已然清晰,不過我們還是看看這里生成的HttpResponseException異常中的Response是怎么生成的:
PHP應用Illuminate\Foundation\Http\FormRequest:
PHP應用
<?php
// ...
// 132行:
if ($this->ajax() || $this->wantsJson()) { // 對AJAX請求的處理
return new JsonResponse($errors, 422);
}
return $this->redirector->to($this->getRedirectUrl()) // 對普通表單提交的處理
->withInput($this->except($this->dontFlash))
->withErrors($errors, $this->errorBag);
// ...
PHP應用相信你都看明白了.
PHP應用如何實現自定義錯誤處理,這里提供兩個思路,都需要重寫app\Http\Requests\Request的failedValidation:
PHP應用拋出一個新異常,繼承HttpResponseException異常,重新實現getResponse方法,這個異常類我們可以放到app/Exceptions/下便于管理,錯誤返回依然交給Laravel;
PHP應用拋出一個我們自定義的異常,在app\Exceptions\handler中處理.
PHP應用具體實現這里就不寫啦(參閱Laravel文檔中關于錯誤處理部分,中文文檔傳送門),如果你有別的方法或者想法可以在評論中和我交流.
PHP應用補充
PHP應用如果你的Controller使用Illuminate\Foundation\Validation\ValidatesRequests這個Trait的validate方法進行驗證,同樣的,這里驗證失敗也會拋出Illuminate\Http\Exception\HttpResponseException異常,可以參考上面的解決方案進行處理.