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 协议》,转载必须注明作者和本文链接
本帖由 Summer 于 6年前 加精
《L05 电商实战》
从零开发一个电商项目,功能包括电商后台、商品 & SKU 管理、购物车、订单管理、支付宝支付、微信支付、订单退款流程、优惠券等
《L03 构架 API 服务器》
你将学到如 RESTFul 设计风格、PostMan 的使用、OAuth 流程,JWT 概念及使用 和 API 开发相关的进阶知识。
讨论数量: 22

你好,请问下,使用模块化开之后,当前模块的resource 目录中的如js,css 如何使用呢?

6年前 评论

我一直是使用绝对路径,虽然麻烦了点,但是管用

6年前 评论

@syy870714
可以写在当前模块下面,也可以写在外面的public文件夹下面,以模块名作为文件夹名的方式存储每个模块的js和css文件,建议写在当前模块下面,这样如果以后该模块想移动到其他地方,易于移动。

6年前 评论

@L学习不停
都可以,能解决问题就行,不一定按照我的方法来;我只是希望用到laravel自己的路由中间件去处理这个问题,而且像laravel的文件部署一样,看起来更好。

6年前 评论
'paths' => [
'modules' => base_path('App\Modules'),
]

base_path('App\Modules'), 应该改为 base_path('app/Modules'),

6年前 评论

想询问一下,分模块后resource 目录中的如js,css 在各自模块如何引用,该怎么写。我这边测试都不合适,只能写到public下了

5年前 评论

@joycore 可以写在public下,也可以写在该模块下面;不管写在什么地方,关键是你引用的路径写正确就好。如果你写在public下面,建议及起一个和该模块一样的名字的文件夹,把所有要使用的静态资源都放在该文件夹下面,例如:“public/js/xxx”。在以后分离代码的时候将该目录一起拿出去就好;这个是我个人的处理方式,当然还有其他的处理方式,只要能解决问题就好。

5年前 评论
wenber

在模块中定义的中间件还是要去 app/Http/Middleware/Kernel 中注册吗?

5年前 评论

学习了。新手路过。

5年前 评论

我把Modules 改到app目录下后,本地是没有问题的,放到线上后,加载不到模块,路由也没有,请问你遇到过这种问题吗

file

路由全部为空
Laravel

4年前 评论
KarlHsu 2年前

请教下 我用php artisan module:make-command生成了个命令后,发现执行不了,还得配置啥么

4年前 评论

你好,请问怎么刷新模块呢,我在本地创建了一个模块,上传到服务器就不识别模块路由的地址了,能识别laravel的路由

4年前 评论
amanisws 1年前

@L学习不停 老哥,你怎么引用的静态资源文件,我绝对路径都不好使,能给个列子吗

4年前 评论
L学习不停 4年前

模块化后,在模块里面的控制器里使用模型策略policy里的authorize用不了,卡着好久了,有知道怎么解决吗?

4年前 评论

请教下问题

例如我在User模块下使用了tymon/jwt-auth包,需要发布配置,但我该如何发布User模块下安装的jwt-auth包的配置文件尼

php artisan vendor:publish --provider="Tymon\JWTAuth\Providers\LaravelServiceProvider"
2年前 评论
rrsyycm 1年前

ModStart是基于Laravel的模块化极速开发框架 欢迎来访~

2年前 评论

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!
未填写
文章
1
粉丝
4
喜欢
75
收藏
62
排名:220
访问:4.4 万
私信
所有博文
社区赞助商