Laravel implementiert eine API-Architektur basierend auf Modulen

Ich mag es wirklich, Software zu schreiben und auf modularem Design zu programmieren, aber ich mag es nicht, mich auf Softwarepakete und Bibliotheken von Drittanbietern zu verlassen, um einige triviale Dinge zu erledigen, denn das ist nicht der Fall. t Lassen Sie Ihr Programmierniveau erheblich verbessern. Ich schreibe also seit zwei Jahren modulbasierte Software in Laravel und bin mit den Ergebnissen sehr zufrieden.

Der entscheidende Faktor, der mich zu modular aufgebauter Software und Programmiermethoden treibt, ist, dass ich mein Programmierniveau weiter verbessern möchte. Stellen Sie sich vor, Sie bauen eine Projektstruktur auf und stellen 6 Monate später fest, dass das Projekt viele Fehler aufweist. Die Projektarchitektur lässt sich normalerweise nicht einfach ändern, ohne dass sich dies auf den 6 Monate alten Code auswirkt. Bei der Analyse dieses Projekts sind mir zwei Hauptpunkte aufgefallen: Entweder hat man im gesamten Projekt einen Standard und hält sich daran, oder man modularisiert und verbessert Modul für Modul.

Manche Menschen neigen dazu, sich um jeden Preis weiterzuentwickeln und an einem Standard festzuhalten, auch wenn das bedeuten kann, dass sie sich an einen Standard halten, den sie nicht mehr mögen. Persönlich bevorzuge ich eine kontinuierliche Verbesserung, und es spielt keine Rolle, ob sich das 20. Modul völlig vom ersten Modul unterscheidet. Wenn ich eines Tages zu Modul 1 zurückkehren muss, um einen Fehler zu beheben oder umzugestalten, kann ich es auf den neuesten Standard verbessern, der vom 20. Modul verwendet wird.

Angenommen, Sie entwickeln wie ich gerne Laravel-Anwendungen basierend auf Modularität und vermeiden so weit wie möglich das Hinzufügen unnötiger Abhängigkeiten von Drittanbietern zum Projekt – dieser Artikel ist ein Teil meiner Erfahrung.

1- Routing-Dienstleister

Das Laravel-Routing-System kann als Eingang zur gesamten Anwendung bezeichnet werden. Das erste, was geändert werden muss, ist die Standarddatei RouteServiceProvider.php, die die vorhandenen Routen modularisieren soll.

<?php
namespace App\Providers;
use Illuminate\Support\Facades\Route;
use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
class RouteServiceProvider extends ServiceProvider
{
    /**
     * 定义应用路由。
     *
     * @return void
     */
    public function map()
    {
        $this->mapModulesRoutes();
    }
    protected function mapModulesRoutes()
    {
        // 如果你在编写传统 Web 应用而非 HTTP API，请使用 `web` 中间件。 
        Route::middleware(&#39;api&#39;)
             ->group(base_path(&#39;routes/modules.php&#39;));
    }
}

Wie oben können wir einfach das gesamte Boilerplate dieser Datei entfernen und einfach eine modulare Routing-Datei einrichten.

2- Moduldateien

Laravel wird mit einigen Dateien im Routenordner geliefert. Da wir diese Routen nicht mehr im RouteServiceProvider abbilden, können wir sie direkt löschen. Als nächstes erstellen wir eine module.php-Routingdatei.

<?php
use Illuminate\Support\Facades\Route;
Route::group([], base_path(&#39;app/Modules/Books/routes.php&#39;));
Route::group([], base_path(&#39;app/Modules/Authors/routes.php&#39;));

3- Büchermodul

Erstellen Sie im App-Ordner die Datei Modules/Books/routes.php. In dieser Datei können wir Routing-Regeln für das Büchermodul der Anwendung definieren.

<?php
use App\Modules\Books\ListBooks;
use Illuminate\Support\Facades\Route;
Route::get(&#39;/books&#39;, ListBooks::class);

Sie können Controller-basiertes Routing verwenden, das die Standard-Routing-Methode in Laravel ist, aber ich persönlich bevorzuge die Methode „Auf Wiedersehen Controller, hallo Anfrage-Handler“ (lassen Sie Controller auf und verwenden Sie Anfrage-Handler). Das Folgende ist die Implementierung von ListBooks.

<?php
namespace App\Modules\Books;
use App\Eloquent\Book;
use App\Modules\Books\Resources\BookResource;
class ListBooks
{
    public function __invoke(Book $book)
    {
        return BookResource::collection($book->paginate());
    }
}

Im obigen Code ist BookResource die Ressourcenkonvertierungsebene von Laravel. Gemäß der offiziellen Empfehlung für Namespaces können wir sie im Ordner app/Modules/Books/Resources erstellen.

<?php
namespace App\Modules\Books\Resources;
use Illuminate\Http\Resources\Json\Resource;
class BookResource extends Resource
{
    public function toArray($request)
    {
        return [
            &#39;id&#39; => $this->resource->id,
            &#39;title&#39; => $this->resource->title,
        ];
    }
}

4- Autorenmodul

Wir können das Autorenmodul auch über die Routes-Datei starten.

<?php
use App\Modules\Authors\ListAuthors;
use Illuminate\Support\Facades\Route;
Route::get(&#39;/authors&#39;, ListAuthors::class);

Hinweis: Der Namespace app/Modules/Authors stellt die Dateien dar, die wir schreiben, und ist für Anforderungshandler sehr einfach.

<?php
namespace App\Modules\Authors;
use App\Eloquent\Author;
use App\Modules\Authors\Resources\AuthorResource;
class ListAuthors
{
    public function __invoke(Author $author)
    {
        return AuthorResource::collection($author->paginate());
    }
}

Zuletzt konvertieren wir die von uns geschriebene Ressourcenklasse in ein responsives JSON-Format.

<?php
namespace App\Modules\Authors\Resources;
use App\Modules\Books\Resources\BookResource;
use Illuminate\Http\Resources\Json\Resource;
class AuthorResource extends Resource
{
    public function toArray($request)
    {
        return [
            &#39;id&#39; => $this->resource->id,
            &#39;name&#39; => $this->resource->name,
            &#39;books&#39; => $this->whenLoaded(&#39;books&#39;, function () {
                return BookResource::collection($this->resource->books);
            })
        ];
    }
}

Beachten Sie, wie die Ressource in ein anderes Modul übergeht, um die BookResource wiederzuverwenden. Dies ist normalerweise keine gute Wahl, da Module völlig eigenständig sein sollten und nur Standardklassen wie Eloquent Models oder generische Komponenten wiederverwenden können, die so konzipiert sind, dass sie in allen Modulen gleich sind. Die Lösung für dieses Problem besteht normalerweise darin, die BookResource in das Authors-Modul zu kopieren, sodass Änderungen vorgenommen werden können, ohne ein anderes Modul zu verwenden, und umgekehrt. Ich habe beschlossen, diese modulübergreifende Verwendung beizubehalten. Dieses Beispiel zeigt eine gute Faustregel, um Module voneinander zu isolieren. Wenn Sie jedoch der Meinung sind, dass das obige Beispiel einfach ist und wahrscheinlich keine Probleme verursachen wird. Stellen Sie immer sicher, dass Sie Tests schreiben, die die von Ihnen geschriebene Funktionalität abdecken, um zu verhindern, dass andere Ihre Anwendung unwissentlich ändern.

5- Fazit

Obwohl dies ein sehr einfaches Beispiel ist, hoffe ich, dass es den Menschen ermöglicht, die strukturellen Standards des Laravel-Frameworks einfach entsprechend ihren eigenen Bedürfnissen zu bedienen. Sie können den Speicherort von Dateien ganz einfach ändern, um modulare Anwendungen zu erstellen. Die meisten meiner Projekte enthalten das Modul „App/Components“, das für wiederverwendbare generische Basisklassen für jedes Modul „App/Eloquent“ verwendet werden kann. Der Ordner „Module“ kann zum Speichern von Eloquent-Modellen und relationalen Datenbankmodellen verwendet werden, in denen wir beliebige Funktionalitäten erstellen können zum Thema Modularität. Dies ist die Ordnerverzeichnisstruktur einer Anwendung, an der ich vor kurzem mit der Arbeit begonnen habe:

Ich hoffe, dass jeder dieses Konzept daraus lernen kann, jedes Modul hat seine eigenen Bedürfnisse und kann seine eigenen Ordner/Entitäten/Klassen/Methoden/Eigenschaften haben. Es besteht keine Notwendigkeit, alle Module genau gleich zu standardisieren, da einige Module viel einfacher sind als andere und keinen umfangreichen strukturellen Entwurf erfordern. Dieses Beispiel zeigt, wie das AccountChurn-Modul die API über einen HTTP-Ordner bereitstellt und gleichzeitig Artisan-Befehle über die Konsole bereitstellt. AccountOverview hingegen stellt nur eine HTTP-API bereit und verlässt sich auf Warehouses, Wertobjekte (Bags) und Serviceklassen (Paginatoren), um einen größeren Datenwert bereitzustellen.

Empfohlene Tutorials: „PHP-Tutorial“ „Laravel-Tutorial“

Das obige ist der detaillierte Inhalt vonLaravel implementiert eine API-Architektur basierend auf Modulen. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!