Laravel多租户Tenancy包：仅同步特定用户的实现问题

问题分析 #

当前所有租户数据库（TenantDB）中的用户都会同步回中央数据库（CentralDB），核心原因是User模型实现Syncable接口并使用ResourceSyncing trait后，默认触发全量同步；同时创建用户时未区分主/二级用户，导致二级用户也被自动生成global_id并尝试同步。

解决方案步骤 #

1. 为用户模型添加身份标识字段

在租户的users表中新增is_owner字段，用于区分需要同步的主用户和无需同步的二级用户：

// 租户数据库的users表迁移文件
Schema::table('users', function (Blueprint $table) {
    $table->boolean('is_owner')->default(false)->comment('是否为租户主用户');
});

2. 修改租户User模型，控制同步逻辑

重写ResourceSyncing trait的同步判断逻辑，仅允许主用户同步到中央库；同时在创建用户时，仅为主用户生成global_id：

use Illuminate\Support\Str;
use Stancl\Tenancy\Contracts\Syncable;
use Stancl\Tenancy\Database\Concerns\ResourceSyncing;

class User extends Model implements Syncable
{
    use ResourceSyncing;

    protected $guarded = [];
    public $timestamps = false;
    protected $fillable = ['name', 'password', 'email', 'is_owner']; // 新增is_owner到可填充字段

    protected static function boot()
    {
        parent::boot();

        // 仅为主用户生成global_id
        static::creating(function ($user) {
            if ($user->is_owner) {
                $user->global_id = Str::uuid()->toString();
            } else {
                $user->global_id = null; // 二级用户不设置global_id
            }
        });
    }

    // 重写同步判断方法，仅主用户同步到中央库
    public function shouldSyncToCentral(): bool
    {
        return $this->is_owner === true;
    }

    // 以下为原有方法，保持不变
    public function getGlobalIdentifierKey()
    {
        return $this->getAttribute($this->getGlobalIdentifierKeyName());
    }

    public function getGlobalIdentifierKeyName(): string
    {
        return 'global_id';
    }

    public function getCentralModelName(): string
    {
        return CentralUser::class;
    }

    public function getSyncedAttributeNames(): array
    {
        return [
            'name',
            'password',
            'email',
        ];
    }
}

3. 调整用户创建逻辑

• 客户购买权限创建主用户时，设置is_owner = true，此时会自动生成global_id并同步到CentralDB，同时在tenant_users关联表中建立记录。
• 主用户在租户空间创建二级用户时，设置is_owner = false，该用户不会生成global_id，也不会触发同步逻辑，仅存在于当前租户数据库中。

4. 可选：优化中央库关联逻辑

如果需要确保中央库仅关联主用户，可以在CentralUser模型的tenants关联中添加筛选：

public function tenants(): BelongsToMany
{
    return $this->belongsToMany(Tenant::class, 'tenant_users', 'global_user_id', 'tenant_id', 'global_id')
        ->using(TenantPivot::class)
        ->whereHas('users', function ($query) {
            $query->where('is_owner', true);
        });
}

效果验证 #

• 创建租户主用户：自动生成global_id，成功同步到CentralDB，并在关联表中建立绑定。
• 创建租户二级用户：不生成global_id，不会同步到CentralDB，仅保留在当前租户库内。

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