观察者模式（Observer）

目的

当对象的状态发生变化时，所有依赖于它的对象都得到通知并被自动更新。它使用的是低耦合的方式。

例子

  • 使用观察者模式观察消息队列在 GUI 中的运行情况。

注意

PHP 已经定义了2个接口用于快速实现观察者模式：SplObserver 和 SplSubject。

UML 图

sWK78CV3NN.png

代码

你可以在 GitHub 查看这段代码。

User.php

  2. <?php
  4. namespace DesignPatterns\Behavioral\Observer;
  6. /**
  7.  * User 实现观察者模式 (称为主体)，它维护一个观察者列表，
  8.  * 当对象发生变化时通知  User。
  9.  */
  10. class User implements \SplSubject
  11. {
  12.     /**
  13.  * @var string
  14.  */
  15.     private $email;
  17.     /**
  18.  * @var \SplObjectStorage
  19.  */
  20.     private $observers;
  22.     public function __construct()
  23.     {
  24.         $this->observers = new \SplObjectStorage();
  25.     }
  27.     public function attach(\SplObserver $observer)
  28.     {
  29.         $this->observers->attach($observer);
  30.     }
  32.     public function detach(\SplObserver $observer)
  33.     {
  34.         $this->observers->detach($observer);
  35.     }
  37.     public function changeEmail(string $email)
  38.     {
  39.         $this->email = $email;
  40.         $this->notify();
  41.     }
  43.     public function notify()
  44.     {
  45.         /** @var \SplObserver $observer */
  46.         foreach ($this->observers as $observer) {
  47.             $observer->update($this);
  48.         }
  49.     }
  50. }

UserObserver.php

  2. <?php
  4. namespace DesignPatterns\Behavioral\Observer;
  6. class UserObserver implements \SplObserver
  7. {
  8.     /**
  9.  * @var User[]
  10.  */
  11.     private $changedUsers = [];
  13.     /**
  14.  * 它通常使用  SplSubject::notify()  通知主体
  15.  *
  16.  * @param \SplSubject $subject
  17.  */
  18.     public function update(\SplSubject $subject)
  19.     {
  20.         $this->changedUsers[] = clone $subject;
  21.     }
  23.     /**
  24.  * @return User[]
  25.  */
  26.     public function getChangedUsers(): array
  27.     {
  28.         return $this->changedUsers;
  29.     }
  30. }

测试

Tests/ObserverTest.php

  2. <?php
  4. namespace DesignPatterns\Behavioral\Observer\Tests;
  6. use DesignPatterns\Behavioral\Observer\User;
  7. use DesignPatterns\Behavioral\Observer\UserObserver;
  8. use PHPUnit\Framework\TestCase;
  10. class ObserverTest extends TestCase
  11. {
  12.     public function testChangeInUserLeadsToUserObserverBeingNotified()
  13.     {
  14.         $observer = new UserObserver();
  16.         $user = new User();
  17.         $user->attach($observer);
  19.         $user->changeEmail('foo@bar.com');
  20.         $this->assertCount(1, $observer->getChangedUsers());
  21.     }
  22. }