访问者模式（Visitor）

目的

访问者模式可以让你将对象操作外包给其他对象。这样做的最主要原因就是关注（数据结构和数据操作）分离。但是被访问的类必须定一个契约接受访问者。 (详见例子中的 Role::accept 方法)

契约可以是一个抽象类也可直接就是一个接口。在此情况下，每个访问者必须自行选择调用访问者的哪个方法。

UML 类图

file

代码

你可以在 GitHub 上找到这些代码

RoleVisitorInterface.php

  2. <?php
  4. namespace DesignPatterns\Behavioral\Visitor;
  6. /**
  7.  * 注意：访问者不能自行选择调用哪个方法，
  8.  * 它是由 Visitee 决定的。
  9.  */
  10. interface RoleVisitorInterface
  11. {
  12.     public function visitUser(User $role);
  14.     public function visitGroup(Group $role);
  15. }

RoleVisitor.php

  2. <?php
  4. namespace DesignPatterns\Behavioral\Visitor;
  6. class RoleVisitor implements RoleVisitorInterface
  7. {
  8.     /**
  9.      * @var Role[]
  10.      */
  11.     private $visited = [];
  13.     public function visitGroup(Group $role)
  14.     {
  15.         $this->visited[] = $role;
  16.     }
  18.     public function visitUser(User $role)
  19.     {
  20.         $this->visited[] = $role;
  21.     }
  23.     /**
  24.      * @return Role[]
  25.      */
  26.     public function getVisited(): array
  27.     {
  28.         return $this->visited;
  29.     }
  30. }

Role.php

  2. <?php
  4. namespace DesignPatterns\Behavioral\Visitor;
  6. interface Role
  7. {
  8.     public function accept(RoleVisitorInterface $visitor);
  9. }

User.php

  2. <?php
  4. namespace DesignPatterns\Behavioral\Visitor;
  6. class User implements Role
  7. {
  8.     /**
  9.      * @var string
  10.      */
  11.     private $name;
  13.     public function __construct(string $name)
  14.     {
  15.         $this->name = $name;
  16.     }
  18.     public function getName(): string
  19.     {
  20.         return sprintf('User %s', $this->name);
  21.     }
  23.     public function accept(RoleVisitorInterface $visitor)
  24.     {
  25.         $visitor->visitUser($this);
  26.     }
  27. }

Group.php

  2. <?php
  4. namespace DesignPatterns\Behavioral\Visitor;
  6. class Group implements Role
  7. {
  8.     /**
  9.      * @var string
  10.      */
  11.     private $name;
  13.     public function __construct(string $name)
  14.     {
  15.         $this->name = $name;
  16.     }
  18.     public function getName(): string
  19.     {
  20.         return sprintf('Group: %s', $this->name);
  21.     }
  23.     public function accept(RoleVisitorInterface $visitor)
  24.     {
  25.         $visitor->visitGroup($this);
  26.     }
  27. }

测试

Tests/VisitorTest.php

  2. <?php
  4. namespace DesignPatterns\Tests\Visitor\Tests;
  6. use DesignPatterns\Behavioral\Visitor;
  7. use PHPUnit\Framework\TestCase;
  9. class VisitorTest extends TestCase
  10. {
  11.     /**
  12.      * @var Visitor\RoleVisitor
  13.      */
  14.     private $visitor;
  16.     protected function setUp()
  17.     {
  18.         $this->visitor = new Visitor\RoleVisitor();
  19.     }
  21.     public function provideRoles()
  22.     {
  23.         return [
  24.             [new Visitor\User('Dominik')],
  25.             [new Visitor\Group('Administrators')],
  26.         ];
  27.     }
  29.     /**
  30.      * @dataProvider provideRoles
  31.      *
  32.      * @param Visitor\Role $role
  33.      */
  34.     public function testVisitSomeRole(Visitor\Role $role)
  35.     {
  36.         $role->accept($this->visitor);
  37.         $this->assertSame($role, $this->visitor->getVisited()[0]);
  38.     }
  39. }