专栏首页恩蓝脚本PHP设计模式之装饰器(装饰者)模式(Decorator)入门与应用详解

PHP设计模式之装饰器(装饰者)模式(Decorator)入门与应用详解

本文实例讲述了PHP设计模式之装饰器(装饰者)模式(Decorator)入门与应用。分享给大家供大家参考,具体如下:

通常情况下,我们如果要给对象添加功能,要么直接修改对象添加相应的功能,要么派生对应的子类来扩展,抑或是使用对象组合的方式。显然,直接修改对应的类这种方式并不可取。

在面向对象的设计中,我们也应该尽量使用对象组合,而不是对象继承来扩展和复用功能。装饰器模式就是基于对象组合的方式,可以很灵活的给对象添加所需要的功能,并且它的本质就是动态组合,一句话,动态是手段,组合才是目的。

也就是说,在这种模式下,我们可以对已有对象的部分内容或者功能进行调整,但是不需要修改原始对象结构,理解了不???

还可以理解为,我们不去修改已有的类,而是通过创建另外一个装饰器类,通过这个装饰器类去动态的扩展其需要修改的内容。而它的好处也是显而易见的,如下:

  • 1、我们可以保证类的层次不会因过多而发生混乱。
  • 2、当我们需求的修改很小时,不用改变原有的数据结构。

我们来看下《PHP设计模式》里面的一个案例:

/** * 被修饰类 现在的需求: 要求能够动态为CD添加音轨、能显示CD音轨列表。 显示时应采用单行并且为每个音轨都以音轨好为前缀。 */
class CD {
  public $trackList;
  function __construct()  {
    # code...
    $this- trackList=array();
  }
  public function addTrack($track){
    $this- trackList[]=$track;
  }
  public function getTrackList(){
    $output=" ";
    foreach ($this- trackList as $key =  $value) {
      # code...
      $output.=($key+1).") {$value}. ";
    }
    return $output;
  }
}
/* 现在需求发生变化: 要求将当前实例输出的音轨都采用大写形式。 这个需求并不是一个变化特别大的需求,不需要修改基类或创建一个父子关系的子类,此时创建一个基于装饰器模式的装饰器类。 */
class CDTrackListDecoratorCaps{
  private $_cd;
  public function __construct(CD $CD){
    $this- _cd=$CD;
  }
  public function makeCaps(){
    foreach ($this- _cd- trackList as $key =  $value) {
      # code...
      $this- _cd- trackList[$key]=strtoupper($value); //转换成大写
    }
  }
}
//客户端测试
$myCD=new CD();
$trackList=array(  "what It Means",  "brr",  "goodBye" );
foreach ($trackList as $key =  $value) {
  # code...
  $myCD- addTrack($value);
}
$myCDCaps=new CDTrackListDecoratorCaps($myCD);
$myCDCaps- makeCaps();
print "The CD contains the following tracks:".$myCD- getTrackList();

来看一个比较通俗但是比较简单的案例:

  • 设计一个UserInfo类,里面有UserInfo数组,用于存储用户名信息
  • 通过addUser来添加用户名
  • getUserList方法将打印出用户名信息
  • 现在需要将添加的用户信息变成大写的,我们需要不改变原先的类,并且不改变原先的数据结构
  • 我们设计了一个UserInfoDecorate类来完成这个需求的操作,就像装饰一样,给原先的数据进行了装修
  • 装饰器模式有些像适配器模式,但是一定要注意,装饰器主要是不改变现有对象数据结构的前提

代码如下:

UserInfo.php

//装饰器模式,对已有对象的部分内容或者功能进行调整,但是不需要修改原始对象结构,可以使用装饰器设计模式
class UserInfo {
 public $userInfo = array(); 
 
 public function addUser($userInfo) {
 $this- userInfo[] = $userInfo;
 }
 
 public function getUserList() {
 print_r($this- userInfo);
 }
}
//UserInfoDecorate 装饰一样,改变用户信息输出为大写格式,不改变原先UserInfo类
<?php
include("UserInfo.php");
class UserInfoDecorate {
 
 public function makeCaps($UserInfo) {
 foreach ($UserInfo- userInfo as &$val) {
  $val = strtoupper($val);
 }
 }
 
}
$UserInfo = new UserInfo;
$UserInfo- addUser('zhu');
$UserInfo- addUser('initphp');
$UserInfoDecorate = new UserInfoDecorate;
$UserInfoDecorate- makeCaps($UserInfo);
$UserInfo- getUserList();

到此,咱们应该是对于装饰器模式有了一个大概的了解,接下来咱们看一下构建装饰器模式的案例,网上的,先来看目录结构:

|decorator #项目根目录 |–Think #核心类库 |—-Loder.php #自动加载类 |—-decorator.php #装饰器接口 |—-colorDecorator.php #颜色装饰器 |—-sizeDecorator.php #字体大小装饰器 |—-echoText.php #被装饰者 |–index.php #单一的入口文件

完事就是来构建装饰器接口,Think/decorator.php,如下:

<?php
/**
 * 装饰器接口
 * Interface decorator
 * @package Think
 */
namespace Think;
interface decorator{
  public function beforeDraw();
  public function afterDraw();
}

再来就是颜色装饰器 Think/colorDecorator.php,如下:

<?php
/**
 * 颜色装饰器
 */
namespace Think;
class colorDecorator implements decorator{
  protected $color;
  public function __construct($color) {
    $this- color = $color;
  }
  public function beforeDraw() {
    echo "color decorator :{$this- color}\n";
  }
  public function afterDraw() {
    echo "end color decorator\n";
  }
}

还有就是字体大小装饰器 Think/sizeDecorator.php,如下:

<?php
/**
 * 字体大小装饰器
 */
namespace Think;
class sizeDecorator implements decorator{
  protected $size;
  public function __construct($size) {
    $this- size = $size;
  }
  public function beforeDraw() {
    echo "size decorator {$this- size}\n";
  }
  public function afterDraw() {
    echo "end size decorator\n";
  }
}

还有被装饰者 Think/echoText.php,如下:

<?php
/**
 * 被装饰者
 */
namespace Think;
class echoText {
  protected $decorator = array(); //存放装饰器
  //装饰方法
  public function index() {
    //调用装饰器前置操作
    $this- before();
    echo "你好,我是装饰器\n";
    //执行装饰器后置操作
    $this- after();
  }
  public function addDecorator(Decorator $decorator) {
    $this- decorator[] = $decorator;
  }
  //执行装饰器前置操作 先进先出
  public function before() {
    foreach ($this- decorator as $decorator){
      $decorator- beforeDraw();
    }
  }
  //执行装饰器后置操作 先进后出
  public function after() {
    $decorators = array_reverse($this- decorator);
    foreach ($decorators as $decorator){
      $decorator- afterDraw();
    }
  }
}

再来个自动加载 Think/Loder.php,如下:

<?php
namespace Think;
class Loder{
  static function autoload($class){
    require BASEDIR . '/' .str_replace('\','/',$class) . '.php';
  }
}

最后就是入口文件index.php了,如下:

<?php
define('BASEDIR',__DIR__);
include BASEDIR . '/Think/Loder.php';
spl_autoload_register('\Think\Loder::autoload');
//实例化输出类
$echo = new \Think\echoText();
//增加装饰器
$echo- addDecorator(new \Think\colorDecorator('red'));
//增加装饰器
$echo- addDecorator(new \Think\sizeDecorator('12'));
//装饰方法
$echo- index();

咱最后再来一个案例啊,就是Web服务层 —— 为 REST 服务提供 JSON 和 XML 装饰器,来看代码:

RendererInterface.php

<?php
namespace DesignPatterns\Structural\Decorator;
/**
 * RendererInterface接口
 */
interface RendererInterface
{
  /**
   * render data
   *
   * @return mixed
   */
  public function renderData();
}

Webservice.php

<?php
namespace DesignPatterns\Structural\Decorator;
/**
 * Webservice类
 */
class Webservice implements RendererInterface
{
  /**
   * @var mixed
   */
  protected $data;
  /**
   * @param mixed $data
   */
  public function __construct($data)
  {
    $this- data = $data;
  }
  /**
   * @return string
   */
  public function renderData()
  {
    return $this- data;
  }
}

Decorator.php

<?php
namespace DesignPatterns\Structural\Decorator;
/**
 * 装饰器必须实现 RendererInterface 接口, 这是装饰器模式的主要特点,
 * 否则的话就不是装饰器而只是个包裹类
 */
/**
 * Decorator类
 */
abstract class Decorator implements RendererInterface
{
  /**
   * @var RendererInterface
   */
  protected $wrapped;
  /**
   * 必须类型声明装饰组件以便在子类中可以调用renderData()方法
   *
   * @param RendererInterface $wrappable
   */
  public function __construct(RendererInterface $wrappable)
  {
    $this- wrapped = $wrappable;
  }
}

RenderInXml.php

<?php
namespace DesignPatterns\Structural\Decorator;
/**
 * RenderInXml类
 */
class RenderInXml extends Decorator
{
  /**
   * render data as XML
   *
   * @return mixed|string
   */
  public function renderData()
  {
    $output = $this- wrapped- renderData();
    // do some fancy conversion to xml from array ...
    $doc = new \DOMDocument();
    foreach ($output as $key =  $val) {
      $doc- appendChild($doc- createElement($key, $val));
    }
    return $doc- saveXML();
  }
}

RenderInJson.php

<?php
namespace DesignPatterns\Structural\Decorator;
/**
 * RenderInJson类
 */
class RenderInJson extends Decorator
{
  /**
   * render data as JSON
   *
   * @return mixed|string
   */
  public function renderData()
  {
    $output = $this- wrapped- renderData();
    return json_encode($output);
  }
}

Tests/DecoratorTest.php

<?php
namespace DesignPatterns\Structural\Decorator\Tests;
use DesignPatterns\Structural\Decorator;
/**
 * DecoratorTest 用于测试装饰器模式
 */
class DecoratorTest extends \PHPUnit_Framework_TestCase
{
  protected $service;
  protected function setUp()
  {
    $this- service = new Decorator\Webservice(array('foo' =  'bar'));
  }
  public function testJsonDecorator()
  {
    // Wrap service with a JSON decorator for renderers
    $service = new Decorator\RenderInJson($this- service);
    // Our Renderer will now output JSON instead of an array
    $this- assertEquals('{"foo":"bar"}', $service- renderData());
  }
  public function testXmlDecorator()
  {
    // Wrap service with a XML decorator for renderers
    $service = new Decorator\RenderInXml($this- service);
    // Our Renderer will now output XML instead of an array
    $xml = '<?xml version="1.0"? <foo bar</foo ';
    $this- assertXmlStringEqualsXmlString($xml, $service- renderData());
  }
  /**
   * The first key-point of this pattern :
   */
  public function testDecoratorMustImplementsRenderer()
  {
    $className = 'DesignPatterns\Structural\Decorator\Decorator';
    $interfaceName = 'DesignPatterns\Structural\Decorator\RendererInterface';
    $this- assertTrue(is_subclass_of($className, $interfaceName));
  }
  /**
   * Second key-point of this pattern : the decorator is type-hinted
   *
   * @expectedException \PHPUnit_Framework_Error
   */
  public function testDecoratorTypeHinted()
  {
    if (version_compare(PHP_VERSION, '7', ' =')) {
      throw new \PHPUnit_Framework_Error('Skip test for PHP 7', 0, __FILE__, __LINE__);
    }
    $this- getMockForAbstractClass('DesignPatterns\Structural\Decorator\Decorator', array(new \stdClass()));
  }
  /**
   * Second key-point of this pattern : the decorator is type-hinted
   *
   * @requires PHP 7
   * @expectedException TypeError
   */
  public function testDecoratorTypeHintedForPhp7()
  {
    $this- getMockForAbstractClass('DesignPatterns\Structural\Decorator\Decorator', array(new \stdClass()));
  }
  /**
   * The decorator implements and wraps the same interface
   */
  public function testDecoratorOnlyAcceptRenderer()
  {
    $mock = $this- getMock('DesignPatterns\Structural\Decorator\RendererInterface');
    $dec = $this- getMockForAbstractClass('DesignPatterns\Structural\Decorator\Decorator', array($mock));
    $this- assertNotNull($dec);
  }
}

好啦,本次记录就到这里了。

更多关于PHP相关内容感兴趣的读者可查看本站专题:《php面向对象程序设计入门教程》、《PHP数组(Array)操作技巧大全》、《PHP基本语法入门教程》、《PHP运算与运算符用法总结》、《php字符串(string)用法总结》、《php+mysql数据库操作入门教程》及《php常见数据库操作技巧汇总》

希望本文所述对大家PHP程序设计有所帮助。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • PHP+RabbitMQ实现消息队列的完整代码

    首先,从业务上来讲,我并不要求消息的100%接受率,并且,我需要结合php开发,RabbitMq相较RocketMq,延迟较低(微妙级)。至于ActiveMq,...

    砸漏
  • laravel返回统一格式错误码问题

    最近在学习开发一个安卓项目,后端接口项目开始用PHP的Yii2.0框架新启了个项目,后换成laravel5.5,最近看到laravel升级了新版本,于是又将项目...

    砸漏
  • PHP模版引擎原理、定义与用法实例

    更多关于PHP相关内容感兴趣的读者可查看本站专题:《PHP模板技术总结》、《PHP基于pdo操作数据库技巧总结》、《PHP运算与运算符用法总结》、《PHP网络编...

    砸漏
  • PHP设计模式——迭代模式

    作为商店经理,Eric的工作包括检修各个部门的产品。商店中实际上有两个部门。一个部门称为男士部门,该部门存放男性用品,另一个部门称为女士部门的女性用品。每个部门...

    Lemon黄
  • 七夕最污代码,单身慎入

    2.找不到对象说爱(Fatal error: Call to a member function on a non-object), 他怎么才能说出爱?

    后端技术探索
  • MQTT简单封装类-TypeScript实现

    使用过C++和Nodejs的Mqtt封装类,之前使用过mosquitto的C语言库以及mosquittopp的C++库;另外nodejs中也有一个mqtt的模块...

    ccf19881030
  • PHP设计模式之组合模式

    互联网公司流行扁平化管理,也就是管理层级尽量少于或者不超过三层,作为一个底层的码农,你的CEO和你的职级也就相差3层以内。但是很多传统企业,则会有非常深的层级关...

    硬核项目经理
  • typecho文章倒序显示

    乐心湖
  • java队列

    队列为特殊的线性表,队列的特点先进先出(FIFO),队列插入为入队,队列删除为出对。

    mySoul
  • PHP设计模式——抽象方法

    Dragon公司的业务受到轰炸,而CEO希望特许所有海外分支机构的专营权。他首先要注意的问题是如何确保产品质量。他们不希望特许经营者削减成本和使用低质量的组件。...

    Lemon黄

扫码关注云+社区

领取腾讯云代金券