Symfony 4.4 安全在登录后获取具有关系实体数据的用户

问题描述

我正在使用 Symfony 4.4 的安全包。

我的“用户”实体与 OnetoOne 上的“信息”实体相关。

当我登录时，我希望获得“信息”数据而无需额外查询。

以我的控制器为例（登录后）

当我使用 $this->getUser();

App\Entity\User\User {#1705 ▼
  -id: 1
  -email: "email@email.com"
  -roles: array:1 [▶]
  -password: "password"
  -info: Proxies\__CG__\App\Entity\User\Info {#1716 ▼
    +__isInitialized__: false
    -id: 1
    -firstname: null
    -lastname: null
  }
}

预期结果

App\Entity\User\User {#1705 ▼
  -id: 1
  -email: "email@email.com"
  -roles: array:1 [▶]
  -password: "password"
  -info: Proxies\__CG__\App\Entity\User\Info {#1716 ▼
    +__isInitialized__: true
    -id: 1
    -firstname: "Firstname"
    -lastname: "Lastname"
  }
}

在我身边

在我的守卫的 getUser 方法中，我使用 UserRepository 通过电子邮件查找我的用户。

// \App\Security\AppCustomAuthenticator


    public function getUser($credentials,UserProviderInterface $userProvider)
    {
        // Load / create our user however you need.
        // You can do this by calling the user provider,or with custom logic here.
        $user = $this->userRepository->findUserByEmail($credentials['email']);

        if (!$user) {
            // fail authentication with a custom error
            throw new CustomUserMessageAuthenticationException('User not found');
        }

        return $user;
    }

// \App\Repository\User\UserRepository

    public function findUserByEmail(string $email): ?User
    {
        return $this->createqueryBuilder('user')
                    ->addSelect('user_info')
                    ->leftJoin('user.info','user_info')
                    ->andWhere('user.email = :email')
                    ->setParameter('email',$email)
                    ->getQuery()
                    ->getoneOrNullResult()
            ;
    }

但我在登录后丢失了实体 Info 数据。

登录后如何保留我的关系实体数据？

解决方法

我发现这是一个很好的问题，因为初学者确实经常遇到它。自定义提供程序和 getUser() 方法之间的联系并不总是很明显。
在应用程序中，用户通常并不孤单，他会提供地址、团队、尺寸、颜色和一包信息，这些信息随处可见，无需额外请求。

此链接适用于 Symfony 4.x https://symfony.com/doc/4.0/security/custom_provider.html

此链接对 Synfony 5.x 很有用
https://symfony.com/doc/current/security/user_provider.html#using-a-custom-query-to-load-the-user

我遇到了同样的问题，如果有人一直在寻找简单的解决方案。

使您的存储库实现 UserProviderInterface，添加 3 个必需的方法（loadUserByUsername、refreshUser 和 supportsClass），修改 loadUserByUsername 方法以加入想要 Doctrine 关系并修改 security.yaml 以使用您的 UserRepository 作为自定义提供程序。

# src/Repository/UserRepository.php

<?php

namespace App\Repository;

use App\Entity\User as UserEntity;
use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
use Doctrine\Persistence\ManagerRegistry;
use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
use Symfony\Component\Security\Core\User\PasswordUpgraderInterface;
use Symfony\Component\Security\Core\User\User;
use Symfony\Component\Security\Core\User\UserInterface;
use Symfony\Component\Security\Core\User\UserProviderInterface;

/**
 * @method null|UserEntity find($id,$lockMode = null,$lockVersion = null)
 * @method null|UserEntity findOneBy(array $criteria,array $orderBy = null)
 * @method UserEntity[]    findAll()
 * @method UserEntity[]    findBy(array $criteria,array $orderBy = null,$limit = null,$offset = null)
 */
class UserRepository extends ServiceEntityRepository implements PasswordUpgraderInterface,UserProviderInterface
{
    /**
     * UserRepository constructor.
     */
    public function __construct(ManagerRegistry $registry)
    {
        parent::__construct($registry,UserEntity::class);
    }

    public function upgradePassword(UserInterface $user,string $newEncodedPassword): void
    {
        if (!$user instanceof User) {
            throw new UnsupportedUserException(sprintf('Instances of "%s" are not supported.',\get_class($user)));
        }

        $user->setPassword($newEncodedPassword);
        $this->_em->persist($user);
        $this->_em->flush();
    }

    public function loadUserByUsername($username)
    {
        return $this->createQueryBuilder('u')
            ->select('u,i')
            ->leftJoin('u.info','i')
            ->where('u.username = :username')
            ->setParameter('username',$username)
            ->getQuery()
            ->getOneOrNullResult();
    }

    public function refreshUser(UserInterface $user)
    {
        return $this->loadUserByUsername($user->getUsername());
    }

    public function supportsClass($class)
    {
        return \App\Entity\User::class === $class;
    }
}

# config/packages/security.yaml

security:
    encoders:
        # ...
    providers:
        app_user_provider:
            id: App\Repository\UserRepository
    firewalls:
        # ...
    access_control:
        # ...

security security symfony symfony symfony4