Laravel中使用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命令：

$ php artisan make:request StoreCommentRequest

因而就生成了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數據，相似這樣：

{comment: ["The comment field is required."]}

這裏就不細說提示信息怎麼修改了，若是有人想看相關教程，能夠留言。

咱們主要來講說怎麼定製錯誤處理。

一般來講，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：

1. 拋出一個新異常，繼承HttpResponseException異常，從新實現getResponse方法，這個異常類咱們能夠放到app/Exceptions/下便於管理，錯誤返回依然交給Laravel；

2. 拋出一個咱們自定義的異常，在app\Exceptions\handler中處理。

具體實現這裏就不寫啦（參閱Laravel文檔中關於錯誤處理部分，中文文檔傳送門），若是你有別的方法或者想法能夠在評論中和我交流。

補充

若是你的Controller使用Illuminate\Foundation\Validation\ValidatesRequests這個Trait的validate方法進行驗證，一樣的，這裏驗證失敗也會拋出Illuminate\Http\Exception\HttpResponseException異常，能夠參考上面的解決方案進行處理。

參考

Laravel 5.1官方文檔