Day36. 范例：快取代理（代理模式）

本文同步更新於blog

情境：以下是某搜寻功能

客户端程序码

<?php

namespace App\ProxyPattern\Cache;

use App\ProxyPattern\Cache\Database;

class Program
{
    /**
     * @var Database
     */
    protected $database;

    public function __construct()
    {
        $this->database = new Database();
    }

    /**
     * @param string $keyword
     * @return array
     */
    public function search(string $keyword): array
    {
        return $this->database->read($keyword);
    }
}

实体资料库（供存取资料用）

<?php

namespace App\ProxyPattern\Cache;

class Database
{
    /**
     * @param string $keyword
     * @return array
     */
    public function read(string $keyword): array
    {
        if ($keyword == 'sushi') {
            return ['Bear Sushi', 'Lin Sushi', 'Alysa Sushi'];
        }

        return [];
    }
}

老板希望搜寻时，若是已搜寻过的资料，
便由快取返回，不再呼叫实体资料库。

让我们用代理模式改造它。

需求一：实现快取代理

首先定义读取介面

<?php

namespace App\ProxyPattern\Cache\Contracts;

interface Readable
{
    /**
     * @param string $keyword
     * @return array
     */
    public function read(string $keyword): array;
}

实体资料库实现读取介面

<?php

namespace App\ProxyPattern\Cache;

use App\ProxyPattern\Cache\Contracts\Readable;

class Database implements Readable
{
    /**
     * @param string $keyword
     * @return array
     */
    public function read(string $keyword): array
    {
        if ($keyword == 'sushi') {
            return ['Bear Sushi', 'Lin Sushi', 'Alysa Sushi'];
        }

        return [];
    }
}

实作快取代理

<?php

namespace App\ProxyPattern\Cache;

use App\ProxyPattern\Cache\Contracts\Readable;

class CacheProxy implements Readable
{
    /**
     * @var array
     */
    protected $cached = [];

    /**
     * @var Database
     */
    protected $database;

    public function __construct()
    {
        $this->database = new Database();
    }

    /**
     * @param string $keyword
     * @return array
     */
    public function read(string $keyword): array
    {
        if (isset($this->cached[$keyword])) {
            return $this->cached[$keyword];
        }

        $result = $this->database->read($keyword);
        $this->cached[$keyword] = $result;

        return $result;
    }
}

修改客户端程序码

<?php

namespace App\ProxyPattern\Cache;

use App\ProxyPattern\Cache\CacheProxy;

class Program
{
    /**
     * @var CacheProxy
     */
    protected $proxy;

    public function __construct()
    {
        $this->proxy = new CacheProxy();
    }

    /**
     * @param string $keyword
     * @return array
     */
    public function search(string $keyword): array
    {
        return $this->proxy->read($keyword);
    }
}

这下子客户端搜寻时，若快取代理有资料，便会直接返回结果。

[单一职责原则]
我们将实体类别与代理类别视作两种不同的职责。
代理类别主要处理访问实体类别的行为。

[开放封闭原则]
当我们需要实现不属於实体类别的职责时（例如：关键字被搜寻次数），
我们可以在代理类别中实现，不须修改实体类别的程序码。

若有需要其他控制访问的职责时，也可以新增代理类别。

除了上述的提出介面的委派方法外，
也有人用继承的手法修改行为，但我个人比较不喜欢。

最後附上类别图：

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