README

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自动注册
• 迁移将由迁移器运行
• 为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！