淺析 Laravel 底層原理：契約（Contracts）

簡介

Laravel 中的契約是指框架提供的一系列定義核心服務(wù)的接口（interface）。

例如，Illuminate\Contracts\Queue\Queue 契約定義了隊列任務(wù)所需的方法，而 Illuminate\Contracts\Mail\Mailer 契約定義了發(fā)送電子郵件所需的方法。

框架對每個契約都提供了相應(yīng)的實現(xiàn)。例如，Laravel 提供了具有各種驅(qū)動的隊列實現(xiàn)和由 SwiftMailer 提供支持的郵件驅(qū)動實現(xiàn)。

所有的 Laravel 契約都有他們自己的 GitHub 庫。這為所有可用的契約提供了一個快速參考指南，同時也可單獨作為低耦合的擴展包給其他包開發(fā)者使用。

契約 VS. Facades

Laravel Facades 和輔助函數(shù)提供了一種使用 Laravel 服務(wù)的簡單方法，即不需要通過類型提示并從服務(wù)容器中解析契約。在大多數(shù)情況下，每個 Facades 都有一個等效的契約。

不同于門面不需要在構(gòu)造函數(shù)中進(jìn)行類型提示，契約允許你在類中定義顯式的依賴。一些開發(fā)者傾向于以契約這種方式明確地定義它們的依賴項，而其它開發(fā)者則更喜歡 Facades 帶來的便捷。

對于大多數(shù)應(yīng)用程序來說，不管是使用門面還是契約都可以。但是，如果你正在構(gòu)建一個擴展包，為了方便測試，你應(yīng)該強烈考慮契約。

何時使用契約

綜上所述，使用契約或是 Facades 很大程度上歸結(jié)于個人或者開發(fā)團(tuán)隊的喜好。不管是契約還是 Facades 都可以創(chuàng)建出健壯的、易測試的 Laravel 應(yīng)用程序。如果你長期關(guān)注類的單一職責(zé)，你會注意到使用契約還是 Facades 其實沒多少實際意義上的區(qū)別。

然而，你可能還是會有幾個關(guān)于契約的問題。例如，為什么要使用接口？不使用接口會比較復(fù)雜嗎？下面讓我們談下使用接口的原因：低耦合和簡單性。

低耦合

首先，讓我們來看一些高耦合緩存實現(xiàn)的代碼。如下:

namespace App\Orders;
class Repository{    /**     * 緩存實例。     */    protected $cache;
    /**     * 創(chuàng)建一個倉庫實例。     *     * @param  \SomePackage\Cache\Memcached  $cache     * @return void     */    public function __construct(\SomePackage\Cache\Memcached $cache){        $this->cache = $cache;    }
    /**     * 按照 Id 檢索訂單     *     * @param  int  $id     * @return Order     */    public function find($id){        if ($this->cache->has($id))    {            //        }    }}

在這個類中，程序與給定的緩存實現(xiàn)高耦合。因為我們依賴于一個擴展包的特定緩存類。一旦這個擴展包的 API 被更改了，我們的代碼就必須跟著改變。

同樣的，如果我們想要將底層的的緩存技術(shù)（ Memcached ）替換為另一種緩存技術(shù)（ Redis ），那又得再次修改這個 repository 類。而 repository 類不應(yīng)該了解太多關(guān)于誰提供了這些數(shù)據(jù)或是如何提供的等等。

比起上面的做法，我們可以使用一個簡單的、與擴展包無關(guān)的接口來改進(jìn)我們的代碼：

namespace App\Orders;
use Illuminate\Contracts\Cache\Repository as Cache;
class Repository{    /**     * 緩存實例。     */    protected $cache;
    /**     * 創(chuàng)建一個倉庫實例。     *     * @param  Cache  $cache     * @return void     */    public function __construct(Cache $cache){        $this->cache = $cache;    }}

現(xiàn)在，更改之后的代碼沒有與任何擴展包甚至是 Laravel 耦合。而契約擴展包不包含任何實現(xiàn)和依賴項，你可以輕松地編寫任何給定契約的替代實現(xiàn)，來實現(xiàn)不修改任何關(guān)于緩存消費的代碼就可以替換緩存實現(xiàn)。

簡單性

當(dāng)所有 Laravel 的服務(wù)都使用簡潔的接口定義，就很容易判斷給定服務(wù)提供的功能。可以將契約視為說明框架功能的簡潔文檔。

除此之外，當(dāng)依賴的接口足夠簡潔時，代碼的可讀性和可維護(hù)性會大大提高。比起搜索一個大型復(fù)雜的類中有哪些可用的方法，不如檢索一個簡單、 干凈的接口來參考更妥當(dāng)。

如何使用契約

Laravel 中的許多類型的類都是通過 服務(wù)容器 解析出來的，包括控制器、事件監(jiān)聽器、中間件、任務(wù)隊列，甚至路由閉包。所以，要獲得一個契約的實現(xiàn)，你只需要在被解析的類的構(gòu)造函數(shù)中添加「類型提示」即可。

例如，看看這個事件監(jiān)聽器：

namespace App\Listeners;
use App\User;use App\Events\OrderWasPlaced;use Illuminate\Contracts\Redis\Database;
class CacheOrderInformation{    /**     * Redis 數(shù)據(jù)庫實現(xiàn)。     */    protected $redis;
    /**     * 創(chuàng)建事件處理器實例。     *     * @param  Database  $redis     * @return void     */    public function __construct(Database $redis){        $this->redis = $redis;    }
    /**     * 處理事件。     *     * @param  OrderWasPlaced  $event     * @return void     */    public function handle(OrderWasPlaced $event){        //    }}

當(dāng)事件監(jiān)聽器被解析時，服務(wù)容器會讀取類的構(gòu)造函數(shù)上的類型提示，并注入對應(yīng)的值。