享元模式（Flyweight）

目的

为了节约内存的使用，享元模式会尽量使类似的对象共享内存。在大量类似对象被使用的情况中这是十分必要的。常用做法是在外部数据结构中保存类似对象的状态，并在需要时将他们传递给享元对象。

UML 图

r5QLueDXC8.png

代码

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

FlyweightInterface.php

  2. <?php
  4. namespace DesignPatterns\Structural\Flyweight;
  6. /**
  7.  * 创建享元接口 FlyweightInterface 。
  8.  */
  9. interface FlyweightInterface
  10. {
  12.    /**
  13.     * 创建传递函数。
  14.     * 返回字符串格式数据。
  15.     */
  16.     public function render(string $extrinsicState): string;
  17. }

CharacterFlyweight.php

  2. <?php
  4. namespace DesignPatterns\Structural\Flyweight;
  6. /**
  7.  * 假如可以的话，实现享元接口并增加内存存储内部状态。
  8.  * 具体的享元实例被工厂类的方法共享。
  9.  */
  10. class CharacterFlyweight implements FlyweightInterface
  11. {
  12.     /**
  13.      * 任何具体的享元对象存储的状态必须独立于其运行环境。
  14.      * 享元对象呈现的特点，往往就是对应的编码的特点。
  15.      *
  16.      * @var string
  17.      */
  18.     private $name;
  20.     /**
  21.      * 输入一个字符串对象 $name。
  22.      */
  23.     public function __construct(string $name)
  24.     {
  25.         $this->name = $name;
  26.     }
  28.     /**
  29.      * 实现 FlyweightInterface 中的传递方法 render() 。
  30.      */
  31.     public function render(string $font): string
  32.     {
  33.          // 享元对象需要客户端提供环境依赖信息来自我定制。
  34.          // 外在状态经常包含享元对象呈现的特点，例如字符。
  36.         return sprintf('Character %s with font %s', $this->name, $font);
  37.     }
  38. }

FlyweightFactory.php

  2. <?php
  4. namespace DesignPatterns\Structural\Flyweight;
  6. /**
  7.  * 工厂类会管理分享享元类，客户端不应该直接将他们实例化。
  8.  * 但可以让工厂类负责返回现有的对象或创建新的对象。
  9.  */
  10. class FlyweightFactory implements \Countable
  11. {
  12.     /**
  13.      * @var CharacterFlyweight[]
  14.      * 定义享元特征数组。
  15.      * 用于存储不同的享元特征。
  16.      */
  17.     private $pool = [];
  19.     /**
  20.      * 输入字符串格式数据 $name。
  21.      * 返回 CharacterFlyweight 对象。
  22.      */
  23.     public function get(string $name): CharacterFlyweight
  24.     {
  25.         if (!isset($this->pool[$name])) {
  26.             $this->pool[$name] = new CharacterFlyweight($name);
  27.         }
  29.         return $this->pool[$name];
  30.     }
  32.     /**
  33.      * 返回享元特征个数。
  34.      */
  35.     public function count(): int
  36.     {
  37.         return count($this->pool);
  38.     }
  39. }

测试

Tests/FlyweightTest.php

  2. <?php
  4. namespace DesignPatterns\Structural\Flyweight\Tests;
  6. use DesignPatterns\Structural\Flyweight\FlyweightFactory;
  7. use PHPUnit\Framework\TestCase;
  9. /**
  10.  * 创建自动化测试单元 FlyweightTest 。
  11.  */
  12. class FlyweightTest extends TestCase
  13. {
  14.     private $characters = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k',
  15.         'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z'];
  16.     private $fonts = ['Arial', 'Times New Roman', 'Verdana', 'Helvetica'];
  18.     public function testFlyweight()
  19.     {
  20.         $factory = new FlyweightFactory();
  22.         foreach ($this->characters as $char) {
  23.             foreach ($this->fonts as $font) {
  24.                 $flyweight = $factory->get($char);
  25.                 $rendered = $flyweight->render($font);
  27.                 $this->assertEquals(sprintf('Character %s with font %s', $char, $font), $rendered);
  28.             }
  29.         }
  31.         // 享元模式会保证实例被分享。
  32.         // 相比拥有成百上千的私有对象，
  33.         // 必须要有一个实例代表所有被重复使用来显示不同单词的字符。
  34.         $this->assertCount(count($this->characters), $factory);
  35.     }
  36. }