装饰模式（Decorator）

目的

为类实例动态增加新的方法。

例子

  • Zend Framework: Zend_Form_Element 实例的装饰者
  • Web Service Layer: 用于 REST 服务的 JSON 和 XML 装饰者 (当然，在这个例子中理应只有一个是被允许的)

UML 图

file

代码

你也可以在 GitHub 上查看代码

RenderableInterface.php

  2. <?php
  4. namespace DesignPatterns\Structural\Decorator;
  6. /**
  7. * 创建渲染接口。
  8. * 这里的装饰方法 renderData() 返回的是字符串格式数据。
  9. */
  10. interface RenderableInterface
  11. {
  12.     public function renderData(): string;
  13. }

Webservice.php

  2. <?php
  4. namespace DesignPatterns\Structural\Decorator;
  6. /**
  7. * 创建 Webservice 服务类实现 RenderableInterface。
  8. * 该类将在后面为装饰者实现数据的输入。
  9. */
  10. class Webservice implements RenderableInterface
  11. {
  12.     /**
  13.     * @var string
  14.     */
  15.     private $data;
  17.     /**
  18.     * 传入字符串格式数据。
  19.     */
  20.     public function __construct(string $data)
  21.     {
  22.         $this->data = $data;
  23.     }
  25.     /**
  26.     * 实现 RenderableInterface 渲染接口中的 renderData() 方法。
  27.     * 返回传入的数据。
  28.     */
  29.     public function renderData(): string
  30.     {
  31.         return $this->data;
  32.     }
  33. }

RendererDecorator.php

  2. <?php
  4. namespace DesignPatterns\Structural\Decorator;
  6.  /**
  7.  * 装饰者必须实现渲染接口类 RenderableInterface 契约，这是该设计
  8.  * 模式的关键点。否则，这将不是一个装饰者而只是一个自欺欺人的包
  9.  * 装。
  10.  * 
  11.  * 创建抽象类 RendererDecorator （渲染器装饰者）实现渲染接口。
  12.  */
  13. abstract class RendererDecorator implements RenderableInterface
  14. {
  15.     /**
  16.      * @var RenderableInterface
  17.      * 定义渲染接口变量。
  18.      */
  19.     protected $wrapped;
  21.     /**
  22.      * @param RenderableInterface $renderer
  23.      * 传入渲染接口类对象 $renderer。
  24.      */
  25.     public function __construct(RenderableInterface $renderer)
  26.     {
  27.         $this->wrapped = $renderer;
  28.     }
  29. }

XmlRenderer.php

  2. <?php
  4. namespace DesignPatterns\Structural\Decorator;
  6. /**
  7. * 创建 Xml 修饰者并继承抽象类 RendererDecorator 。
  8. */
  9. class XmlRenderer extends RendererDecorator
  10. {
  12.     /**
  13.     * 对传入的渲染接口对象进行处理，生成 DOM 数据文件。
  14.     */
  15.     public function renderData(): string
  16.     {
  17.         $doc = new \DOMDocument();
  18.         $data = $this->wrapped->renderData();
  19.         $doc->appendChild($doc->createElement('content', $data));
  21.         return $doc->saveXML();
  22.     }
  23. }

JsonRenderer.php

  2. <?php
  4. namespace DesignPatterns\Structural\Decorator;
  6. /**
  7. * 创建 Json 修饰者并继承抽象类 RendererDecorator 。
  8. */
  9. class JsonRenderer extends RendererDecorator
  10. {
  11.     /**
  12.     * 对传入的渲染接口对象进行处理，生成 JSON 数据。
  13.     */
  14.     public function renderData(): string
  15.     {
  16.         return json_encode($this->wrapped->renderData());
  17.     }
  18. }

测试

Tests/DecoratorTest.php

  2. <?php
  4. namespace DesignPatterns\Structural\Decorator\Tests;
  6. use DesignPatterns\Structural\Decorator;
  7. use PHPUnit\Framework\TestCase;
  9. /**
  10. * 创建自动化测试单元 DecoratorTest 。
  11. */
  12. class DecoratorTest extends TestCase
  13. {
  14.     /**
  15.      * @var Decorator\Webservice
  16.      */
  17.     private $service;
  19.     /** 
  20.     * 传入字符串 'foobar' 。
  21.     */
  22.     protected function setUp()
  23.     {
  24.         $this->service = new Decorator\Webservice('foobar');
  25.     }
  27.     /**
  28.     * 测试 JSON 装饰者。
  29.     * 这里的 assertEquals 是为了判断返回的结果是否符合预期。
  30.     */
  31.     public function testJsonDecorator()
  32.     {
  33.         $service = new Decorator\JsonRenderer($this->service);
  35.         $this->assertEquals('"foobar"', $service->renderData());
  36.     }
  38.     /**
  39.     * 测试 Xml 装饰者。
  40.     */
  41.     public function testXmlDecorator()
  42.     {
  43.         $service = new Decorator\XmlRenderer($this->service);
  45.         $this->assertXmlStringEqualsXmlString('<?xml version="1.0"?><content>foobar</content>', $service->renderData());
  46.     }
  47. }