如何将Laravel应用的控制器/视图/模型分组为独立Git仓库并复用？

这个需求其实很常见，本质就是把用户功能封装成一个可复用的Laravel模块，用Git仓库托管，让其他项目通过Composer来拉取更新。下面一步步来实现：

1. 搭建独立模块的基础结构 #

首先创建一个新的Git仓库，按照Laravel包的标准结构来组织文件，这样能无缝集成到其他Laravel项目中：

laravel-user-module/
├── src/
│   ├── Controllers/          # 存放用户控制器
│   │   └── UserController.php
│   ├── Models/               # 存放用户模型
│   │   └── User.php
│   ├── routes/               # 用户相关路由
│   │   └── web.php
│   ├── resources/
│   │   └── views/            # 用户视图文件
│   │       └── users/
│   │           ├── index.blade.php
│   │           ├── create.blade.php
│   │           └── ...
│   └── UserModuleServiceProvider.php  # 模块服务提供者
├── composer.json             # Composer配置文件
└── README.md                 # 模块说明文档

2. 配置Composer实现自动加载与集成 #

在composer.json里定义模块的基本信息、自动加载规则，以及Laravel服务提供者：

{
    "name": "你的用户名/laravel-user-module",
    "description": "Laravel项目可复用的用户管理模块",
    "type": "library",
    "license": "MIT",
    "autoload": {
        "psr-4": {
            "YourUsername\\UserModule\\": "src/"
        }
    },
    "require": {
        "laravel/framework": "^9.0|^10.0" // 根据你的Laravel版本调整兼容范围
    },
    "extra": {
        "laravel": {
            "providers": [
                "YourUsername\\UserModule\\UserModuleServiceProvider"
            ]
        }
    }
}

3. 编写模块服务提供者 #

UserModuleServiceProvider.php是模块和Laravel项目的桥梁，负责加载路由、视图等资源：

<?php

namespace YourUsername\UserModule;

use Illuminate\Support\ServiceProvider;

class UserModuleServiceProvider extends ServiceProvider
{
    public function boot()
    {
        // 加载模块路由
        $this->loadRoutesFrom(__DIR__.'/routes/web.php');
        
        // 注册模块视图，使用「user-module」作为视图命名空间
        $this->loadViewsFrom(__DIR__.'/resources/views', 'user-module');
        
        // 可选：允许将视图发布到主项目，方便自定义修改
        $this->publishes([
            __DIR__.'/resources/views' => resource_path('views/vendor/user-module'),
        ], 'user-module-views');
        
        // 如果有迁移文件，也可以在这里加载：
        // $this->loadMigrationsFrom(__DIR__.'/database/migrations');
    }

    public function register()
    {
        // 注册模块的配置（如果有的话）
        // $this->mergeConfigFrom(__DIR__.'/config/user-module.php', 'user-module');
    }
}

4. 迁移现有用户代码到模块仓库 #

把原Laravel项目中的用户相关文件移到模块对应的目录，注意修改命名空间：

• 用户模型User.php：命名空间改为YourUsername\UserModule\Models
• 用户控制器UserController.php：命名空间改为YourUsername\UserModule\Controllers
• 路由文件web.php：调整控制器的命名空间引用，比如：

<?php

use Illuminate\Support\Facades\Route;
use YourUsername\UserModule\Controllers\UserController;

Route::resource('users', UserController::class);
// 其他用户相关路由...

5. 推送模块到Git仓库 #

初始化Git并推送到你的Git平台（GitHub/GitLab等）：

git init
git add .
git commit -m "Initial commit: 完成用户模块基础搭建"
git remote add origin git@github.com:你的用户名/laravel-user-module.git
git push -u origin main

6. 在其他Laravel项目中引入模块 #

公开模块（已发布到Packagist） #

直接运行安装命令：

composer require 你的用户名/laravel-user-module

私有模块 #

先在目标项目的composer.json中添加仓库地址：

"repositories": [
    {
        "type": "vcs",
        "url": "git@github.com:你的用户名/laravel-user-module.git"
    }
]

然后再运行安装命令即可。

安装完成后，Laravel会自动注册模块的服务提供者，你可以直接访问用户路由，视图可以通过命名空间调用，比如：

@include('user-module::users.index')

7. 同步模块更新到项目 #

当你在用户模块仓库更新代码后，推送到Git，然后在目标项目中运行：

composer update 你的用户名/laravel-user-module

如果之前发布过视图想要同步更新，可以运行：

php artisan vendor:publish --tag=user-module-views --force

额外注意事项 #

• 迁移文件：如果用户模型有对应的迁移，把迁移放到模块的database/migrations目录，在服务提供者中加载，安装模块后就能执行迁移。
• 配置文件：如果有用户相关的配置，放到模块的config目录，在服务提供者中合并或发布配置。
• 版本兼容：确保模块的Laravel版本要求和目标项目一致，避免依赖冲突。

内容的提问来源于stack exchange，提问作者zundi