Hyperf框架中实现单表字段版多租户方案详解

多租户架构概述

多租户架构是现代SaaS应用的核心设计模式，它允许单个应用实例为多个客户(租户)提供服务，同时保持数据隔离。在数据库层面，多租户通常有三种实现方式：

1. 独立数据库：每个租户使用完全独立的数据库实例
2. 共享数据库独立Schema：同一数据库实例中不同租户使用不同Schema
3. 共享数据库共享表：所有租户数据存储在相同表中，通过租户ID字段区分

本文重点介绍第三种方案——单表字段版多租户在Hyperf框架中的优雅实现。

Hyperf多租户实现方案

核心设计思路

该方案通过Hyperf的全局作用域(Global Scope)和模型特性(Trait)机制，实现了以下功能：

• 自动为所有查询添加租户过滤条件
• 提供灵活的租户字段配置
• 支持临时取消租户过滤
• 支持指定查询特定租户数据

代码实现解析

TenantTrait 租户特性

trait TenantTrait
{
    use HasGlobalScopes;

    public static function bootTenantTrait(): void
    {
        static::addGlobalScope(new TenantScope());
    }

    public static function scopeTenant(Builder $builder, array|string $_tenantId): Builder
    {
        if (empty($_tenantId)) {
            return $builder;
        }
        return $builder->withoutGlobalScope(TenantScope::class)
            ->withGlobalScope(TenantScope::class, function (Builder $builder) use ($_tenantId) {
                $builder->whereIn($builder->getModel()->getQualifiedTenantIdColumn(), $_tenantId);
            });
    }

    public function getQualifiedTenantIdColumn(): string
    {
        return $this->qualifyColumn(empty($this->tenant) ? 'tenant_id' : $this->tenant);
    }
}

关键点解析：

1. bootTenantTrait 方法在模型初始化时自动注册全局作用域
2. scopeTenant 方法提供链式调用，可指定查询特定租户数据
3. getQualifiedTenantIdColumn 方法支持自定义租户字段名

TenantScope 租户作用域

class TenantScope implements Scope
{
    public function apply(Builder $builder, Model $model): Builder
    {
        return $builder->whereIn($model->getQualifiedTenantIdColumn(), ['租户ID获取逻辑']);
    }
}

关键点解析：

1. 实现Scope接口的apply方法，自动为查询添加租户过滤
2. 租户ID可通过业务逻辑动态获取(如从JWT、Session等)

使用方式

1. 基础使用：在模型基类中use TenantTrait，所有继承该基类的模型自动具备多租户能力
2. 自定义租户字段：在模型中定义$tenant属性可指定租户字段名
3. 特定场景查询：

   // 查询特定租户数据
   Model::tenant([1, 2])->where(...)->get();
   
   // 临时取消租户过滤
   Model::withoutGlobalScope(TenantScope::class)->get();
   

方案优势

1. 无侵入性：通过Trait方式实现，不影响现有业务代码
2. 灵活性：支持动态指定租户字段和租户ID
3. 安全性：默认全局过滤，避免数据泄露风险
4. 性能优化：基于数据库原生WHERE条件过滤，效率高

实际应用建议

1. 租户ID获取逻辑应根据实际业务场景实现，常见方式包括：

   • 从JWT令牌解析
   • 从Session获取
   • 从请求头/URL参数获取

2. 对于超级管理员等需要查看所有租户数据的场景，可通过中间件动态设置租户ID范围

3. 在数据量大的情况下，建议为租户字段添加索引优化查询性能

该方案已在多个生产环境中验证，是Hyperf框架下实现多租户的高效可靠方案。