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

文章摘要：本文旨在解决 Symfony 框架中使用 #[CurrentUser] 属性时，用户对象返回 null 的问题。该问题通常由于 sensio/framework-extra-bundle 引起的参数转换器自动转换导致。通过禁用自动转换并手动定义路由参数，可以有效解决此问题，并确保 #[CurrentUser] 属性正常工作。

Symfony #[CurrentUser] 属性返回 null 的原因及解决方案

在使用 Symfony 框架开发 Web 应用时，#[CurrentUser] 属性是一个非常方便的工具，它可以直接将当前登录用户注入到控制器的方法参数中。然而，有时开发者可能会遇到 #[CurrentUser] 属性返回 null 的情况，导致程序出错。本文将深入探讨这个问题的原因，并提供详细的解决方案。

问题根源：参数转换器

该问题通常与 sensio/framework-extra-bundle 捆绑包中的参数转换器有关。当启用了自动转换时，参数转换器会尝试自动将路由参数转换为相应的实体对象。然而，在某些情况下，参数转换器可能无法正确地从数据库中获取用户实体，从而导致 $user 变量被设置为 null。

以下是一个可能出现问题的控制器示例：

<?php

declare(strict_types);

namespace App\Controller\User;

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;

#[Route('/users', name: 'user.')]
class UserController extends AbstractController
{
    #[Route(name: 'list')]
    public function list(#[CurrentUser] ?User $user, Request $request): Response { 
        dd($user->getFirstName()); // 可能触发 "Call to a member function getFirstName() on null" 错误
    }
}

尽管用户已经通过身份验证，但 $user 变量仍然为 null，导致尝试访问 $user-youjiankuohaophpcngetFirstName() 时出现错误。

解决方案：禁用自动转换

解决此问题的关键是禁用 sensio/framework-extra-bundle 的自动转换功能，并手动定义路由参数。

1. 禁用自动转换：

打开 config/packages/sensio_framework_extra.yaml 文件，并进行如下配置：

   sensio_framework_extra:
       request:
           converters: true
           auto_convert: false

将 auto_convert 设置为 false 可以阻止参数转换器自动尝试转换路由参数。

AI建筑知识问答

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

22

查看详情

2. 手动定义路由参数（可选）：

如果您仍然希望使用参数转换器的功能，可以手动定义路由参数，明确指定如何从数据库中获取实体对象。 这通常涉及使用 @ParamConverter 注解，但这超出了本文的范围。 对于 #[CurrentUser], 禁用自动转换通常就足够了。

解决方案解释

禁用自动转换后，#[CurrentUser] 属性将不再受到参数转换器的干扰，而是直接从安全上下文中获取当前登录用户。这样可以确保 $user 变量始终包含正确的用户对象，从而避免 null 错误。

注意事项

• 在修改配置文件后，请务必清除缓存，以确保配置生效。可以使用以下命令清除缓存：

  php bin/console cache:clear

  登录后复制

• 确保您的 Symfony 版本支持 #[CurrentUser] 属性。该属性是在 Symfony 5.2 中引入的。

• 仔细阅读 Symfony 官方文档，了解有关参数转换器和 #[CurrentUser] 属性的更多信息。

总结

通过禁用 sensio/framework-extra-bundle 的自动转换功能，可以有效解决 Symfony 中 #[CurrentUser] 属性返回 null 的问题。在开发过程中，理解框架的底层机制，并仔细阅读官方文档，是避免此类问题的关键。

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