在Symfony应用中通过事件订阅器实现Doctrine动态多租户过滤

在symfony应用中，实现基于当前用户的doctrine动态多租户过滤是一项常见的需求，尤其是在需要为每个请求自动设置如`tenant_id`等过滤条件时。本文将详细介绍如何通过symfony的事件订阅器（event subscriber）机制，优雅地解决在每个请求中动态设置doctrine sql过滤器参数的问题，从而提升代码的可维护性和整洁性。

动态设置Doctrine SQL过滤器的挑战

在多租户（Multi-tenancy）架构中，通常需要根据当前登录用户所属的租户，自动过滤数据库查询结果，确保用户只能访问其租户下的数据。Doctrine ORM提供了SQL过滤器（SQLFilter）机制来实现这一目标。然而，挑战在于如何动态地将当前用户的tenant_id参数传递给SQL过滤器，并且避免在每个控制器动作中重复编写设置逻辑，这会导致代码冗余且难以维护。

最初的解决方案可能是在每个需要过滤的控制器动作中手动设置过滤器参数：

// 在每个控制器动作中重复的代码
$em->getFilters()->getFilter('tenant')->setParameter('tenant_id', $security->getUser()->getTenant()->getId());

登录后复制

这种方法虽然可行，但显然不具备良好的可维护性。为了解决这一问题，我们需要一种机制，能够在每次请求处理前，自动且统一地设置这些动态参数。

解决方案：使用Symfony事件订阅器

Symfony的事件调度器（Event Dispatcher）提供了一种强大的方式来解耦应用程序的不同部分，并在特定事件发生时执行自定义逻辑。对于需要在每个请求处理过程中执行的全局操作，事件订阅器（Event Subscriber）是理想的选择。

我们可以监听kernel.controller事件。这个事件在控制器被确定但尚未执行之前触发，此时安全组件已经完成了用户认证，我们可以安全地访问当前登录用户的信息。

实现多租户过滤器事件订阅器

以下是实现动态设置tenant_id过滤器的事件订阅器代码示例：

首先，确保你已经创建了一个名为tenant的Doctrine SQL过滤器，并在config/packages/doctrine.yaml中进行了配置和启用。例如：

# config/packages/doctrine.yaml
doctrine:
    orm:
        filters:
            tenant:
                class: App\Doctrine\Filter\TenantFilter # 你的SQLFilter类路径
                enabled: true # 确保过滤器已启用

登录后复制

然后，创建TenantFilterEventSubscriber类，通常放置在src/EventSubscriber/目录下。