Eine intelligente Möglichkeit, die Anforderungsvalidierung in Laravel durchzuführen

Laravel ist das PHP-Framework für Web Craftsman. Dies hilft uns, leistungsstarke Anwendungen und APIs zu erstellen. Wie viele von Ihnen wissen, gibt es in Laravel viele Möglichkeiten, Anfragen zu validieren. Die Bearbeitung der Anforderungsvalidierung ist ein sehr wichtiger Teil jeder Anwendung. Laravel verfügt über einige großartige Funktionen, die dieses Problem sehr gut lösen.

Erste Schritte

Die meisten von uns sind mit der Verwendung von Validatoren in Controllern vertraut. Dies ist die gebräuchlichste Methode zur Validierung eingehender Anforderungen.

So sieht unser Validator aus, 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(), [
           &#39;email&#39; => &#39;required|email|unique:users&#39;,
           &#39;name&#39; => &#39;required|string|max:50&#39;,
           &#39;password&#39; => &#39;required&#39;
       ]);
       if ($validator->fails()) {
            Session::flash(&#39;error&#39;, $validator->messages()->first());
            return redirect()->back()->withInput();
       }
       // finally store our user
    }
}

Validierung im Controller

Validierung der eingehenden Anfrage im Controller ohne Probleme, aber das hier ist nicht der beste Ansatz und Ihr Controller wird unordentlich aussehen. Meiner Meinung nach ist das eine schlechte Praxis. Der Controller sollte nur eine Verarbeitungsanforderung von der Route bearbeiten und eine entsprechende Antwort zurückgeben.

Das Schreiben einer Validierungslogik in den Controller verstößt gegen das Prinzip der Einzelverantwortung. Wir alle wissen, dass sich die Anforderungen im Laufe der Zeit ändern, und jedes Mal, wenn sich die Anforderungen ändern, ändern sich auch Ihre Klassenverantwortungen. Daher erschwert die Tatsache, dass in einer einzigen Klasse viele Verantwortlichkeiten zu tragen sind, die Verwaltung sehr.

Laravel verfügt über Formularanfragen, eine separate Anfrageklasse, die Validierungslogik enthält. Um eines zu erstellen, können Sie den Artisan-Befehl verwenden.

php artisan make: request UserStoreRequest

Dadurch wird die neue Request-Klasse appHttpRequestUserRequest erstellt

<?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 [
            &#39;email&#39; => &#39;required|email|unique:users&#39;,
            &#39;name&#39; => &#39;required|string|max:50&#39;,
            &#39;password&#39; => &#39;required&#39;
        ];
    }
     /**
     * Custom message for validation
     *
     * @return array
     */
    public function messages()
    {
        return [
            &#39;email.required&#39; => &#39;Email is required!&#39;,
            &#39;name.required&#39; => &#39;Name is required!&#39;,
            &#39;password.required&#39; => &#39;Password is required!&#39;
        ];
    }
}

Die Laravel Form Request-Klasse verfügt über zwei Standardmethoden: auth() und Rules(). Sie können jede Autorisierungslogik in der auth()-Methode ausführen, unabhängig davon, ob der aktuelle Benutzer eine Anfrage stellen darf. In der Methode Rules() können Sie alle Validierungsregeln schreiben. Es gibt auch eine Methode messages(), um Ihr eigenes Array von Validierungsnachrichten zu übergeben.

Ändern Sie nun unseren UserController, um unseren UserStoreRequest zu verwenden. Sie können die Eingabeaufforderung für unsere Anforderungsklasse eingeben und diese wird automatisch analysiert und validiert, bevor unsere Controller-Funktion aufgerufen wird.

<?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();
    }
}

Unser Controller ist jetzt schlank und wartungsfreundlich. Jetzt muss sich unser Controller nicht mehr um die Validierungslogik kümmern. Wir haben unsere eigene Validierungsklasse mit nur einer Verantwortung, die Validierung durchzuführen und den Controller dort arbeiten zu lassen.

Wenn die Überprüfung fehlschlägt, wird der Benutzer zum vorherigen Standort weitergeleitet und ein Fehler angezeigt. Abhängig von Ihrem Anfragetyp wird in der Sitzung eine Fehlermeldung blinken. Wenn die Anfrage AJAX ist, wird eine Antwort mit dem Statuscode 422 und einem JSON-formatierten Fehler zurückgegeben.

Zurück

Schützen Sie Ihre Anwendung und Benutzer, indem Sie Eingaben bereinigen. Verwenden Sie in Ihrer Anwendung einen Cleaner, um sicherzustellen, dass die Daten immer gut formatiert und konsistent sind. In vielen Fällen schlägt die Validierung aufgrund alberner Formatierungsfehler fehl.

Die vom Benutzer eingegebene Mobiltelefonnummer lautet +99-9999-999999 oder +99-(9999)-(999999). Dies ist ein sehr häufiger Fehler und wir können unsere Benutzer nicht dazu zwingen, dieselben Daten noch einmal einzugeben.

Einige andere Beispiele wären, wenn der Benutzer eine E-Mail als Foo@Bar.COM oder FOO@Bar.com eingibt. Oder geben Sie Vor- und Nachnamen wie FOO **bAR oder foo baR** ein.

Sanitizer enthält Methoden zum Transformieren und Filtern von Daten in ein gemeinsames Format, bevor sie dem Validator zugeführt werden.

Ich verwende das Waavi/Sanitizer-Paket, das viele Filter enthält.

Waavi / Datenbereinigung

Lassen Sie uns die abstrakte Klasse BaseFormRequest für Form Request erstellen und hier die Eigenschaft SanitizesInput verwenden.

<?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();
}

Jetzt können wir also den Inhalt unter UserStoreRequest schreiben. Erweitern Sie Ihre Formularanfragen aus unserer Basisklasse, damit wir nicht in allen Anfrageklassen Merkmale einschließen müssen.

<?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 [
            &#39;email&#39; => &#39;required|email|unique:users&#39;,
            &#39;name&#39; => &#39;required|string|max:50&#39;,
            &#39;password&#39; => &#39;required&#39;
        ];
    }
    public function messages()
    {
        return [
            &#39;email.required&#39; => &#39;Email is required!&#39;,
            &#39;name.required&#39; => &#39;Name is required!&#39;,
            &#39;password.required&#39; => &#39;Password is required!&#39;
        ];
    }
    /**
     *  Filters to be applied to the input.
     *
     * @return array
     */
    public function filters()
    {
        return [
            &#39;email&#39; => &#39;trim|lowercase&#39;,
            &#39;name&#39; => &#39;trim|capitalize|escape&#39;
        ];
    }
}

SanitizesInputtrait bietet eine Filter()-Methode, um unsere Anforderungsdaten zu formatieren, bevor sie dem Validator bereitgestellt werden. Die Methode filter() gibt ein Array gültiger Filter zurück. Hier konvertieren wir die E-Mail-Adresse des Benutzers in Kleinbuchstaben und kürzen sie auf die gleiche Weise, wie wir den Namen in Großbuchstaben umgewandelt und alle HTML-Tags maskiert haben.

Mehr über die verfügbaren Filter erfahren Sie hier.

Fazit

Zunächst einmal scheint es nicht notwendig zu sein, für alle separate Anforderungsklassen einzurichten. Aber stellen Sie sich vor, die gesamte Validierungslogik in demselben Controller unterzubringen. Es ist wie ein schlimmer Albtraum – wenn es um die Verwaltung Ihres Codes geht, wie viel schlimmer ist es, wenn ihn jemand anderes verwalten muss? .

Vielen Dank fürs Lesen.

Ich würde gerne Ihre Meinung dazu hören. Wenn Sie Fragen oder Anregungen haben, hinterlassen Sie bitte unten einen Kommentar.

Einen schönen Tag noch.

Weitere technische Artikel zu Laravel finden Sie in der Spalte Einführungs-Tutorial zum Laravel-Framework, um mehr darüber zu erfahren!

Das obige ist der detaillierte Inhalt vonEine intelligente Möglichkeit, die Anforderungsvalidierung in Laravel durchzuführen. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!