Laravel composer包UserGroup模型如何关联包外模型并在接口返回关联数据

1. 调整composer包内部逻辑，预留扩展入口 #

首先在你的usergroups包中完成以下修改：

1.1 新增配置文件支持外部自定义允许加载的关联 #

在包的config目录下新建usergroups.php配置文件，内容如下：

return [
    // 允许通过include参数加载的关联列表，外部应用可自行扩展
    'allowed_includes' => [],
];

在包的服务提供者UsergroupsServiceProvider的boot方法中注册配置发布能力：

public function boot()
{
    $this->publishes([
        __DIR__ . '/../config/usergroups.php' => config_path('usergroups.php'),
    ], 'usergroups-config');
    
    // 其余原有逻辑保持不变
}

1.2 修改控制器逻辑支持动态关联加载 #

调整UsergroupController的show方法，读取并校验include查询参数，动态加载合法关联：

public function show(UserGroup $usergroup)
{
    // 读取允许加载的关联配置
    $allowedIncludes = config('usergroups.allowed_includes', []);
    // 解析查询参数中的关联
    $requestIncludes = array_filter(explode(',', request()->query('include', '')));
    // 过滤非法关联，避免恶意加载未授权的关联数据
    $validIncludes = array_intersect($requestIncludes, $allowedIncludes);
    
    // 加载关联后返回
    return $usergroup->load($validIncludes);
}

如果需要让列表接口也支持关联加载，可对index方法做类似调整。

2. 主应用侧配置关联 #

在引入usergroups包的Laravel主应用中完成以下配置：

2.1 发布并修改包配置 #

执行命令发布配置文件：
php artisan vendor:publish --tag=usergroups-config
打开生成的config/usergroups.php，将todolists加入允许加载的关联列表：

return [
    'allowed_includes' => [
        'todolists',
        // 后续有其他关联可继续在此添加
    ],
];

2.2 动态注册模型关联 #

打开主应用的app/Providers/AppServiceProvider.php，在boot方法中注册UserGroup与TodoList的关联：

use ITGuy1990\Usergroups\Models\UserGroup;
use App\Models\TodoList;

public function boot()
{
    // 动态注册一对多关联
    UserGroup::resolveRelationUsing('todolists', function (UserGroup $userGroup) {
        return $userGroup->hasMany(TodoList::class);
    });
}

3. 效果验证 #

配置完成后访问 http://localhost:8000/api/v1/usergroups/1?include=todolists 即可返回包含TodoList关联数据的响应，且usergroups包完全不需要感知TodoList模型的存在，保持了职责单一性。 #

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