php - 为什么我们需要检查用户是否是 UserInterface 的实例

Question

我注意到在 FOSUserBundle Controllers ( ProfileController) 中检查 $user 是否是 UserInteface

的实例

$user = $this->getUser();
if (!is_object($user) || !$user instanceof UserInterface) {
    throw new AccessDeniedException('This user does not have access to this section.');
}

仅检查 if (!is_object($user)) 是否足够？

如果我的用户实体扩展 FOS\UserBundle\Model\User，在这种情况下 $user 将不是 UserInterface 的实例？

Answer 1

是的，如果您的代码不是开源的，否则不是。

不检查对象的实例并不能确保方法 getUser() 返回的对象将具有您期望的所有方法(例如:getUsername()).

如果您查看 Controller.php 中的 getUser() 方法它不一定返回用户对象。事实上，您可以通过 getUser() 返回不同实例的不同对象的方式设置 Symfony2 防火墙。

承认我们有一个定义 getUsername() 的接口(interface) UserInterface。

在下面的代码中，我们的用户对象没有实现UserInterface。

$user = $this->getUser();
if (!is_object($user)) {
    $user->getUsername();
}

此代码将抛出错误，因为对象上不存在 getUsername()，而代码应该如下所示:

$user = $this->getUser();
if (!is_object($user) || !$user instanceof UserInterface) {
    $user->getUsername();
}

如果用户对象没有实现正确的接口(interface)，那么代码就不会出错，因为它不会被执行。

避免检查如下对象

$user = $this->getUser();
if (!is_object($user) || !$user instanceof User) {
    $user->getRoles();
}

如果有人扩展了 User 对象，则 if 语句将不再执行，因为 $user 将不是 User 的实例，而是 ExtendedUser 即使它具有您需要的所有方法。

使用接口(interface)的另一个好处是您可以在一个对象上实现多个接口(interface)。

class A implements C {}

class B extends A implements C, D {}

interface C {}

interface D {}

$nA = new A();
$nB = new B();

$nA instanceof A; // true - instance of A
$nA instanceof B; // false - pretty obvious, no relationship with B
$nA instanceof C; // true - A implements C
$nA instanceof D; // false - A does not implement D

$nB instanceof A; // false - B is not an instance of A
$nB instanceof B; // true - instance of B
$nB instanceof C; // true - A implements C, that's the key:
                  //        both A and B implements C but B is not an
                  //        instance of A.
$nB instanceof D; // true - A implements D

TLDR；界面是设定期望和避免重大麻烦的好方法。

当您通读代码时，您可以快速识别传递的对象类型。如果有人更改代码，它要么显示有意义的错误，要么正常降级(在这种情况下，用户将被拒绝访问)。