概述
Laravel 的 Contracts
是一組定義了框架核心服務(wù)的接口( interfaces )。 例如Illuminate\Contracts\Queue\Queue
契約定義了隊列任務(wù)需要實現(xiàn)的方法,Illuminate\Contracts\Mail\Mailer
契約定義了發(fā)送郵件所需要實現(xiàn)的方法。
每一個契約都有框架提供的相應(yīng)實現(xiàn)。例如,Laravel 為隊列提供了多個驅(qū)動的實現(xiàn),郵件則由 SwiftMailer 驅(qū)動實現(xiàn) 。
所有 Laravel 契約都有其對應(yīng)的GitHub庫,這為所有有效的契約提供了快速入門指南,同時也可以作為獨立、解耦的包被包開發(fā)者使用。當(dāng)程序變得越來大,這種通過合同或者接口來解耦所帶來的可擴展性和可維護性是無可比擬的。
上圖不使用Contracts的情況下,對于一種邏輯,我們只能得到一種結(jié)果(方塊),如果變更需求,意味著我們必須重構(gòu)代碼和邏輯。但是在使用Contracts的情況下,我們只需要按照接口寫好邏輯,然后提供不同的實現(xiàn),就可以在不改動代碼邏輯的情況下獲得更加多態(tài)的結(jié)果。
契約(Contracts) Vs. 門面(Facades)
Laravel 門面為 Laravel 服務(wù)的使用提供了便捷方式——不再需要從服務(wù)容器中類型提示 和 契約(Contracts)解析即可直接通過靜態(tài) 門面(Facade) 調(diào)用。
不同于 門面(Facade) 不需要再構(gòu)造器中進行類型提示,契約(Contracts) 允許你在類中定義顯式的依賴。有些開發(fā)者喜歡門面(Facade)帶來的便捷,也有些開發(fā)者傾向于使用契約(Contracts),他們喜歡定義明確的依賴。
注:大多數(shù)應(yīng)用中,不管你使用門面還是契約,合適就好。不過,如果你是在構(gòu)建一個擴展包,那么就應(yīng)該使用契約,因為更容易測試。
何時使用契約
為什么要定義接口
定義接口目的為了解耦
使用接口的優(yōu)點:松耦合和簡單。
首先,讓我們看看一些緩存實現(xiàn)的緊耦合代碼:
<?php
namespace App\Orders;
class Repository
{
/**
* 緩存
*/
protected $cache;
/**
* 創(chuàng)建一個新的Repository實例
*
* @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變了,那么相應(yīng)的,我們的代碼必須做修改。
類似的,如果我們想要替換底層的緩存技術(shù)(Memcached)為別的技術(shù)實現(xiàn)(Redis),我們將再一次不得不修改我們的代碼庫。我們的代碼庫應(yīng)該并不知道誰提供的數(shù)據(jù)或者數(shù)據(jù)是怎么提供的。
我們可以創(chuàng)建一個簡單的、與提供者無關(guān)的接口:
namespace App\Contracts;
use Closure;
interface Repository
{
public function setTag($tag);
public function setTime($time_in_minute);
public function remember($key, Closure $entity, $tag = null);
public function forget($key, $tag = null);
public function clearCache($tag = null);
public function clearAllCache();
}
然后再利用容器的綁定,根據(jù)不同的配置,返回不同的實現(xiàn):
public function register()
{
$this->app->bind('Repository', function ($app) {
if (config('cache.enable') == 'true') {
return new Memcached();
} else {
return new Redis();
}
});
}
我們可以基于一種簡單的、與提供者無關(guān)的接口來優(yōu)化我們的代碼,從而替代上述那種實現(xiàn):
<?php
namespace App\Orders;
use Illuminate\Contracts\Cache\Repository as Cache;
class Repository
{
/**
* 創(chuàng)建一個新的Repository實例
*
* @param Cache $cache
* @return void
*/
public function __construct(Cache $cache)
{
$this->cache = $cache;
}
}
現(xiàn)在代碼就不與任何特定提供者耦合,甚至與 Laravel 都是無關(guān)的。由于契約包不包含任何實現(xiàn)和依賴,你可以輕松的為給定契約編寫可選實現(xiàn)代碼,你可以隨意替換緩存實現(xiàn)而不用去修改任何緩存消費代碼。
簡單
當(dāng)所有 Laravel 服務(wù)都統(tǒng)一在簡單接口中定義,很容易判斷給定服務(wù)提供的功能。契約可以充當(dāng)框架特性的簡明文檔。
此外,基于簡單接口,代碼也更容易理解和維護。在一個龐大而復(fù)雜的類中,與其追蹤哪些方法是有效的,不如轉(zhuǎn)向簡單、干凈的接口。
如何使用契約
那么,如何實現(xiàn)契約呢?這很簡單。
Laravel中很多類都是通過服務(wù)容器進行解析,包括控制器,以及監(jiān)聽器、中間件、隊列任務(wù),甚至路由閉包。所以,要實現(xiàn)一個契約,需要在解析類的構(gòu)造函數(shù)中類型提示這個契約接口。
<?php
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)
{
//
}
}
事件監(jiān)聽器被解析的時候,服務(wù)容器會讀取構(gòu)造函數(shù)中的類型提示,并注入適當(dāng)?shù)闹怠?/p>
契約列表
下面是 Laravel 契約列表,以及其對應(yīng)的“門面”:
契約(Contract) | 門面(Facade) |
---|---|
Illuminate\Contracts\Auth\Factory | Auth |
Illuminate\Contracts\Auth\PasswordBroker | Password |
Illuminate\Contracts\Bus\Dispatcher | Bus |
Illuminate\Contracts\Broadcasting\Broadcaster | |
Illuminate\Contracts\Cache\Repository | Cache |
Illuminate\Contracts\Cache\Factory | Cache::driver() |
Illuminate\Contracts\Config\Repository | Config |
Illuminate\Contracts\Container\Container | App |
Illuminate\Contracts\Cookie\Factory | Cookie |
Illuminate\Contracts\Cookie\QueueingFactory | Cookie::queue() |
Illuminate\Contracts\Encryption\Encrypter | Crypt |
Illuminate\Contracts\Events\Dispatcher | Event |
Illuminate\Contracts\Filesystem\Cloud | |
Illuminate\Contracts\Filesystem\Factory | File |
Illuminate\Contracts\Filesystem\Filesystem | File |
Illuminate\Contracts\Foundation\Application | App |
Illuminate\Contracts\Hashing\Hasher | Hash |
Illuminate\Contracts\Logging\Log | Log |
Illuminate\Contracts\Mail\MailQueue | Mail::queue() |
Illuminate\Contracts\Mail\Mailer | |
Illuminate\Contracts\Queue\Factory | Queue::driver() |
Illuminate\Contracts\Queue\Queue | Queue |
Illuminate\Contracts\Redis\Database | Redis |
Illuminate\Contracts\Routing\Registrar | Route |
Illuminate\Contracts\Routing\ResponseFactory | Response |
Illuminate\Contracts\Routing\UrlGenerator | URL |
Illuminate\Contracts\Support\Arrayable | |
Illuminate\Contracts\Support\Jsonable | |
Illuminate\Contracts\Support\Renderable | |
Illuminate\Contracts\Validation\Factory | Validator::make() |
Illuminate\Contracts\Validation\Validator | |
Illuminate\Contracts\View\Factory | View::make() |
Illuminate\Contracts\View\View |