README

InterNACHI/Modular 是一个用于Laravel应用的模块系统。它使用 Composer路径仓库 进行自动加载，并使用 Laravel包发现 进行模块初始化，然后提供最小化的工具来填补任何空缺。

此项目既是一套约定，也是一款包。基本思想是在单独的 app-modules/ 目录中创建“模块”，这有助于更好地组织大型项目。这些模块使用现有的 Laravel包系统，并遵循现有的Laravel约定。

• 教程视频
• 安装
• 使用方法
• 与 nwidart/laravel-modules 的比较

教程视频

安装

要开始，请运行

composer require internachi/modular

Laravel将自动发现该包，并将为您自动设置一切。

发布配置

虽然不是必需的，但强烈建议您自定义模块的默认命名空间。默认情况下，它设置为 Modules\，这完全适用，但如果您将来选择将模块提取到单独的包中，会使操作更困难。

我们建议配置一个组织命名空间（例如，我们使用 "InterNACHI"）。为此，您需要发布包配置

php artisan vendor:publish --tag=modular-config

创建模块

接下来，让我们创建一个模块

php artisan make:module my-module 

Modular将为您搭建一个新的模块

app-modules/
  my-module/
    composer.json
    src/
    tests/
    routes/
    resources/
    database/

它还会在您的应用的 composer.json 文件中添加两个新条目。第一个条目将 ./app-modules/my-module/ 注册为 路径仓库，第二个条目需要 modules/my-module:*（像任何其他Composer依赖项一样）。

然后，Modular会提醒您执行Composer更新，因此我们现在就来做这件事

composer update modules/my-module

可选：配置同步

您可以通过运行sync命令来确保项目已设置好模块支持

php artisan modules:sync

这将向您的 phpunit.xml 文件中添加一个 Modules 测试套件（如果存在），并更新您的 PhpStorm Laravel插件 配置（如果存在），以正确找到您的模块视图。

您可以随时运行此命令，因为它只会添加缺失的配置。您甚至可以将它添加到您的应用程序的 composer.json 文件中的 post-autoload-dump 脚本中。

使用方法

所有模块都遵循现有的Laravel约定，并且大多数情况下自动发现应该按预期工作。

• 命令将与Artisan自动注册
• 迁移将由Migrator运行
• 为 factory() 自动加载生成器
• 为您的模型自动发现策略

目前有一个 例外

• 事件发现（在Laravel中是可选的，默认禁用）目前不支持。

命令

包命令

我们提供了一些辅助命令

• php artisan make:module —— 搭建一个新的模块
• php artisan modules:cache —— 缓存已加载的模块，以实现稍微快一点的自动发现
• php artisan modules:clear —— 清除模块缓存
• php artisan modules:sync —— 更新项目配置（如phpunit.xml）以使用模块设置
• php artisan modules:list —— 列出所有模块

Laravel “make:” 命令

我们还为大多数Laravel make: 命令添加了 --module= 选项，以便您可以使用所有您所知道的现有工具。命令本身是完全相同的，这意味着您可以使用您的 自定义模板 和Laravel提供的一切

• php artisan make:cast MyModuleCast --module=my-module
• php artisan make:controller MyModuleController --module=my-module
• php artisan make:command MyModuleCommand --module=my-module
• php artisan make:component MyModuleComponent --module=my-module
• php artisan make:channel MyModuleChannel --module=my-module
• php artisan make:event MyModuleEvent --module=my-module
• php artisan make:exception MyModuleException --module=my-module
• php artisan make:factory MyModuleFactory --module=my-module
• php artisan make:job MyModuleJob --module=my-module
• php artisan make:listener MyModuleListener --module=my-module
• php artisan make:mail MyModuleMail --module=my-module
• php artisan make:middleware MyModuleMiddleware --module=my-module
• php artisan make:model MyModule --module=my-module
• php artisan make:notification MyModuleNotification --module=my-module
• php artisan make:observer MyModuleObserver --module=my-module
• php artisan make:policy MyModulePolicy --module=my-module
• php artisan make:provider MyModuleProvider --module=my-module
• php artisan make:request MyModuleRequest --module=my-module
• php artisan make:resource MyModule --module=my-module
• php artisan make:rule MyModuleRule --module=my-module
• php artisan make:seeder MyModuleSeeder --module=my-module
• php artisan make:test MyModuleTest --module=my-module

其他Laravel命令

除了在大多数 make: 命令中添加 --module 选项之外，我们还将其添加到了 db:seed 命令中。如果您向 db:seed 传递 --module 选项，它将在您的模块命名空间中查找您的种子

• php artisan db:seed --module=my-module 将尝试调用 Modules\MyModule\Database\Seeders\DatabaseSeeder
• php artisan db:seed --class=MySeeder --module=my-module 将尝试调用 Modules\MyModule\Database\Seeders\MySeeder

供应商命令

我们还可以将 --module 选项添加到第三方包中的命令。我们支持的第一包是Livewire。如果您已安装Livewire，则可以运行

• php artisan make:livewire counter --module=my-module

与 nwidart/laravel-modules 的比较

Laravel Modules 是一个自2016年以来一直存在的优秀包，被成千上万的个项目使用。我们决定构建自己的模块系统而不是使用 laravel-modules 而不是使用它的主要原因归结为两个决定

1. 我们想要的是遵循Laravel约定而不是使用它自己的目录结构等。
2. 我们想要的是感觉“更轻量级”的

如果您正在构建一个需要支持动态启用和禁用第三方模块的内容管理系统（CMS），那么Laravel Modules将是一个更好的选择。

另一方面，如果您主要对用于组织的模块感兴趣，并希望紧密遵循Laravel约定，我们强烈建议您尝试使用InterNACHI/Modular！