责任链模式（Chain Of Responsibilities）

目的

建立一个对象链来按指定顺序处理调用。如果其中一个对象无法处理命令，它会委托这个调用给它的下一个对象来进行处理，以此类推。

例子

  • 日志框架，每个链元素自主决定如何处理日志消息。
  • 垃圾邮件过滤器。
  • 缓存：例如第一个对象是一个 Memcached 接口实例，如果 “丢失” 它会委托数据库接口处理这个调用。
  • Yii 框架: CFilterChain 是一个控制器行为过滤器链。执行点会有链上的过滤器逐个传递，并且只有当所有的过滤器验证通过，这个行为最后才会被调用。

UML 图

file

代码

你也可以在 GitHub 上查看此代码

Handler.php

  2. <?php
  4. namespace DesignPatterns\Behavioral\ChainOfResponsibilities;
  6. use Psr\Http\Message\RequestInterface;
  7. use Psr\Http\Message\ResponseInterface;
  9. /**
  10.  * 创建处理器抽象类 Handler 。
  11.  */
  12. abstract class Handler
  13. {
  14.     /**
  15.      * @var Handler|null
  16.      * 定义继承处理器
  17.      */
  18.     private $successor = null;
  20.     /**
  21.      * 输入集成处理器对象。
  22.      */
  23.     public function __construct(Handler $handler = null)
  24.     {
  25.         $this->successor = $handler;
  26.     }
  28.     /**
  29.      * 通过使用模板方法模式这种方法可以确保每个子类不会忽略调用继
  30.      * 承。
  31.      *
  32.      * @param RequestInterface $request
  33.      * 定义处理请求方法。
  34.      * 
  35.      * @return string|null
  36.      */
  37.     final public function handle(RequestInterface $request)
  38.     {
  39.         $processed = $this->processing($request);
  41.         if ($processed === null) {
  42.             // 请求尚未被目前的处理器处理 => 传递到下一个处理器。
  43.             if ($this->successor !== null) {
  44.                 $processed = $this->successor->handle($request);
  45.             }
  46.         }
  48.         return $processed;
  49.     }
  51.     /**
  52.      * 声明处理方法。
  53.      */
  54.     abstract protected function processing(RequestInterface $request);
  55. }

Responsible/FastStorage.php

  2. <?php
  4. namespace DesignPatterns\Behavioral\ChainOfResponsibilities\Responsible;
  6. use DesignPatterns\Behavioral\ChainOfResponsibilities\Handler;
  7. use Psr\Http\Message\RequestInterface;
  9. /**
  10.  * 创建 http 缓存处理类。
  11.  */
  12. class HttpInMemoryCacheHandler extends Handler
  13. {
  14.     /**
  15.      * @var array
  16.      */
  17.     private $data;
  19.     /**
  20.      * @param array $data
  21.      * 传入数据数组参数。
  22.      * @param Handler|null $successor
  23.      * 传入处理器类对象 $successor 。
  24.      */
  25.     public function __construct(array $data, Handler $successor = null)
  26.     {
  27.         parent::__construct($successor);
  29.         $this->data = $data;
  30.     }
  32.     /**
  33.      * @param RequestInterface $request
  34.      * 传入请求类对象参数 $request 。
  35.      * @return string|null
  36.      * 
  37.      * 返回缓存中对应路径存储的数据。
  38.      */
  39.     protected function processing(RequestInterface $request)
  40.     {
  41.         $key = sprintf(
  42.             '%s?%s',
  43.             $request->getUri()->getPath(),
  44.             $request->getUri()->getQuery()
  45.         );
  47.         if ($request->getMethod() == 'GET' && isset($this->data[$key])) {
  48.             return $this->data[$key];
  49.         }
  51.         return null;
  52.     }
  53. }

Responsible/SlowStorage.php

  2. <?php
  4. namespace DesignPatterns\Behavioral\ChainOfResponsibilities\Responsible;
  6. use DesignPatterns\Behavioral\ChainOfResponsibilities\Handler;
  7. use Psr\Http\Message\RequestInterface;
  9. /**
  10.  * 创建数据库处理器。
  11.  */
  12. class SlowDatabaseHandler extends Handler
  13. {
  14.     /**
  15.      * @param RequestInterface $request
  16.      * 传入请求类对象 $request 。
  17.      * 
  18.      * @return string|null
  19.      * 定义处理方法，下面应该是个数据库查询动作，但是简单化模拟，直接返回一个 'Hello World' 字符串作查询结果。
  20.      */
  21.     protected function processing(RequestInterface $request)
  22.     {
  23.         // 这是一个模拟输出， 在生产代码中你应该调用一个缓慢的 （相对于内存来说） 数据库查询结果。
  25.         return 'Hello World!';
  26.     }
  27. }

测试

Tests/ChainTest.php

  2. <?php
  4. namespace DesignPatterns\Behavioral\ChainOfResponsibilities\Tests;
  6. use DesignPatterns\Behavioral\ChainOfResponsibilities\Handler;
  7. use DesignPatterns\Behavioral\ChainOfResponsibilities\Responsible\HttpInMemoryCacheHandler;
  8. use DesignPatterns\Behavioral\ChainOfResponsibilities\Responsible\SlowDatabaseHandler;
  9. use PHPUnit\Framework\TestCase;
  11. /**
  12.  * 创建一个自动化测试单元 ChainTest 。
  13.  */
  14. class ChainTest extends TestCase
  15. {
  16.     /**
  17.      * @var Handler
  18.      */
  19.     private $chain;
  21.     /**
  22.      * 模拟设置缓存处理器的缓存数据。
  23.      */
  24.     protected function setUp()
  25.     {
  26.         $this->chain = new HttpInMemoryCacheHandler(
  27.             ['/foo/bar?index=1' => 'Hello In Memory!'],
  28.             new SlowDatabaseHandler()
  29.         );
  30.     }
  32.     /**
  33.      * 模拟从缓存中拉取数据。
  34.      */
  35.     public function testCanRequestKeyInFastStorage()
  36.     {
  37.         $uri = $this->createMock('Psr\Http\Message\UriInterface');
  38.         $uri->method('getPath')->willReturn('/foo/bar');
  39.         $uri->method('getQuery')->willReturn('index=1');
  41.         $request = $this->createMock('Psr\Http\Message\RequestInterface');
  42.         $request->method('getMethod')
  43.             ->willReturn('GET');
  44.         $request->method('getUri')->willReturn($uri);
  46.         $this->assertEquals('Hello In Memory!', $this->chain->handle($request));
  47.     }
  49.     /**
  50.      * 模拟从数据库中拉取数据。
  51.      */
  52.     public function testCanRequestKeyInSlowStorage()
  53.     {
  54.         $uri = $this->createMock('Psr\Http\Message\UriInterface');
  55.         $uri->method('getPath')->willReturn('/foo/baz');
  56.         $uri->method('getQuery')->willReturn('');
  58.         $request = $this->createMock('Psr\Http\Message\RequestInterface');
  59.         $request->method('getMethod')
  60.             ->willReturn('GET');
  61.         $request->method('getUri')->willReturn($uri);
  63.         $this->assertEquals('Hello World!', $this->chain->handle($request));
  64.     }
  65. }