适配器模式（Adapter）

目的

将一个类的接口转换成可应用的兼容接口。适配器使原本由于接口不兼容而不能一起工作的那些类可以一起工作。

例子

  • 客户端数据库适配器
  • 使用多个不同的网络服务和适配器来规范数据使得出结果是相同的

UML 图

oHBRHvqDHI.png

代码

你也可以在 GitHub 上查看代码

BookInterface.php

  2. <?php
  4. namespace DesignPatterns\Structural\Adapter;
  6. interface BookInterface
  7. {
  8.     public function turnPage();
  10.     public function open();
  12.     public function getPage(): int;
  13. }

Book.php

  2. <?php
  4. namespace DesignPatterns\Structural\Adapter;
  6. class Book implements BookInterface
  7. {
  8.     /**
  9.     * @var int
  10.     */
  11.     private $page;
  13.     public function open()
  14.     {
  15.         $this->page = 1;
  16.     }
  18.     public function turnPage()
  19.     {
  20.         $this->page++;
  21.     }
  23.     public function getPage(): int
  24.     {
  25.         return $this->page;
  26.     }
  27. }

EBookAdapter.php

  2. <?php
  4. namespace DesignPatterns\Structural\Adapter;
  6. /**
  7. * 这里是一个适配器. 注意他实现了 BookInterface,
  8. * 因此你不必去更改客户端代码当使用 Book
  9. */
  10. class EBookAdapter implements BookInterface
  11. {
  12.     /**
  13.     * @var EBookInterface
  14.     */
  15.     protected $eBook;
  17.     /**
  18.     * @param EBookInterface $eBook
  19.     */
  20.     public function __construct(EBookInterface $eBook)
  21.     {
  22.         $this->eBook = $eBook;
  23.     }
  25.     /**
  26.     * 这个类使接口进行适当的转换.
  27.     */
  28.     public function open()
  29.     {
  30.         $this->eBook->unlock();
  31.     }
  33.     public function turnPage()
  34.     {
  35.         $this->eBook->pressNext();
  36.     }
  38.     /**
  39.     * 注意这里适配器的行为： EBookInterface::getPage() 将返回两个整型，除了 BookInterface
  40.     * 仅支持获得当前页，所以我们这里适配这个行为
  41.     *
  42.     * @return int
  43.     */
  44.     public function getPage(): int
  45.     {
  46.         return $this->eBook->getPage()[0];
  47.     }
  48. }

EBookInterface.php

  2. <?php
  4. namespace DesignPatterns\Structural\Adapter;
  6. interface EBookInterface
  7. {
  8.     public function unlock();
  10.     public function pressNext();
  12.     /**
  13.     * 返回当前页和总页数，像 [10, 100] 是总页数100中的第10页。
  14.     *
  15.     * @return int[]
  16.     */
  17.     public function getPage(): array;
  18. }

Kindle.php

  2. <?php
  4. namespace DesignPatterns\Structural\Adapter;
  6. /**
  7. * 这里是适配过的类. 在生产代码中, 这可能是来自另一个包的类，一些供应商提供的代码。
  8. * 注意它使用了另一种命名方案并用另一种方式实现了类似的操作
  9. */
  10. class Kindle implements EBookInterface
  11. {
  12.     /**
  13.     * @var int
  14.     */
  15.     private $page = 1;
  17.     /**
  18.     * @var int
  19.     */
  20.     private $totalPages = 100;
  22.     public function pressNext()
  23.     {
  24.         $this->page++;
  25.     }
  27.     public function unlock()
  28.     {
  29.     }
  31.     /**
  32.     * 返回当前页和总页数，像 [10, 100] 是总页数100中的第10页。
  33.     *
  34.     * @return int[]
  35.     */
  36.     public function getPage(): array
  37.     {
  38.         return [$this->page, $this->totalPages];
  39.     }
  40. }

测试

Tests/AdapterTest.php

  2. <?php
  4. namespace DesignPatterns\Structural\Adapter\Tests;
  6. use DesignPatterns\Structural\Adapter\Book;
  7. use DesignPatterns\Structural\Adapter\EBookAdapter;
  8. use DesignPatterns\Structural\Adapter\Kindle;
  9. use PHPUnit\Framework\TestCase;
  11. class AdapterTest extends TestCase
  12. {
  13.     public function testCanTurnPageOnBook()
  14.     {
  15.         $book = new Book();
  16.         $book->open();
  17.         $book->turnPage();
  19.         $this->assertEquals(2, $book->getPage());
  20.     }
  22.     public function testCanTurnPageOnKindleLikeInANormalBook()
  23.     {
  24.         $kindle = new Kindle();
  25.         $book = new EBookAdapter($kindle);
  27.         $book->open();
  28.         $book->turnPage();
  30.         $this->assertEquals(2, $book->getPage());
  31.     }
  32. }