internachi/modular

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

可选：配置同步

你可以运行同步命令以确保你的项目已设置好支持模块：

php artisan modules:sync

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

随时运行这个命令是安全的，因为它只会添加缺失的配置。你甚至可能想要将它添加到应用程序的composer.json文件中的post-autoload-dump脚本中。

使用

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

• 命令会自动注册到Artisan
• 迁移将由Migrator运行
• 工厂会为factory()自动加载
• 策略会为你的模型自动发现
• Blade组件将被自动发现
• 事件监听器将被自动发现

命令

包命令

我们提供了一些辅助命令：

• 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=[模块名]
• php artisan make:controller MyModuleController --module=[模块名]
• php artisan make:command MyModuleCommand --module=[模块名]
• php artisan make:component MyModuleComponent --module=[模块名]
• php artisan make:channel MyModuleChannel --module=[模块名]
• php artisan make:event MyModuleEvent --module=[模块名]
• php artisan make:exception MyModuleException --module=[模块名]
• php artisan make:factory MyModuleFactory --module=[模块名]
• php artisan make:job MyModuleJob --module=[模块名]
• php artisan make:listener MyModuleListener --module=[模块名]
• php artisan make:mail MyModuleMail --module=[模块名]
• php artisan make:middleware MyModuleMiddleware --module=[模块名]
• php artisan make:model MyModule --module=[模块名]
• php artisan make:notification MyModuleNotification --module=[模块名]
• php artisan make:observer MyModuleObserver --module=[模块名]
• php artisan make:policy MyModulePolicy --module=[模块名]
• php artisan make:provider MyModuleProvider --module=[模块名]
• php artisan make:request MyModuleRequest --module=[模块名]
• php artisan make:resource MyModule --module=[模块名]
• php artisan make:rule MyModuleRule --module=[模块名]
• php artisan make:seeder MyModuleSeeder --module=[模块名]
• php artisan make:test MyModuleTest --module=[模块名]

其他Laravel命令

除了为大多数make:命令添加--module选项外，我们还为db:seed命令添加了相同的选项。如果你将--module选项传递给db:seed，它将在你的模块命名空间内查找你的播种器：

• php artisan db:seed --module=[模块名] 将尝试调用 Modules\MyModule\Database\Seeders\DatabaseSeeder
• php artisan db:seed --class=MySeeder --module=[模块名] 将尝试调用 Modules\MyModule\Database\Seeders\MySeeder

供应商命令

我们还可以为第三方包中的命令添加--module选项。我们支持的第一个包是Livewire。如果你安装了Livewire，你可以运行：

• php artisan make:livewire counter --module=[模块名]

Blade组件

你的Laravel Blade组件将自动为你注册在组件命名空间下。以下是一些示例：

自定义默认模块结构

当你调用make:module时，Modular将为你搭建一些基本的样板。如果你想自定义这个行为，你可以通过发布app-modules.php配置文件并添加你自己的存根来实现。

文件名和文件内容都支持多个占位符。这些包括：

• StubBasePath
• StubModuleNamespace
• StubComposerNamespace
• StubModuleNameSingular
• StubModuleNamePlural
• StubModuleName
• StubClassNamePrefix
• StubComposerName
• StubMigrationPrefix
• StubFullyQualifiedTestCaseBase
• StubTestCaseBase

与nwidart/laravel-modules的比较

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

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

如果你正在构建一个需要支持可以动态启用和禁用的第三方模块的CMS，Laravel Modules会更适合。

另一方面，如果你主要对组织感兴趣的模块，并且想要严格遵守Laravel约定，我们强烈建议你尝试InterNACHI/Modular！