redux/modular

模块化架构

v1.1.3 2024-07-01 05:19 UTC

This package is auto-updated.

Last update: 2024-10-01 00:20:49 UTC


README

Laravel 模块化架构

此仓库提供了一组 Artisan 命令,用于在 Laravel 应用程序中生成模块、控制器、请求、资源、模型等。

简介

此包简化了在 Laravel 应用程序中创建结构化模块的过程,确保了一致性和遵循最佳实践。

要求

  • PHP >= 8.1
  • Laravel >= 9.x

安装

首先,将以下内容添加到 composer.json 中的 Composer 自动加载配置中

"Modules\\": "Modules/"

它应该看起来像这样

"autoload": {
    "psr-4": {
        "App\\": "app/",
        "Modules\\": "Modules/"
    }
}

然后,运行

composer dump-autoload

然后在 Laravel 项目目录中安装以下命令

composer require redux/modular

创建模块

要创建模块,请使用以下命令

php artisan redux:make-module <Module>

此命令将为您的模块生成必要的文件夹和文件。

现在,当您使用 "--width" 标志生成模块时,可以生成仓库、特质、接口或服务,或者合并使用以下命令

php artisan redux:make-module <Module> --with=trait

或使用多个文件

php artisan redux:make-module <Module> --with=trait,service,interface

它将生成标准化的名称,如 ModuleNameInterface、ModuleNameService 等...

创建控制器

要创建控制器,请使用以下命令

php artisan redux:make-controller <Module> <ControllerName>

要生成多个控制器,可以使用逗号分隔控制器。例如

php artisan redux:make-controller <Module> <ControllerName>,<OtherControllerName>

对于 API 控制器,可以使用 --api 标志、--resource 标志或两者都使用。

php artisan redux:make-controller <Module> <ControllerName>,<OtherControllerName> --api --resource

创建模型

要创建模型,请使用以下命令

php artisan redux:make-model <Module> <Model>

要生成多个模型,可以使用逗号分隔模型。例如

php artisan redux:make-model <Module> <Model>,<OtherModel>

要为您的模型生成迁移,可以使用 "--m" 标志

php artisan redux:make-model <Module> <Model>,<OtherModel> --m

创建请求

要在模块内创建新请求,请使用以下命令

php artisan redux:make-request <Module> <RequestName>

创建资源

要在模块内创建新资源,请使用以下命令

php artisan redux:make-resource <Module> <ResourceName>

创建服务

要在模块内创建新服务,请使用以下命令

php artisan redux:make-service <Module> <ServiceName>

创建仓库

要在模块内创建新仓库,请使用以下命令

php artisan redux:make-repository <Module> <RepositoryName>

创建接口

要在模块内创建新接口,请使用以下命令

php artisan redux:make-interface <Module> <InteraceName>

创建特质

要在模块内创建新特质,请使用以下命令

php artisan redux:make-trait <Module> <TraitName>

许可证

此项目受 MIT 许可证的许可。有关详细信息,请参阅 MIT 许可证 文件。