Laravel 核心--Contracts 契約

概述

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后

上圖不使用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 Mail
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
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,533評論 6 531
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,055評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,365評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,561評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 71,346評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 54,889評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,978評論 3 439
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,118評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,637評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 40,558評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,739評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,246評論 5 355
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 43,980評論 3 346
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,362評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,619評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,347評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 47,702評論 2 370

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 134,776評論 18 139
  • 原文鏈接 必備品 文檔:Documentation API:API Reference 視頻:Laracasts ...
    layjoy閱讀 8,617評論 0 121
  • 先說幾句廢話,調(diào)和氣氛。事情的起由來自客戶需求頻繁變更,偉大的師傅決定橫刀立馬的改革使用新的框架(created ...
    wsdadan閱讀 3,067評論 0 12
  • Laravel 的核心概念包括:服務(wù)容器、服務(wù)提供者、門面(Facades)、契約(Contracts)。 服務(wù)容...
    胖福哥閱讀 2,798評論 0 24
  • 1、配置 Laravel 為不同的緩存系統(tǒng)提供了統(tǒng)一的 API。緩存配置位于 config/cache.php。在...
    layjoy閱讀 956評論 0 1