Laravel Under The Hood – Ein paar Makros

Hallo ?

Wie oft haben Sie sich eine Methode gewünscht, die es für Sammlungen oder String-Helfer nicht gibt? Sie fangen an, Methoden zu verketten, stoßen jedoch an eine Wand, als sich herausstellt, dass eine davon fehlt. Ehrlich gesagt ist es verständlich; Frameworks sind, wie Sie wissen, eine Einheitslösung. Ich befand mich mehrmals in dieser Situation. Bevor ich mich mit der Erweiterung des Frameworks befasse, überprüfe ich jedes Mal, ob das, was ich erweitern möchte, makrofähig ist oder nicht. Aber was bedeutet das? Genau das werden wir erforschen!

WTF sind Makros? ?

Nehmen wir an, wir haben dieses JWT:

$jwt = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';

Und wir müssen die Header extrahieren:

str($jwt)
    ->before('.')
    ->fromBase64()
    ->fromJson(); // does not exist ?

//  BadMethodCallException  Method Illuminate\Support\Stringable::fromJson does not exist.

Die fromJson() existiert nicht? Klar, man könnte einfach Folgendes tun:

json_decode(str($jwt)->before('.')->fromBase64());

Aber wo ist da der Spaß? Außerdem ist es mein Artikel ?

Wir brauchen also eine Möglichkeit, die Stringable-Klasse zu erweitern. Es gibt mehrere Möglichkeiten, dies zu tun, aber Laravel hat vorausgedacht, es wusste, dass Entwickler möglicherweise benutzerdefinierte Methoden hinzufügen möchten, also hat es die Klasse makrofähig gemacht, oder wie ich es gerne nenne, erweiterbar.

Wenn Sie die IlluminateSupportStringable-Klasse untersuchen, werden Sie feststellen, dass sie ein Macroable-Merkmal verwendet.

Lasst uns weitermachen und den Kurs erweitern. Fügen Sie im AppServiceProvider Folgendes hinzu:

<?php

namespace App\Providers;

use Illuminate\Support\Stringable;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    public function boot(): void
    {
        Stringable::macro('fromJson', function (bool $associative = true) {
            return json_decode($this->value, $associative);
        });
    }
}

Jetzt führen wir den Code noch einmal aus:

str($jwt)
    ->before('.')
    ->fromBase64()
    ->fromJson();

// ["alg" => "HS256", "typ" => "JWT"]

Es funktioniert perfekt? Aber jetzt fragen Sie sich vielleicht: Wie hat das funktioniert? Und was genau ist $this->value? Was zum Teufel ist da los?

Die Magie enthüllen?

Wir wissen, dass die Stringable-Klasse das Macroable-Merkmal verwendet, das die Macro()-Methode bereitstellt. Schauen wir uns genauer an, was es tut:

// src/Illuminate/Macroable/Traits/Macroable.php

/**
 * Register a custom macro.
 *
 * @param  string  $name
 * @param  object|callable  $macro
 *
 * @param-closure-this static  $macro
 *
 * @return void
 */
public static function macro($name, $macro)
{
    static::$macros[$name] = $macro;
}

Es ist ziemlich einfach, es speichert lediglich den Rückruf in einem statischen Makroarray. Wenn wir das Merkmal nun genauer untersuchen, werden wir die Methode __call finden, die jedes Mal ausgelöst wird, wenn eine nicht vorhandene Methode aufgerufen wird. In unserem Fall ist das fromJson(). Lasst uns eintauchen:

/**
 * Dynamically handle calls to the class.
 *
 * @param  string  $method
 * @param  array  $parameters
 * @return mixed
 *
 * @throws \BadMethodCallException
 */
public function __call($method, $parameters)
{
    if (! static::hasMacro($method)) {
        throw new BadMethodCallException(sprintf(
            'Method %s::%s does not exist.', static::class, $method
        ));
    }

    $macro = static::$macros[$method];

    if ($macro instanceof Closure) {
        $macro = $macro->bindTo($this, static::class);
    }

    return $macro(...$parameters);
}

Zuerst prüft es, ob ein Makro registriert ist, was bei fromJson() der Fall ist, und ruft dann den Rückruf (oder das Objekt) aus dem Makro-Array ab. Nun zum Zaubertrick: Wenn das Makro ein Abschluss ist (wie in unserem Fall), ruft es bindTo() auf, was dem Abschluss im Wesentlichen mitteilt, dass sich $this auf alles beziehen soll, was als erstes Argument übergeben wird. In diesem Fall handelt es sich um die Stringable-Instanz, die zufällig über das Attribut $value verfügt.

// $this here is the stringable
// $this inside the closure is now referencing the stringable class
$macro->bindTo($this, static::class);

Und deshalb können wir $this->value machen.

Wir können es besser machen: Mixins?

Es gibt noch etwas, das ich dir zeigen möchte! Wenn wir denselben Kurs ein paar Mal verlängern, kann es beim Dienstanbieter sehr schnell zu Problemen kommen. Wir können alle unsere benutzerdefinierten Makros in eine Klasse namens Mixin extrahieren.

Lassen Sie uns ein StringableMixin erstellen:

$jwt = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';

Jetzt können wir in AppServiceProvider dieses Mixin registrieren:

str($jwt)
    ->before('.')
    ->fromBase64()
    ->fromJson(); // does not exist ?

//  BadMethodCallException  Method Illuminate\Support\Stringable::fromJson does not exist.

Und das ist es! Jetzt können wir Folgendes tun:

json_decode(str($jwt)->before('.')->fromBase64());

Was im Grunde das Gleiche ist, nur etwas sauberer.

Wenn Sie wissen möchten, wie das funktioniert: Die mixin()-Methode für das Macroable-Merkmal verwendet die Reflection-API. Es ruft alle öffentlichen Methoden aus der Mixin-Klasse ab, erwartet, dass jede einen Abschluss zurückgibt, und registriert den Abschluss dann als Makro, genau wie wir es zuvor gesehen haben.

Die schlechte IDE?

Nun, wie Sie gesehen haben, ist eine Menge Magie im Gange, und die IDE würde nichts von den definierten Makros wissen. Wenn Sie in einem Team arbeiten, wissen andere Entwickler auch nichts von diesen Makros, was nicht gut ist. Glücklicherweise gibt es Tools, die Ihnen dabei helfen. Eine kostenlose Open-Source-Option ist das Laravel IDE-Hilfspaket.

Sie können das Paket installieren und die Datei _ide_helper.php generieren, und schon kann es losgehen.

Und so endet es..

Unser Beispiel ist ziemlich einfach, aber Sie können Makros noch viel weiter vorantreiben, da die meisten gängigen Klassen, mit denen Laravel ausgeliefert wird, makrofähig sind. Sie können beispielsweise ein neues apiResponse()-Makro oder alles hinzufügen, was Ihrer Meinung nach in der Logik Ihrer App sehr häufig vorkommt und häufiger wiederholt wird, als es sein sollte. Aber übertreibe es nicht. Makros fügen eine neue Ebene der Komplexität hinzu und können bei der Arbeit im Team verwirrend sein.

Also, wann immer Sie das Gefühl haben, dass etwas in Ihrer Anwendung, aber nicht im Framework selbst fehlt, verwenden Sie Makros?

Das obige ist der detaillierte Inhalt vonLaravel Under The Hood – Ein paar Makros. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!