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 模块化项目已经说明完毕,希望对大家有用。

------------------------- 2022.06.05更新------------------------------

特别提醒:如果使用php artisan命令时一定要指定模块进行生成,不然会报错

PS E:\life> php artisan module:make-controller UserTestController

   Nwidart\Modules\Exceptions\ModuleNotFoundException 

  Module [] does not exist!

  at E:\life\vendor\nwidart\laravel-modules\src\FileRepository.php:397
    393▕         if ($module !== null) {
    394▕             return $module;
    398▕     }
    399▕
    400▕     /**
    401▕      * Get all modules as laravel collection instance.

  1   E:\life\vendor\nwidart\laravel-modules\src\FileRepository.php:495
      Nwidart\Modules\FileRepository::findOrFail("")

  2   E:\life\vendor\nwidart\laravel-modules\src\Traits\ModuleCommandTrait.php:14
      Nwidart\Modules\FileRepository::getUsedNow()

正确的命令是:(其它也一样)

PS E:\life> php artisan module:make-controller UserTestController Admin
Created : E:/life/Modules/Admin/Http/Controllers/UserTestController.php

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 160,108评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,699评论 1 296
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,812评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,236评论 0 213
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,583评论 3 288
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,739评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,957评论 2 315
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,704评论 0 204
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,447评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,643评论 2 249
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,133评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,486评论 3 256
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,151评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,108评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,889评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,782评论 2 277
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,681评论 2 272

推荐阅读更多精彩内容