在`Laravel`中，每一個請求都會被封裝為一個`Request`對象，`Form Request`對象就是包含了額外驗證邏輯（以及訪問權限控制）的自定義`Request`類。 本文分析了FormRequest異常的處理流程並提出了自定義處理FormRequest驗證失敗的思路。
所有示例基於Laravel 5.1.39 (LTS)
今天天氣不錯，我們來說說表單驗證。
Controller中做表單驗證
有的同學把表單驗證邏輯寫在Controller中，例如這個對用戶提交評論內容的驗證：
<?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();
}
}
這樣寫的話，表單驗證和業務邏輯擠在一起，我們的Controller中就會有太多的代碼，而且重復的驗證規則基本也是復制粘貼。
我們可以利用Form Request來封裝表單驗證代碼，從而精簡Controller中的代碼邏輯，使其專注於業務。而獨立出去的表單驗證邏輯甚至可以復用到其它請求中，例如修改評論。
什麼是Form Request
在Laravel中，每一個請求都會被封裝為一個Request對象，Form Request對象就是包含了額外驗證邏輯（以及訪問權限控制）的自定義Request類。
如何使用Form Request做表單驗證
Laravel提供了生成Form Request的Artisan命令：
<code>$ php artisan make:request StoreCommentRequest</code>
於是就生成了app/Http/Requests/StoreCommentRequest.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 [
//
];
}
}
那麼很容易，我們除了讓authorize方法返回true之外，還得讓rules方法返回我們的驗證規則：
<?php
// ...
public function rules()
{
return [
];
}
// ...
接著修改我們的Controller：
<?php
// ...
// 之前：public function postStoreComment(Request $request)
public function postStoreComment(\App\Http\Requests\StoreCommentRequest $request)
{
// ...
}
// ...
這樣Laravel便會自動調用StoreCommentRequest進行表單驗證了。
異常處理
如果表單驗證失敗，Laravel會重定向到之前的頁面，並且將錯誤寫到Session中，如果是AJAX請求，則會返回一段HTTP狀態為422的JSON數據，類似這樣：
<code>{comment: ["The comment field is required."]}</code>
這裡就不細說提示信息怎麼修改了，如果有人想看相關教程，可以留言。
我們主要來說說怎麼定制錯誤處理。
通常來說，Laravel中的錯誤都是異常（Exception），我們都可以在app\Exceptions\handler.php中進行統一處理。Form Request確實也拋出了一個Illuminate\Http\Exception\HttpResponseException異常，但這個異常是在路由邏輯中就被特殊處理了。
首先我們來看看Form Request是如何被執行的：
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() // 對，就是我
{
// 這裡可以看到對`ValidatesWhenResolved`的實現做了一個監聽
$this->app->afterResolving(function (ValidatesWhenResolved $resolved) {
$resolved->validate(); // 然後調用了它的`validate`方法進行驗證
});
}
// ...
你猜對了，Form Request就實現了這個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`便是繼承於這個`FormRequest`類
class FormRequest extends Request implements ValidatesWhenResolved // 就是你
{
use ValidatesWhenResolvedTrait; // 這個我們待會兒也要看看
// ...
FormRequest基類中的validate方法是由這個Illuminate\Validation\ValidatesWhenResolvedTrait實現的：
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() // 這裡實現了`validate`方法
{
$instance = $this->getValidatorInstance(); // 這裡獲取了`Validator`實例
if (! $this->passesAuthorization()) {
$this->failedAuthorization(); // 這是調用了訪問授權的失敗處理
} elseif (! $instance->passes()) {
$this->failedValidation($instance); // 這裡調用了驗證失敗的處理，我們主要看這裡
}
}
// ...
在validate裡，如果驗證失敗了就會調用$this->failedValidation()，繼續：
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)
));
}
終於看到異常了！可是這個異常在另一個地方被處理了：
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給客戶端
}
}
// ...
至此，整個思路已然清晰，不過我們還是看看這裡生成的HttpResponseException異常中的Response是怎麼生成的：
Illuminate\Foundation\Http\FormRequest：
<?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);
// ...
相信你都看明白了。
如何實現自定義錯誤處理，這裡提供兩個思路，都需要重寫app\Http\Requests\Request的failedValidation：
拋出一個新異常，繼承HttpResponseException異常，重新實現getResponse方法，這個異常類我們可以放到app/Exceptions/下便於管理，錯誤返回依然交給Laravel；
拋出一個我們自定義的異常，在app\Exceptions\handler中處理。
具體實現這裡就不寫啦（參閱Laravel文檔中關於錯誤處理部分，中文文檔傳送門），如果你有別的方法或者想法可以在評論中和我交流。
補充
如果你的Controller使用Illuminate\Foundation\Validation\ValidatesRequests這個Trait的validate方法進行驗證，同樣的，這裡驗證失敗也會拋出Illuminate\Http\Exception\HttpResponseException異常，可以參考上面的解決方案進行處理。
