资源库模式（Repository）

目的

该模式通过提供集合风格的接口来访问领域对象，从而协调领域和数据映射层。 资料库模式封装了一组存储在数据存储器里的对象和操作它们的方面，这样子为数据持久化层提供了更加面向对象的视角。资料库模式同时也达到了领域层与数据映射层之间清晰分离，单向依赖的目的。

例子

  • Doctrine 2 ORM: 通过资料库协调实体和 DBAL，它包含检索对象的方法。
  • Laravel 框架

UML 图例

file

代码

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

Post.php

  2. <?php
  4. namespace DesignPatterns\More\Repository;
  6. class Post
  7. {
  8.     /**
  9.      * @var int|null
  10.      */
  11.     private $id;
  13.     /**
  14.      * @var string
  15.      */
  16.     private $title;
  18.     /**
  19.      * @var string
  20.      */
  21.     private $text;
  23.     public static function fromState(array $state): Post
  24.     {
  25.         return new self(
  26.             $state['id'],
  27.             $state['title'],
  28.             $state['text']
  29.         );
  30.     }
  32.     /**
  33.      * @param int|null $id
  34.      * @param string $text
  35.      * @param string $title
  36.      */
  37.     public function __construct($id, string $title, string $text)
  38.     {
  39.         $this->id = $id;
  40.         $this->text = $text;
  41.         $this->title = $title;
  42.     }
  44.     public function setId(int $id)
  45.     {
  46.         $this->id = $id;
  47.     }
  49.     public function getId(): int
  50.     {
  51.         return $this->id;
  52.     }
  54.     public function getText(): string
  55.     {
  56.         return $this->text;
  57.     }
  59.     public function getTitle(): string
  60.     {
  61.         return $this->title;
  62.     }
  63. }

PostRepository.php

  2. <?php
  4. namespace DesignPatterns\More\Repository;
  6. /**
  7.  * 这个类位于实体层（Post 类）和访问对象层（内存）之间。
  8.  *
  9.  * 资源库封装了存储在数据存储中的对象集以及他们的操作执行
  10.  * 为持久层提供更加面向对象的视图
  11.  *
  12.  * 在域和数据映射层之间，资源库还支持实现完全分离和单向依赖的目标。
  13.  * 
  14.  */
  15. class PostRepository
  16. {
  17.     /**
  18.      * @var MemoryStorage
  19.      */
  20.     private $persistence;
  22.     public function __construct(MemoryStorage $persistence)
  23.     {
  24.         $this->persistence = $persistence;
  25.     }
  27.     public function findById(int $id): Post
  28.     {
  29.         $arrayData = $this->persistence->retrieve($id);
  31.         if (is_null($arrayData)) {
  32.             throw new \InvalidArgumentException(sprintf('Post with ID %d does not exist', $id));
  33.         }
  35.         return Post::fromState($arrayData);
  36.     }
  38.     public function save(Post $post)
  39.     {
  40.         $id = $this->persistence->persist([
  41.             'text' => $post->getText(),
  42.             'title' => $post->getTitle(),
  43.         ]);
  45.         $post->setId($id);
  46.     }
  47. }

MemoryStorage.php

  2. <?php
  4. namespace DesignPatterns\More\Repository;
  6. class MemoryStorage
  7. {
  8.     /**
  9.      * @var array
  10.      */
  11.     private $data = [];
  13.     /**
  14.      * @var int
  15.      */
  16.     private $lastId = 0;
  18.     public function persist(array $data): int
  19.     {
  20.         $this->lastId++;
  22.         $data['id'] = $this->lastId;
  23.         $this->data[$this->lastId] = $data;
  25.         return $this->lastId;
  26.     }
  28.     public function retrieve(int $id): array
  29.     {
  30.         if (!isset($this->data[$id])) {
  31.             throw new \OutOfRangeException(sprintf('No data found for ID %d', $id));
  32.         }
  34.         return $this->data[$id];
  35.     }
  37.     public function delete(int $id)
  38.     {
  39.         if (!isset($this->data[$id])) {
  40.             throw new \OutOfRangeException(sprintf('No data found for ID %d', $id));
  41.         }
  43.         unset($this->data[$id]);
  44.     }
  45. }

4.3.5. 测试

Tests/RepositoryTest.php

  2. <?php
  4. namespace DesignPatterns\More\Repository\Tests;
  6. use DesignPatterns\More\Repository\MemoryStorage;
  7. use DesignPatterns\More\Repository\Post;
  8. use DesignPatterns\More\Repository\PostRepository;
  9. use PHPUnit\Framework\TestCase;
  11. class RepositoryTest extends TestCase
  12. {
  13.     public function testCanPersistAndFindPost()
  14.     {
  15.         $repository = new PostRepository(new MemoryStorage());
  16.         $post = new Post(null, 'Repository Pattern', 'Design Patterns PHP');
  18.         $repository->save($post);
  20.         $this->assertEquals(1, $post->getId());
  21.         $this->assertEquals($post->getId(), $repository->findById(1)->getId());
  22.     }
  23. }