既然已經決定要以 Simple Cache (簡易快取機制) 來做為這次的實戰題目，原則上在 PHP 社群中有建議的規範就按照規範走，沒有就自由發揮。剛好 PSR-16 建議規範的對象就是為快取套件定義出統一的介面。

PSR-16 快取介面

CacheInterface

CacheInterface 介面一共有六個公開方法。（為了節省版面已將註解移除唷！）

<?php

namespace Psr\SimpleCache;

interface CacheInterface
{
    public function set($key, $value, $ttl = null);
    public function delete($key);
    public function clear();
    public function getMultiple($keys, $default = null);
    public function setMultiple($values, $ttl = null);
    public function deleteMultiple($keys);
    public function has($key);
}

方法 (Methods)

介面中各方法的說明如下：

參數 (Arguments)

介面中各方法的參數說明如下：

異常處理介面

PSR-16 定義兩個異常處理介面。

CacheException

<?php

namespace Psr\SimpleCache;

interface CacheException
{
}

一般情況下關於快取機制產生錯誤的情況，丟出此異常錯誤。

InvalidArgumentException

<?php

namespace Psr\SimpleCache;

interface InvalidArgumentException extends CacheException
{
}

參數有錯誤的情況，丟出此異常錯誤。

目錄結構規劃

先初步規劃出此專案作品的目錄結構，不過最後的完成品有可能會再修改唷！

.
├── README.md
├── composer.json
├── composer.lock
├── vendor
├── src
│   └── SimpleCache
│       ├── Cache.php
│       ├── CacheProvider.php
│       ├── Driver
│       │   ├── File.php
│       │   ├── Mysql.php
│       │   ├── Redis.php
│       │   └── Sqlite.php
│       └── Exception
│           ├── CacheArgumentException.php
│           └── CacheException.php
└── tests
    └── SimpleCache
        ├── CacheTest.php
        └── CacheTestCase.php

結構說明

PSR-16 的兩個異常處理介面，會放在 src/SimpleCache/Exception 這個目錄。而 CacheInterface 會先實作在 CacheProvider.php 中。

各個不同類型的資料存取媒介，放在 src/SimpleCache/Driver 目錄中。

介面實作

CacheInterface

CacheInterface 介面實作於 CacheProvider 抽像類別中。這個抽像類別將實作一般情況下處理 Cache 資料的邏輯。

範例：/day-16/src/SimpleCache/CacheProvider.php

<?php

declare(strict_types=1);

namespace Shieldon\SimpleCache;

use Psr\SimpleCache\CacheInterface;

abstract class CacheProvider implements CacheInterface
{
    public function get($key, $default = null)
    {

    }

    public function set($key, $value, $ttl = null)
    {

    }

    public function delete($key)
    {

    }

    public function clear()
    {

    }

    public function has($key)
    {
        
    }

    public function getMultiple($keys, $default = null)
    {
        
    }

    public function setMultiple($values, $ttl = null)
    {

    }

    public function deleteMultiple($keys)
    {

    }
}

InvalidArgumentException

範例：/day-16/src/SimpleCache/Exception/CacheArgumentException.php

<?php

declare(strict_types=1);

namespace Shieldon\SimpleCache\Exception;

use Psr\SimpleCache\InvalidArgumentException as InvalidArgumentExceptionInterface;
use InvalidArgumentException;

class CacheArgumentException extends InvalidArgumentException implements InvalidArgumentExceptionInterface
{

}

CacheArgumentException 這個類別繼承了 InvalidArgumentException 並實作了 Psr\SimpleCache\InvalidArgumentException 介面。

CacheException

範例：/day-16/src/SimpleCache/Exception/CacheException.php

<?php

declare(strict_types=1);

namespace Shieldon\SimpleCache\Exception;

use Psr\SimpleCache\CacheException as CacheExceptionInterface;
use Exception;

class CacheException extends Exception implements CacheExceptionInterface
{

}

CacheException 這個類別繼承了 Exception 並實作了 Psr\SimpleCache\CacheException 介面。因為撞名了會有錯誤，所以用 as 關鍵字換成別名。

或許讀者們會疑惑，為什麼要實作兩個介面但內容是卻是空的類別。

雖然目前還不需要改寫繼承的類別中方法或屬性，這是為了讓其它依賴的類別在往後這兩個異常處理類別需要改寫繼承類別的方法或屬性的時候，能一致性地套用到其它依賴的類別中。

總結

今天的進度是先把介面實作出來，把檔案架構定出來，就像建築工地要蓋房子前要先搭好鷹架，一層一層往上蓋。一個空殼出來了，接下來後幾天就是把它做出來。

本篇原始碼可在此瀏覽。我們明天見囉。

本文同步更新於 TerryL 部落格 Day 16 - PHP 套件設計實戰 (2) 介面及目錄結構，歡迎前往討論。