Day42. 范例：仿真Git （备忘录模式）

本文同步更新於blog

情境：让我们利用备忘录模式，实作一个仿真Git

• 首先定义Commit

<?php

namespace App\MementoPattern\Git;

/**
 * This is our Memento in memento pattern
 */
class Commit
{
    /**
     * This is our state.
     *
     * @var string
     */
    private $code;

    public function __construct(string $code)
    {
        $this->code = $code;
    }

    public function getCode(): string
    {
        return $this->code;
    }
}

Commit属於备忘录类别 (Memento)，
负责储存 原始类别 (Originator) 的状态。

在这个范例中，code就是我们的状态。

• 接着定义Folder

<?php

namespace App\MementoPattern\Git;

use App\MementoPattern\Git\Commit;

/**
 * This is our CareTaker in memento pattern
 */
class Folder
{
    /**
     * @var Commit[]
     */
    private $commits = [];

    /**
     * @param Commit $commit
     */
    public function saveCommit(Commit $commit)
    {
        $this->commits[] = $commit;
    }

    /**
     * @param int $previous
     * @return Commit
     */
    public function getPreviousCommit(int $previous): Commit
    {
        $commitAmount = count($this->commits);
        $index = $commitAmount - $previous;

        $result = $this->commits[$index];
        return $result;
    }
}

Folder属於管理类别 (Caretaker)，
负责管理Commit的存储。

• 接着是我们的Git类别

<?php

namespace App\MementoPattern\Git;

use App\MementoPattern\Git\Commit;
use App\MementoPattern\Git\Folder;

/**
 * This is our Originator in memento pattern
 */
class Git
{
    /**
     * @var Folder
     */
    protected $folder;

    /**
     * This is our state.
     *
     * @var string
     */
    private $code;

    /**
     * @param Folder $folder
     */
    public function __construct(Folder $folder)
    {
        $this->folder = $folder;
    }

    /**
     * Getter
     *
     * @return string
     */
    public function getUntrackedCode(): string
    {
        return $this->code;
    }

    /**
     * Setter
     *
     * @var string
     */
    public function writeCode(string $code)
    {
        $this->code = $code;
    }

    public function commit()
    {
        $commit = $this->createCommit();
        $this->code = '';

        $this->folder->saveCommit($commit);
    }

    private function createCommit(): Commit
    {
        return new Commit($this->code);
    }

    /**
     * @param int $previous
     * @return string
     */
    public function reset(int $previous): string
    {
        return $this->code = $this->folder->getPreviousCommit($previous)->getCode();
    }
}

Git属於我们的原始类别 (Originator)，具有code状态。

getUntrackedCode()及writeCode()是我们code状态的Getter/Setter。

透过commit()方法，生成Commit，保存了当下code的状态，
并传给Folder作为纪录存档。

透过reset()方法，我们可以载入先前存档好的code状态。

• 最後让我们看客户端的程序码

<?php

namespace App\MementoPattern\Git;

use App\MementoPattern\Git\Folder;
use App\MementoPattern\Git\Git;

class Program
{
    public function run()
    {
        $folder = new Folder();
        $git = new Git($folder);

        $git->writeCode('aaa');
        dump($git->getUntrackedCode()); //aaa

        $git->commit();
        dump($git->getUntrackedCode()); //''

        $git->writeCode('bbb');
        $git->commit();

        $git->reset(1);
        dump($git->getUntrackedCode()); //aaa
    }
}

[单一职责原则]
我们将原始类别、备忘录类别与管理类别视为三种职责。

[开放封闭原则]
透过备忘录类别与管理类别，
原始类别不需要实作恢复状态的相关功能。

最後附上类别图：

（注：若不熟悉 UML 类别图，可参考UML类别图说明。）

ʕ •ᴥ•ʔ：这个范例只是利用Git作为媒介，与真实Git行为不完全相同。