在Symfony 5中基于用户动态应用Doctrine SQL过滤器

本文详细介绍了如何在symfony 5应用中，利用doctrine sql过滤器与symfony事件订阅器，实现基于当前登录用户的多租户数据隔离。通过在`kernel.controller`事件中动态设置`tenant_id`过滤器参数，避免了在每个控制器操作中重复代码，从而提高了代码的可维护性和扩展性，为构建高效的多租户系统提供了专业指导。

引言：多租户应用中的数据隔离挑战

在开发多租户（Multi-tenancy）应用程序时，一个常见的需求是根据当前登录用户的租户（Tenant）ID来自动过滤所有数据库查询。这意味着每个用户只能看到属于其租户的数据，而无需在每个数据访问层手动添加WHERE tenant_id = :current_tenant_id条件。如果采用在每个控制器动作中手动设置过滤器参数的方式，如$em->getFilters()->getFilter('tenant')->setParameter('tenant_id', $security->getUser()->getTenant()->getId());，代码将变得冗余且难以维护。为了解决这一问题，Symfony和Doctrine提供了强大的扩展机制：Doctrine SQL过滤器和Symfony事件订阅器。

Doctrine SQL 过滤器简介

Doctrine ORM 的 SQL 过滤器允许我们在应用程序层面动态地修改生成的 SQL 查询，以实现全局的数据过滤。要实现基于租户ID的过滤，首先需要定义一个继承自Doctrine\ORM\Mapping\SQLFilter的自定义过滤器类。

以下是一个TenantSQLFilter的示例骨架：

// src/Doctrine/Filter/TenantSQLFilter.php
namespace App\Doctrine\Filter;

use Doctrine\ORM\Mapping\ClassMetadata;
use Doctrine\ORM\Query\Filter\SQLFilter;

class TenantSQLFilter extends SQLFilter
{
    public function addFilterConstraint(ClassMetadata $targetEntity, $targetTableAlias)
    {
        // 检查实体是否实现了TenantInterface或包含tenant_id字段
        // 这里假设实体有一个名为'tenant_id'的字段
        if (!$targetEntity->hasField('tenant_id')) {
            return '';
        }

        // 如果过滤器参数未设置，则不应用过滤
        if (!$this->hasParameter('tenant_id')) {
            return '';
        }

        // 获取并返回过滤条件
        // 'tenant_id'是SQLFilter的参数名，'value'是该参数的值
        return sprintf('%s.tenant_id = %s', $targetTableAlias, $this->getParameter('tenant_id'));
    }
}

在addFilterConstraint方法中，我们定义了如何根据tenant_id参数来过滤查询。此方法会在Doctrine构建查询时被调用，自动将WHERE tenant_id = :value添加到符合条件的实体查询中。

配置Doctrine SQL过滤器：

需要在config/packages/doctrine.yaml中注册并启用这个过滤器：

# config/packages/doctrine.yaml
doctrine:
    orm:
        filters:
            tenant:
                class: App\Doctrine\Filter\TenantSQLFilter
                enabled: true # 默认启用

enabled: true表示此过滤器默认是激活的。如果需要，也可以在运行时通过$entityManager->getFilters()->enable('tenant')或disable('tenant')来控制其状态。

利用 Symfony 事件订阅器实现动态过滤

为了避免在每个控制器中重复设置tenant_id参数，我们可以利用Symfony的事件订阅器在请求生命周期的早期阶段（例如，在控制器执行之前）动态地设置此参数。kernel.controller事件是一个理想的选择，因为它在安全组件完成用户认证之后触发，并且在控制器逻辑执行之前，允许我们访问当前用户和实体管理器。

创建事件订阅器：

创建一个名为TenantFilterEventSubscriber的类，并实现EventSubscriberInterface。

// src/EventSubscriber/TenantFilterEventSubscriber.php
namespace App\EventSubscriber;

use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\Event\ControllerEvent;
use Symfony\Component\Security\Core\Security;
use Doctrine\ORM\EntityManagerInterface;
use App\Entity\User; // 假设您的User实体位于App\Entity\User

class TenantFilterEventSubscriber implements EventSubscriberInterface
{
    protected Security $security;
    protected EntityManagerInterface $entityManager;

    public function __construct(Security $security, EntityManagerInterface $entityManager)
    {
        $this->security = $security;
        $this->entityManager = $entityManager;
    }

    /**
     * 在控制器执行前设置租户过滤器参数
     */
    public function onKernelController(ControllerEvent $event): void
    {
        // 确保租户过滤器已启用 (通常在doctrine.yaml中配置)
        if ($this->entityManager->getFilters()->isEnabled('tenant')) {
            $user = $this->security->getUser();

            // 只有当用户已登录且具有租户信息时才应用过滤器
            // 假设User实体有一个getTenant()方法返回一个具有getId()方法的对象
            if ($user instanceof User && null !== $user->getTenant()) {
                $tenantId = $user->getTenant()->getId();
                // 设置SQLFilter的'tenant_id'参数
                $this->entityManager->getFilters()->getFilter('tenant')->setParameter('tenant_id', $tenantId);
            } else {
                // 处理未登录用户或无租户用户的情况
                // 例如，对于公共页面，可能需要禁用此过滤器
                // $this->entityManager->getFilters()->disable('tenant');
            }
        }
    }

    /**
     * 注册订阅的事件及其对应的处理方法
     */
    public static function getSubscribedEvents(): array
    {
        return [
            // 订阅kernel.controller事件，并在该事件触发时调用onKernelController方法
            'kernel.controller' => 'onKernelController',
        ];
    }
}

代码解释：

1. __construct(Security $security, EntityManagerInterface $entityManager): 通过依赖注入获取Security服务（用于获取当前用户）和EntityManagerInterface（用于操作Doctrine过滤器）。
2. onKernelController(ControllerEvent $event): 这是事件监听器方法，当kernel.controller事件触发时被调用。
   • $this->entityManager->getFilters()->isEnabled('tenant'): 检查tenant过滤器是否已启用。
   • $user = $this->security->getUser(): 获取当前登录用户。
   • if ($user instanceof User && null !== $user->getTenant()): 确保用户已登录且其用户实体（假设为App\Entity\User）具有getTenant()方法，并且该方法返回的租户对象不为空。
   • $tenantId = $user->getTenant()->getId(): 获取当前用户的租户ID。
   • $this->entityManager->getFilters()->getFilter('tenant')->setParameter('tenant_id', $tenantId);: 这是核心逻辑，它获取名为tenant的SQL过滤器实例，并为其tenant_id参数设置当前用户的租户ID。
   • else块：可以根据业务需求处理未登录用户或没有关联租户的用户。例如，对于某些公共API或页面，可能需要禁用租户过滤器。
3. getSubscribedEvents(): array: 此静态方法返回一个数组，将事件名称（kernel.controller）映射到其对应的处理方法（onKernelController）。Symfony会自动发现并注册实现了EventSubscriberInterface的服务。

配置与注意事项

1. 用户实体与租户关联： 确保您的User实体与租户实体有正确的关联，并且User实体能够通过getTenant()方法返回一个包含getId()方法的租户对象。
2. 过滤器默认启用： 在doctrine.yaml中将过滤器设置为enabled: true，确保它在应用程序启动时就处于活动状态。
3. 条件性应用过滤器： 如果某些控制器或路由不需要应用租户过滤器，您可以在onKernelController方法中添加额外的条件判断。例如，通过$event->getRequest()->attributes->get('_route')获取当前路由名称，或者检查$event->getController()的实例来决定是否设置过滤器。
4. 未登录用户处理： 对于允许匿名访问的页面，$this->security->getUser()可能返回null。此时，您可以选择禁用过滤器，或者为过滤器设置一个默认值（如果您的业务逻辑允许）。
5. 缓存清除： 在部署新的事件订阅器或修改Doctrine配置后，请务必清除Symfony缓存（php bin/console cache:clear）。

总结

通过结合Doctrine SQL过滤器和Symfony事件订阅器，我们成功地实现了一个优雅且可维护的多租户数据隔离方案。这种方法将租户过滤的逻辑从业务控制器中解耦，集中在一个事件订阅器中处理，极大地提高了代码的复用性和可维护性。它确保了在每次HTTP请求中，只要用户已认证并拥有租户信息，所有相关的数据库查询都会自动应用正确的tenant_id过滤，从而有效地保护了不同租户之间的数据边界。