Symfony 4 - 从数据库定义自定义用户角色

问题描述 投票：0回答：2

我正在学习 Symfony 4，我对用户角色感到迷茫，不知道从哪里开始。 因为它将是一个类似内联网的网站，用户不会自己注册，管理员将注册他们并设置角色。管理员还可以动态创建新角色。 我想将用户角色存储在数据库中。我有 2 个实体 

User
和 
Role
。 （关系还没有定义，这很正常）

这是我的 

User
实体：

<?php

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
use Symfony\Component\Security\Core\User\UserInterface;

/**
 * @ORM\Entity(repositoryClass="App\Repository\UserRepository")
 * @UniqueEntity(fields="email", message="Email already taken")
 * @UniqueEntity(fields="username", message="Username already taken")
 */
class User implements UserInterface, \Serializable
{
    /**
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="AUTO")
     * @ORM\Column(type="integer", unique=true)
     */
    private $id;

    /**
    * @ORM\Column(type="string", length=255)
    */
    private $firstname;

    /**
     * @ORM\Column(type="string", length=255)
     */
    private $lastname;

    /**
     * @ORM\Column(type="string", length=255)
     */
    private $email;

    /**
     * @ORM\Column(type="date")
     */
    private $birthdate;

    /**
     * @ORM\Column(type="integer", nullable=true)
     */
    private $roleId;

    /**
     * @ORM\Column(type="string", length=255, nullable=false)
     */
    private $username;

    /**
     * @Assert\NotBlank()
     * @Assert\Length(max=4096)
     */
    private $plainPassword;

    /**
     * @ORM\Column(type="string", length=255, nullable=false)
     */
    private $password;

    /**
     * @ORM\Column(name="is_active", type="boolean", nullable=true)
     */
    private $isActive;

    // GETTERS

    public function getId()
    {
        return $this->id;
    }

    public function getFirstname()
    {
        return $this->firstname;
    }

    public function getLastname()
    {
        return $this->lastname;
    }

    public function getBirthdate()
    {
        return $this->birthdate;
    }

    public function getEmail()
    {
        return $this->email;
    }

    public function getRoleId()
    {
        return $this->roleId;
    }

    public function getRoles()
    {
        return array('ROLE_USER');
    }

    public function getUsername()
    {
      return $this->username;
    }

    public function getPlainPassword()
    {
        return $this->plainPassword;
    }

    public function getPassword()
    {
      return $this->password;
    }

    public function getSalt()
    {
     return null;
    }

    // SETTERS

    public function setFirstname($firstname)
    {
        $this->firstname = $firstname;
    }

    public function setLastname($lastname)
    {
        $this->lastname = $lastname;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }

    public function setBirthdate($birthdate)
    {
        $this->birthdate = $birthdate;
    }

    public function setRoleId($roleId)
    {
        $this->roleId = $roleId;
    }

    public function setUsername($username)
    {
        $this->username = $username;
    }

    public function setPlainPassword($password)
    {
        $this->plainPassword = $password;
    }


    public function setPassword($password)
    {
        $this->password = $password;
    }

    // FUNCTIONS

    public function serialize()
    {
        return serialize(array(
            $this->id,
            $this->username,
            $this->password,
            // see section on salt below
            // $this->salt,
        ));
    }

    /** @see \Serializable::unserialize() */
    public function unserialize($serialized)
    {
        list (
            $this->id,
            $this->username,
            $this->password,
            // see section on salt below
            // $this->salt
        ) = unserialize($serialized);
    }

    public function eraseCredentials()
    {

    }
}

这是我的 

Role
实体：

<?php

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity(repositoryClass="App\Repository\RoleRepository")
 */
class Role
{
    /**
     * @ORM\Id
     * @ORM\GeneratedValue
     * @ORM\Column(type="integer", unique=true)
     */
    private $id;

    /**
     * @ORM\Column(type="string", length=255, nullable=false)
     */
    private $type;

    // GETTERS

    public function getId()
    {
        return $this->id;
    }

    public function getType()
    {
        return $this->type;
    }

    // SETTERS

    public function setType($type): void
    {
        $this->type = $type;
    }
}

这样做是一个好的做法吗？

在 Symfony 文档中，我们随处都可以读到“宏”

ROLE_USER
、
ROLE_ADMIN
...它们在哪里定义的？我们可以定制这个吗？

php symfony user-roles
2个回答
19
投票

Symfony 过去通过 RoleInterface 支持角色实体，就像用户实现 UserInterface 一样。我们认为这是不必要的，因为角色表通常只包含 2 个字段（id、name），这意味着我们不妨将角色直接存储在用户表中。

所以，如果你想遵循 Symfony 最佳实践，你只需在用户中拥有你的角色，例如像这样：

class User implements UserInterface
{
    /** @Column(type="json") */
    private $roles = [];

    public function getRoles(): array
    {
        return array_unique(array_merge(['ROLE_USER'], $this->roles));
    }

    public function setRoles(array $roles)
    {
        $this->roles = $roles;
    }

    public function resetRoles()
    {
        $this->roles = [];
    }
}

如果您不想将角色存储为 JSON 编码字符串，您还可以使用 

@Column(type="array") */
或编写自定义 DBAL 类型，例如某种 EnumType。您可能还想保护设置器免受无效数据的影响或添加验证。

关于文档中使用的角色的第二个问题：Symfony 对于某些功能有一些预定义的角色和伪角色：

  • IS_AUTHENTICATED_ANONYMOUSLY
  • IS_AUTHENTICATED_REMEMBERED
  • IS_AUTHENTICATED_FULLY
  • ROLE_ALLOWED_TO_SWITCH（用于用户切换）

其他角色，如 

ROLE_USER
和 
ROLE_ADMIN
纯粹是示例，您可以根据需要使用它们。您甚至不必以 
ROLE_
开始自己的角色（尽管某些安全功能依赖于此约定，并且除非您进行一些手动更改，否则这些角色将无法按预期工作）。

3
投票

当前 Symfony 文档的推荐阅读（本答案时的版本 4）： https://symfony.com/doc/current/security.html#hierarchical-roles

Symfony 建议定义角色继承，请看看是否有帮助；从上面的链接，

” 您可以通过创建角色层次结构来定义角色继承规则，而不是为每个用户提供许多角色：

# config/packages/security.yaml
security:
# ...

role_hierarchy:
    ROLE_ADMIN:       ROLE_USER
    ROLE_SUPER_ADMIN: [ROLE_ADMIN, ROLE_ALLOWED_TO_SWITCH]

具有 ROLE_ADMIN 角色的用户也将具有 ROLE_USER 角色。拥有 ROLE_SUPER_ADMIN 的用户将自动拥有 ROLE_ADMIN、ROLE_ALLOWED_TO_SWITCH 和 ROLE_USER（继承自 ROLE_ADMIN）。

要使角色层次结构发挥作用，请勿尝试手动调用 $user->getRoles()。例如，在从基本控制器扩展的控制器中：

// BAD - $user->getRoles() will not know about the role hierarchy
$hasAccess = in_array('ROLE_ADMIN', $user->getRoles());

// GOOD - use of the normal security methods
$hasAccess = $this->isGranted('ROLE_ADMIN');
$this->denyAccessUnlessGranted('ROLE_ADMIN');

”复制结束

我认为如果继承满足您的需求，将角色存储为字符串就足够了。

最新问题
© www.soinside.com 2019 - 2024. All rights reserved.