基于 Module 的 Laravel API 架構(gòu)

file

轉(zhuǎn)自 PHP / Laravel 開(kāi)發(fā)者社區(qū) https://laravel-china.org/topics/21913

我非常喜歡編寫(xiě)基于模塊化設(shè)計(jì)的軟件和編程方式唯灵，但我不太喜歡依賴第三方軟件包和類(lèi)庫(kù)來(lái)處理一些瑣碎的事情橘荠，因?yàn)樗鼈儾粫?huì)讓你的編程水平得到很好的提升院水。所以這兩年來(lái)狸相，我一直在用Laravel編寫(xiě)基于模塊的軟件特愿，現(xiàn)在我對(duì)這個(gè)結(jié)果非常滿意勋拟。

推動(dòng)我走向基于模塊化設(shè)計(jì)的軟件和編程方式的決定性因素是我想持續(xù)提升我的編程水平。想象一下蜘矢，你構(gòu)建了一個(gè)項(xiàng)目結(jié)構(gòu)，6個(gè)月后你發(fā)現(xiàn)這個(gè)項(xiàng)目存在很多bug综看。在不影響6個(gè)月現(xiàn)有代碼的情況下品腹，通常不會(huì)輕易改變項(xiàng)目架構(gòu)。在分析這個(gè)項(xiàng)目時(shí)红碑，我注意到了兩個(gè)要點(diǎn)：你要么在整個(gè)項(xiàng)目中都有一個(gè)標(biāo)準(zhǔn)舞吭，要么堅(jiān)持下去，要么模塊化并逐個(gè)模塊地改進(jìn)析珊。

有些人傾向于不惜一切代價(jià)羡鸥、固守標(biāo)準(zhǔn)地開(kāi)發(fā)，即使這可能意味著要堅(jiān)持一個(gè)你不再喜歡的標(biāo)準(zhǔn)忠寻。就我個(gè)人來(lái)言惧浴，我更喜歡持續(xù)地改進(jìn)，若是第 20 個(gè)模塊和第 1 個(gè)模塊寫(xiě)得完全不一樣也沒(méi)關(guān)系奕剃。如果某天我需要回到模塊 1 修復(fù) BUG 或重構(gòu)衷旅，我可以將其改進(jìn)為第 20 個(gè)模塊使用的最新標(biāo)準(zhǔn)。

假設(shè)纵朋，你也像我一樣喜歡基于模塊化開(kāi)發(fā) Laravel 應(yīng)用柿顶、盡可能避免在項(xiàng)目中添加不必要的第三方依賴——本文是我的一點(diǎn)經(jīng)驗(yàn)。

1- 路由服務(wù)提供者

Laravel 路由系統(tǒng)可以說(shuō)是整個(gè)應(yīng)用的入口操软。首先需要修改的是默認(rèn)的 RouteServiceProvider.php 文件嘁锯，它應(yīng)當(dāng)將現(xiàn)有路由模塊化。

<?php
namespace App\Providers;
use Illuminate\Support\Facades\Route;
use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
class RouteServiceProvider extends ServiceProvider
{
    /**
     * 定義應(yīng)用路由寺鸥。
     *
     * @return void
     */
    public function map()
    {
        $this->mapModulesRoutes();
    }
    protected function mapModulesRoutes()
    {
        // 如果你在編寫(xiě)傳統(tǒng) Web 應(yīng)用而非 HTTP API，請(qǐng)使用 `web` 中間件品山。 
        Route::middleware('api')
             ->group(base_path('routes/modules.php'));
    }
}

如上胆建，我們可以直接擺脫該文件的整個(gè)樣板，只需設(shè)置一個(gè)模塊化的路由文件即可肘交。

2- 模塊文件

Laravel 在 routes 文件夾中自帶了一些文件笆载。由于我們已經(jīng)不在 RouteServiceProvider 中映射這些路由，所以可以直接刪除它們涯呻。接下來(lái)凉驻，我們創(chuàng)建一個(gè) modules.php 路由文件。

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

3- Books 模塊

在 app 文件夾中复罐，創(chuàng)建 Modules/Books/routes.php 文件涝登。在此文件中，我們可以定義該應(yīng)用 Books 模塊的路由規(guī)則效诅。

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

你可以使用基于控制器——也就是 Laravel 中默認(rèn)標(biāo)準(zhǔn)的路由方式胀滚，但我個(gè)人更喜歡 Good bye controllers, hello Request Handlers（放棄控制器趟济，采用請(qǐng)求處理器）的方式。如下是 ListBooks 的實(shí)現(xiàn)咽笼。

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

以上代碼中 BookResource 是 Laravel 的資源轉(zhuǎn)換層顷编。按照官方對(duì)于命名空間的建議，我們可以在 app/Modules/Books/Resources 文件夾中創(chuàng)建它剑刑。

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

4- Authors 模塊

我們還可以通過(guò) Routes 文件來(lái)啟動(dòng) Authors 模塊媳纬。

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

注意: app/Modules/Authors 這個(gè)命名空間正表示我們所編寫(xiě)的文件，對(duì)于請(qǐng)求處理程序來(lái)說(shuō)也是非常簡(jiǎn)單的施掏。

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

最后钮惠，我們將編寫(xiě)的 Resource 類(lèi)轉(zhuǎn)變?yōu)轫憫?yīng)式的 JSON 格式。

<?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 [
            'id' => $this->resource->id,
            'name' => $this->resource->name,
            'books' => $this->whenLoaded('books', function () {
                return BookResource::collection($this->resource->books);
            })
        ];
    }
}

注意資源是如何進(jìn)入另一個(gè)模塊以重用 BookResource 其监。這通常不是一個(gè)比較好的選擇萌腿，因?yàn)槟K應(yīng)該是完全自給自足的，并且只能重用標(biāo)準(zhǔn)類(lèi)抖苦，例如 Eloquent Models 或設(shè)計(jì)用于在任何模塊上通用的通用的組件毁菱。這個(gè)問(wèn)題的解決方案通常是將 BookResource 復(fù)制到 Authors 模塊中，從而可以在不使用另一個(gè)模塊的情況下進(jìn)行更改锌历，反之亦然贮庞。我決定保留這個(gè)跨模塊的用法，這個(gè)例子表現(xiàn)出一個(gè)很好的經(jīng)驗(yàn)方法究西，就是讓模塊之間彼此隔離窗慎，但是如果你認(rèn)為上面的例子很簡(jiǎn)單并且不太可能帶來(lái)任何問(wèn)題。始終確保編寫(xiě)測(cè)試以涵蓋您編寫(xiě)的功能卤材，以避免其他人在不知不覺(jué)中修改您的應(yīng)用程序遮斥。

5- 結(jié)語(yǔ)

雖然這是一個(gè)非常簡(jiǎn)單的例子，但我希望它能夠讓人們根據(jù)自己的需要來(lái)輕松操作使用 Laravel 框架的結(jié)構(gòu)標(biāo)準(zhǔn)扇丛。您可以非常輕松地更改文件的位置术吗，以便構(gòu)建基于模塊化的應(yīng)用程序。我的大多數(shù)項(xiàng)目都附帶了 App / Components 模塊帆精，可以適用于任何模塊可重用的泛類(lèi)型的基礎(chǔ)類(lèi)较屿； App / Eloquent ，Modules 文件夾可以用于保存 Eloquent 模型和數(shù)據(jù)庫(kù)關(guān)系模型卓练，我們可以在其中構(gòu)建任何基于模塊化的功能隘蝎。這是我最近開(kāi)始研究的應(yīng)用程序的文件夾目錄結(jié)構(gòu)：