解决Symfony #[CurrentUser] 属性返回 null 的问题

本文针对Symfony框架中使用#[CurrentUser]属性时可能遇到的null值问题，进行了深入分析和详细解答。通过剖析问题根源，即ParamConverter的自动转换机制，提供了禁用自动转换并手动定义路由参数的解决方案。同时，强调了阅读官方文档的重要性，避免类似问题的再次发生，助力开发者更高效地使用Symfony框架。

在使用Symfony框架时，#[CurrentUser] 属性提供了一种便捷的方式来获取当前登录用户的信息。然而，有时开发者可能会遇到该属性返回 null 的情况，即使已经通过身份验证。本文将深入探讨此问题的原因，并提供相应的解决方案。

问题根源：ParamConverter 的干扰

问题的核心通常在于启用了 ParamConverter (sensio/framework-extra-bundle)。ParamConverter 负责自动将请求参数转换为控制器方法的参数。当它尝试解析 User 对象时，如果缺少从数据库获取实体的明确定义，就会导致解析失败，并将 $user 变量设置为 null，这与 #[CurrentUser] ?User $user 中允许为空的定义相符。

解决方案：禁用自动转换并手动定义路由参数

要解决此问题，您可以禁用 ParamConverter 的自动转换功能，并手动定义路由参数。

1. 禁用自动转换：

在 config/packages/sensio_framework_extra.yaml 文件中，进行如下配置：

AI建筑知识问答

用人工智能ChatGPT帮你解答所有建筑问题

22

查看详情

   sensio_framework_extra:
       request:
           converters: true
           auto_convert: false

此配置保留了 ParamConverter 的基本功能，但禁用了自动转换。

2. 手动定义路由参数：

禁用自动转换后，您需要手动定义如何从请求参数中获取 User 实体。这通常涉及到使用 Doctrine 查询数据库。

例如，如果您的路由需要一个用户 ID，您可以这样定义：

   use App\Entity\User;
   use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
   use Symfony\Component\HttpFoundation\Request;
   use Symfony\Component\HttpFoundation\Response;
   use Symfony\Component\Routing\Annotation\Route;
   use Symfony\Component\Security\Http\Attribute\CurrentUser;
   use Doctrine\ORM\EntityManagerInterface;

   #[Route('/users/{id}', name: 'user.show')]
   class UserController extends AbstractController
   {
       public function show(int $id, #[CurrentUser] ?User $currentUser, EntityManagerInterface $entityManager): Response
       {
           $user = $entityManager->getRepository(User::class)->find($id);

           if (!$user) {
               throw $this->createNotFoundException(
                   'No user found for id '.$id
               );
           }

           // 使用 $user 和 $currentUser
           return new Response('Hello '.$user->getFirstName().' Current User: '.$currentUser?->getFirstName());
       }
   }

在这个例子中，我们使用 {id} 作为路由参数，并在控制器方法中使用 $entityManager 从数据库中查找对应的 User 实体。 同时保留了#[CurrentUser] 注解， 这样就可以同时访问当前登录用户($currentUser)和通过ID获取的用户信息($user)

注意事项与总结

• 阅读文档： 遇到问题时，务必仔细阅读官方文档。很多问题的答案都隐藏在文档的细节之中。
• 理解 ParamConverter： 深入了解 ParamConverter 的工作原理，可以帮助您更好地理解 Symfony 的请求处理流程。
• 调试技巧： 使用 Symfony Profiler 可以帮助您诊断路由参数解析和身份验证问题。
• 代码示例： 上述代码示例仅供参考，请根据您的实际应用场景进行调整。

通过禁用 ParamConverter 的自动转换并手动定义路由参数，您可以有效地解决 #[CurrentUser] 属性返回 null 的问题，并更好地控制 Symfony 应用程序的行为。 始终记住，详细的文档阅读和理解是避免此类问题的关键。

以上就是解决Symfony #[CurrentUser] 属性返回 null 的问题的详细内容，更多请关注php中文网其它相关文章！