Laravel 模組化開發

doublem發表於2017-09-20
Laravel

最近專案想用Laravel框架做開發，但考慮到隨著專案的增大，程式碼的增多，需求變的複雜多樣化，將所有程式碼寫在一起，無疑是一個很大的問題，這將導致程式碼過於複雜，一些寫過的功能點想要重新使用，查詢起來太過費勁；所以考慮到使用和其他框架類似的模組化開發，但是laravel框架沒有明確的模組化劃分，所以就想找一下看是否有其他第三方模組化（Module）開發包來使用，畢竟laravel社群這麼火熱和強大，最終找到了模組化開發包，還比較好用，所以總結一下，分享出來。
感慨一下：站在巨人的肩膀上寫東西就是好！！！
這裡使用的第三方映象包是：nwidart/laravel-modules，laravel的模組管理器。用起來很方便，git地址：https://github.com/nWidart/laravel-modules
接下來就說一下使用的情況：

  1. 安裝：
    使用composer快捷安裝： 
    composer require nwidart/laravel-modules

    當然這一步是要建立在你本地已經安裝了composer的情況下。不會安裝composer可以檢視官方說明，地址：https://getcomposer.org/download/

  2. 新增服務提供者：
    接下來在config / app.php中新增以下服務提供者。 
    'providers' => [
  Nwidart\Modules\LaravelModulesServiceProvider::class,
],

    新增別名到同一檔案的別名陣列中。

    'aliases' => [
  'Module' => Nwidart\Modules\Facades\Module::class,
],

    以上兩步是進行服務註冊，必須要進行新增，不過在laravel5.5版本之後可以不新增也能執行，這得益於laravel5.5提供的包自動發現機制。
    接下來發布軟體包的配置，透過執行以下方式：

    php artisan vendor:publish --provider="Nwidart\Modules\LaravelModulesServiceProvider"

    執行完上面這條命令之後，在config資料夾下會生成一個modules.php檔案，這個是模組開發的配置檔案，你可以在這裡面進行配置。

  3. 新增自動載入：
    預設情況下，模組類不會自動載入。 您可以使用psr-4自動載入模組。
    修改檔案：composer.json 
    {
"autoload": {
   "psr-4": {
      "App\\": "app/",
      "Modules\\": "Modules/"
   }
}
}

    提示：不要忘記執行 composer dump-autoload 命令。

  4. 生成模組
    接下來生成需要的模組，使用以下命令： 
    php artisan module:make module-name

    如果需要一次生成多個模組，可以使用以下命令：

    php artisan module:make module-name1 module-name2 module-name3
  5. 檔案結構
    執行上面的生成模組命令，會生成如下檔案結構：
    如執行命令：php artisan module:make Blog 
    app/
bootstrap/
vendor/
Modules/
├── Blog/
  ├── Assets/
  ├── Config/
  ├── Console/
  ├── Database/
      ├── Migrations/
      ├── Seeders/
  ├── Entities/
  ├── Http/
      ├── Controllers/
      ├── Middleware/
      ├── Requests/
      ├── routes.php
  ├── Providers/
      ├── BlogServiceProvider.php
  ├── Resources/
      ├── lang/
      ├── views/
  ├── Repositories/
  ├── Tests/
  ├── composer.json
  ├── module.json
  ├── start.php

    至此，映象包安裝和使用已經完成，可以正常使用了。

    模組位置修改
    由於以上生成的目錄結構的模組是在和app同級的目錄下，我想把他放到app目錄下面，這樣看起來會好一點（個人習慣，可不必修改）。
    方法：修改配置檔案config/modules.php檔案

    'namespace' => 'App\Modules',
    'paths' => [
'modules' => base_path('App\Modules'),
]

    現在執行生成模組命令，生成的Modules模組會在app目錄下面。
    路由修改
    使用nwidart/laravel-modules映象包安裝的路由檔案預設是在Blog/Http/routes.php下面，而使用路由是由模組生成的start.php檔案載入的。我想把他提取出來，放到單獨的資料夾下面，像laravel的路由一樣（個人習慣，可不必修改）。
    方法：修改配置檔案config/modules.php檔案
    ①將配置檔案中有關start的配置去掉

    'stubs' => [
    'enabled' => false,
    'path' => base_path() . '/vendor/nwidart/laravel-modules/src/Commands/stubs',
    'files' => [
        // 'start' => 'start.php',
        'routes' => 'Http/routes.php',
    ],
    'replacements' => [
       // 'start' => ['LOWER_NAME'],
    ],
],

    接下來再將Blog/module.json下面生成的start.php去掉

    {
"files": [],
}

    以上兩步是為了避免程式執行期間報錯，所以必須執行。
    ②修改路由檔案生成路徑

    'stubs' => [
    'files' => [
         // 'start' => 'start.php',
        'routes' => 'Routes/routes.php',
    ],

    現在執行生成模組命令，生成的路由檔案會在Blog/Routes/route.php模組下面。
    ③接下來修改路由服務提供者，註冊路由
    執行命令：

    php artisan module:route-provider Blog

    為指定的模組生成給定的路由。
    執行完此命令之後，會在Blog/Providers目錄下面生成一個RouteServiceProvider.php檔案,此檔案就是路由的服務提供者。
    接下來修改RouteServiceProvider.php檔案

    public function map(Router $router)
{
    // if (!app()->routesAreCached()) {
    //    require __DIR__ . '/Http/routes.php';
    // }
    if (! app()->routesAreCached()) {
        $this->mapWebRoutes();
    }
}

    增加方法：

    protected function mapWebRoutes()
{
    //方法一：
    //Route::group([
       //'middleware' => 'web',
       //'namespace'  => $this->namespace,
   //], function ($router) {
       //require module_path('Admin') . '/Routes/routes.php';
   //});
    //方法二：
    Route::middleware('web')
        ->namespace($this->rootUrlNamespace)
        ->group(module_path('Blog') . '/Routes/routes.php');
}

    在此RouteServiceProvider.php檔案已經修改完畢。
    接下來修改Blog/Providers/BlogServiceProvider.php檔案，修改如下：

    public function register()
{
    //註冊服務提供者
    $this->app->register(RouteServiceProvider::class);
}

    到此使用第三方映象包，開發laravel模組化專案已經說明完畢，希望對大家有用。

本作品採用《CC 協議》，轉載必須註明作者和本文連結

相關文章