在 Laravel 中处理请求验证的智能方法

Laravel

“中世纪盔甲中的男人的黑白肖像，准备挥剑。”作者：亨利·胡斯塔瓦

Laravel是网络工匠的PHP框架。这有助于我们构建强大的应用程序和API。很多人都知道有很多方法可以验证Laravel中的请求。处理请求验证是任何应用程序中非常重要的部分。Laravel有一些很好的功能，可以很好地处理这个问题。

入门

我们大多数人都熟悉在控制器中使用验证器。这是处理传入请求验证的最常用方法。

以下是我们的验证器的样子 UserController

<?php

namespace App\Http\Controllers\API\v1\Users;

use App\Http\Controllers\Controller;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Validator;
use App\Entities\Models\User;

class UserController extends Controller
{
    public function store(Request $request)
    {

        // validate incoming request

        $validator = Validator::make($request->all(), [
           'email' => 'required|email|unique:users',
           'name' => 'required|string|max:50',
           'password' => 'required'
       ]);

       if ($validator->fails()) {
            Session::flash('error', $validator->messages()->first());
            return redirect()->back()->withInput();
       }

       // finally store our user

    }
}

在控制器中验证

在控制器中验证传入请求没有任何问题，但这不是最好的方法，你的控制器看起来很乱。在我看来，这是不好的做法。控制器应该只处理来自路由的一个处理请求并返回适当的响应。

在控制器中编写验证逻辑将打破单一责任原则。我们都知道需求会随着时间的推移而变化，每次需求变更时，您的班级职责也会发生变化。因此，在单一班级中承担很多责任使得管理变得非常困难。

Laravel具有表单请求，一个包含验证逻辑的单独请求类。要创建一个，您可以在Artisan命令下使用。

php artisan make：请求UserStoreRequest

这将创建新的Request类 app\Http\Request\UserRequest

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class UserStoreRequest extends FormRequest
{
    /**
     * Determine if the user is authorized to make this request.
     *
     * @return bool
     */
    public function authorize()
    {
        return true;
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules()
    {
        return [
            'email' => 'required|email|unique:users',
            'name' => 'required|string|max:50',
            'password' => 'required'
        ];
    }

     /**
     * Custom message for validation
     *
     * @return array
     */
    public function messages()
    {
        return [
            'email.required' => 'Email is required!',
            'name.required' => 'Name is required!',
            'password.required' => 'Password is required!'
        ];
    }
}

Laravel Form Request类有两个默认方法auth()和rules()。auth()无论当前用户是否被允许请求，您都可以在方法中执行任何授权逻辑。在rules()方法中，您可以编写所有验证规则。还有一种方法messages()可以传递自己的验证消息数组。

现在改变我们UserController使用我们UserStoreRequest.你可以输入提示我们的请求类，它会在调用我们的控制器函数之前自动解析和验证。

<?php

namespace App\Http\Controllers\API\v1\Users;

use App\Http\Controllers\Controller;
use App\Http\Requests\UserStoreRequest;

class UserController extends Controller
{
    public function store(UserStoreRequest $request)
    {
        // Will return only validated data

        $validated = $request->validated();
    }
}

所以我们的控制器现在很纤薄，易于维护。现在我们的控制器不需要担心任何验证逻辑。我们有自己的验证类，只有一个责任来处理验证，让控制器在那里工作。

如果验证失败，它会将用户重定向到上一个位置并显示错误。取决于您的请求类型错误消息将在会话中闪烁。如果请求是AJAX，则将返回带有422状态代码的响应，并返回JSON格式的错误。

✨回报

通过清理输入来保持您的应用程序和用户的安全。在您的应用程序中使用清洁剂，它将确保数据始终格式良好且一致。在许多情况下，由于愚蠢的格式错误，验证失败。

用户输入的移动电话号码为+ 99-9999-999999或+ 99-（9999） - （999999）。这是非常常见的错误，我们不能强迫我们的用户再次重新输入相同的细节。

其他一些例子是用户输入的电子邮件为Foo@Bar.COM或FOO@Bar.com。或者输入名字和姓氏，如FOO **bAR或foo baR**

Sanitizer包含在提供给验证器之前以通用格式转换和过滤数据的方法。

我正在使用Waavi/Sanitizer包含许多过滤器的包。

Waavi /数据清洗

让我们BaseFormRequest为Form Request 创建抽象类，并SanitizesInput在这里使用trait。

<?php

namespace App\Http\Requests;

use Illuminate\Contracts\Validation\Validator;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Http\Exceptions\HttpResponseException;
use Illuminate\Http\JsonResponse;
use Waavi\Sanitizer\Laravel\SanitizesInput;

abstract class BaseFormRequest extends FormRequest
{
    use ApiResponse, SanitizesInput;

    /**
     * For more sanitizer rule check https://github.com/Waavi/Sanitizer
     */
    public function validateResolved()
    {
        {
            $this->sanitize();
            parent::validateResolved();
        }
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    abstract public function rules();

    /**
     * Determine if the user is authorized to make this request.
     *
     * @return bool
     */
    abstract public function authorize();

}

所以现在我们可以写UserStoreRequest下面的内容。从我们的基类扩展您的表单请求，因此我们不必在所有请求类中包含特征。

<?php

namespace App\Http\Requests;

class UserStoreRequest extends BaseFormRequest
{
    /**
     * Determine if the user is authorized to make this request.
     *
     * @return bool
     */
    public function authorize()
    {
        return true;
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules()
    {
        return [
            'email' => 'required|email|unique:users',
            'name' => 'required|string|max:50',
            'password' => 'required'
        ];
    }

    public function messages()
    {
        return [
            'email.required' => 'Email is required!',
            'name.required' => 'Name is required!',
            'password.required' => 'Password is required!'
        ];
    }

    /**
     *  Filters to be applied to the input.
     *
     * @return array
     */
    public function filters()
    {
        return [
            'email' => 'trim|lowercase',
            'name' => 'trim|capitalize|escape'
        ];
    }

}

SanitizesInputtrait提供了一种filters()在提供给验证器之前格式化我们的请求数据的方法。filters()方法返回有效过滤器的数组。在这里，我们将用户电子邮件转换为小写并修剪相同的方式将名称转换为大写并转义任何HTML标记。

您可以从此处详细了解可用的过滤器。