Hyperf框架中实现模型查询的租户隔离方案

背景介绍

在SAAS(软件即服务)应用中，多租户架构是一个常见需求。每个租户的数据需要严格隔离，通常通过在数据表中添加tenant_id字段来实现。在Hyperf框架中，如何优雅地为所有模型查询自动添加租户隔离条件是一个值得探讨的技术问题。

问题分析

开发者最初尝试在模型的booting事件监听器中添加where条件来实现租户隔离，但发现这种方式并不生效。这是因为：

1. booting事件发生在模型初始化阶段，此时直接调用where方法并不会影响后续查询
2. 模型查询构造器每次查询都会创建新的实例，事件中的条件不会保留

正确解决方案：使用全局作用域(Global Scope)

Hyperf框架基于Laravel的Eloquent ORM，提供了全局作用域机制来解决这类问题。全局作用域可以自动为特定模型的所有查询添加约束条件。

实现步骤

1. 创建全局作用域类

<?php

namespace App\Model\Scope;

use Hyperf\Database\Model\Builder;
use Hyperf\Database\Model\Model;
use Hyperf\Database\Model\Scope;

class TenantScope implements Scope
{
    public function apply(Builder $builder, Model $model)
    {
        $builder->where('tenant_id', '=', 1); // 这里可以动态获取当前租户ID
    }
}

2. 在模型中注册全局作用域

<?php

namespace App\Model;

use App\Model\Scope\TenantScope;
use Hyperf\Database\Model\Model;

class TenantPackage extends Model
{
    protected static function boot()
    {
        parent::boot();
        
        static::addGlobalScope(new TenantScope());
    }
}

高级用法

1. 动态租户ID

在实际应用中，租户ID通常需要从当前登录用户或请求中获取：

public function apply(Builder $builder, Model $model)
{
    $tenantId = TenantContext::getCurrentTenantId();
    $builder->where('tenant_id', '=', $tenantId);
}

2. 移除全局作用域

某些特殊场景可能需要临时移除租户隔离：

TenantPackage::withoutGlobalScope(TenantScope::class)->get();

3. 匿名全局作用域

对于简单场景，可以直接使用匿名函数：

static::addGlobalScope('tenant', function (Builder $builder) {
    $builder->where('tenant_id', '=', 1);
});

注意事项

1. 关系查询也需要考虑租户隔离，确保关联模型也应用了相应的作用域
2. 对于系统级别的管理后台查询，可能需要特殊处理
3. 考虑在数据库层面添加租户ID索引以提高查询性能

总结

在Hyperf框架中实现多租户数据隔离，推荐使用全局作用域而非事件监听器。这种方式更加符合Eloquent ORM的设计理念，能够确保所有查询都自动应用租户隔离条件，同时保持代码的整洁性和可维护性。通过合理设计，可以构建出既安全又灵活的多租户数据访问层。