Laravel 学习笔记之 request validation

lx1036 的个人博客 / 7 / 0 / 创建于 7年前

在用 laravel 写 api 时，当前端传进来的 request 是 POST/PUT/PATH 等 method 时，那需要做 request validation，尽管对于前后端分离程序，前端程序 Angular/Vue 已经做了 validation，但是 ajax 传过来的 json input，在后端也需要做 validation。

那该如何优雅的编写 request validation 呢？laravel 官方文档已经包含了这个 feature: Form Request Validation

这里可以写一个 JsonRequest:

class JsonRequest extends Illuminate\Foundation\Http\FormRequest
{
    public function rules()
    {
        $method = $this->method();

        assert(in_array($method, [static::METHOD_POST, static::METHOD_PUT, static::METHOD_PATCH], true));

        $controller = $this->route()->getController();
        $rules      = $controller::RULES;

        return ($rules[$this->method()] ?? []) + ($rules['*'] ?? []);
    }

    public function authorize()
    {
        return true;
    }
}

这样就可以在众多 Model Controller 里使用 JsonRequest 就行，如：

use Illuminate\Http\Request;

final class AccountController extends \App\Http\Controllers\Controller
{
    public const RULES = [
        Request::METHOD_POST => [
            'bank_account' => 'required_if:type,bank',
            'loan_account' => 'required_if:type,loan',
        ],
        Request::METHOD_PUT => [
            // ...
        ],
        '*' => [
            // ...
        ],
    ];
}

这样就可以校验前端传进来的 json input 是否合法。
(1) 如果前端传进来的 json input 是:

{
    "name": "lx1036",
    "type": "loan",
    "bank_account": {
        "source": "bank",
    }
}

那就 validation 失败，不合法。
(2) 如果前端传进来的 json input 是:

{
    "name": "lx1036",
    "type": "bank",
    "loan_account": {
        "source": "loan",
    }
}

那就 validation 失败，不合法。

这样就可以校验 json input，不合法就直接弹回 throw 一个 HttpException，不再用在进入下一步逻辑。对于这样嵌套的 json input，使用 request validation 来校验对象间关系很重要，可以看做是进入核心业务逻辑前的初步校验。。当然最后写表时还有 model validation，避免坏数据进入 db。

最后一点，laravel 文档只是说了用法，没有说明原理。代码在 \Illuminate\Foundation\Providers\FormRequestServiceProvider::class：

    public function boot()
    {
        // \Illuminate\Foundation\Http\FormRequest use 了 ValidatesWhenResolvedTrait，extends 了 \Illuminate\Contracts\Validation\ValidatesWhenResolved
        $this->app->afterResolving(ValidatesWhenResolved::class, function ($resolved) {
            $resolved->validate();
        });

        // ...
    }