在php-crud-api项目中实现基于工作区的多租户数据隔离

多租户架构是现代SaaS应用中的常见需求，php-crud-api项目通过其灵活的中间件机制，可以轻松实现基于工作区的数据隔离方案。本文将详细介绍如何利用multiTenancy中间件实现这一功能。

多租户隔离的核心需求

在实际业务场景中，我们经常需要：

1. 从请求头中获取租户标识
2. 根据标识查询数据库获取工作区配置
3. 在所有CRUD操作中自动附加工作区条件
4. 确保数据操作仅限于当前租户的工作区范围

实现方案

php-crud-api提供了multiTenancy中间件，可以优雅地实现这一需求。以下是核心实现步骤：

1. 配置中间件

在api.php配置文件中添加multiTenancy中间件：

'middlewares' => 'multiTenancy,dbAuth',

2. 定义租户处理器

创建租户处理函数，该函数会在每个请求中被调用：

'multiTenancy.handler' => function ($operation, $tableName) {
    // 从请求头获取租户标识
    $tenantKey = $_SERVER['HTTP_X_TENANT_KEY'] ?? null;
    
    if (!$tenantKey) {
        throw new Exception('租户标识缺失');
    }
    
    // 查询数据库获取工作区配置
    $workspace = queryWorkspaceFromDB($tenantKey);
    
    return ['workspace' => $workspace];
},

3. 数据库查询函数实现

实现从数据库查询工作区配置的函数：

function queryWorkspaceFromDB($tenantKey) {
    // 这里应该是实际的数据库查询逻辑
    $pdo = new PDO(...);
    $stmt = $pdo->prepare('SELECT workspace FROM tenants WHERE api_key = ?');
    $stmt->execute([$tenantKey]);
    $result = $stmt->fetch();
    
    if (!$result) {
        throw new Exception('无效的租户标识');
    }
    
    return $result['workspace'];
}

工作原理

1. 请求拦截：每个API请求都会被multiTenancy中间件拦截
2. 条件注入：中间件调用处理器函数获取租户条件
3. SQL修改：
   • 对于GET请求：自动添加WHERE workspace=xxx条件
   • 对于POST/PUT请求：自动在数据中添加workspace字段
   • 对于DELETE请求：强制要求包含workspace条件

高级配置

表级过滤

如果只需要对特定表启用多租户过滤：

'multiTenancy.handler' => function ($operation, $tableName) {
    if (in_array($tableName, ['products', 'orders'])) {
        return ['workspace' => $_SESSION['tenant_workspace']];
    }
    return [];
},

会话缓存优化

为避免每次请求都查询数据库，可以将工作区信息缓存在会话中：

'multiTenancy.handler' => function ($operation, $tableName) {
    if (!isset($_SESSION['tenant_workspace'])) {
        $_SESSION['tenant_workspace'] = queryWorkspaceFromDB(
            $_SERVER['HTTP_X_TENANT_KEY']
        );
    }
    return ['workspace' => $_SESSION['tenant_workspace']];
},

注意事项

1. 确保所有相关表都有workspace字段
2. 对于POST请求，前端不需要发送workspace字段
3. 考虑添加索引优化workspace字段查询性能
4. 对于管理员等特殊角色，可能需要绕过租户过滤

通过这种实现方式，开发者可以轻松地为php-crud-api项目添加完善的多租户支持，确保不同工作区数据的完全隔离，同时保持代码的简洁性和可维护性。