Laravel 核心--Contracts 契約

概述

Laravel 的 Contracts 是一組定義了框架核心服務(wù)的接口( interfaces )浓体。 例如Illuminate\Contracts\Queue\Queue 契約定義了隊列任務(wù)需要實(shí)現(xiàn)的方法备恤,Illuminate\Contracts\Mail\Mailer 契約定義了發(fā)送郵件所需要實(shí)現(xiàn)的方法棍丐。

每一個契約都有框架提供的相應(yīng)實(shí)現(xiàn)频祝。例如,Laravel 為隊列提供了多個驅(qū)動的實(shí)現(xiàn)田晚,郵件則由 SwiftMailer 驅(qū)動實(shí)現(xiàn) 嘱兼。

所有 Laravel 契約都有其對應(yīng)的GitHub庫,這為所有有效的契約提供了快速入門指南贤徒,同時也可以作為獨(dú)立、解耦的包被包開發(fā)者使用汇四。當(dāng)程序變得越來大接奈,這種通過合同或者接口來解耦所帶來的可擴(kuò)展性和可維護(hù)性是無可比擬的。

使用Contracts后

上圖不使用Contracts的情況下通孽,對于一種邏輯序宦,我們只能得到一種結(jié)果(方塊),如果變更需求背苦,意味著我們必須重構(gòu)代碼和邏輯互捌。但是在使用Contracts的情況下,我們只需要按照接口寫好邏輯行剂,然后提供不同的實(shí)現(xiàn)秕噪,就可以在不改動代碼邏輯的情況下獲得更加多態(tài)的結(jié)果。

契約(Contracts) Vs. 門面(Facades)

Laravel 門面為 Laravel 服務(wù)的使用提供了便捷方式——不再需要從服務(wù)容器中類型提示 和 契約(Contracts)解析即可直接通過靜態(tài) 門面(Facade) 調(diào)用厚宰。

不同于 門面(Facade) 不需要再構(gòu)造器中進(jìn)行類型提示腌巾,契約(Contracts) 允許你在類中定義顯式的依賴。有些開發(fā)者喜歡門面(Facade)帶來的便捷铲觉,也有些開發(fā)者傾向于使用契約(Contracts)澈蝙,他們喜歡定義明確的依賴。

注:大多數(shù)應(yīng)用中撵幽,不管你使用門面還是契約灯荧,合適就好。不過盐杂,如果你是在構(gòu)建一個擴(kuò)展包逗载,那么就應(yīng)該使用契約,因?yàn)楦菀诇y試况褪。

何時使用契約

為什么要定義接口

定義接口目的為了解耦

使用接口的優(yōu)點(diǎn):松耦合和簡單撕贞。
首先,讓我們看看一些緩存實(shí)現(xiàn)的緊耦合代碼:

<?php

namespace App\Orders;

class Repository
{
    /**
     * 緩存
     */
    protected $cache;

    /**
     * 創(chuàng)建一個新的Repository實(shí)例
     *
     * @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))    {
            //
        }
    }
}

問題
在這個類中测垛,代碼和給定緩存實(shí)現(xiàn)緊密耦合捏膨,由于我們基于一個來自包的具體的緩存類,如果包的API變了,那么相應(yīng)的号涯,我們的代碼必須做修改目胡。

類似的,如果我們想要替換底層的緩存技術(shù)(Memcached)為別的技術(shù)實(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ù)不同的配置,返回不同的實(shí)現(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)化我們的代碼筑累,從而替代上述那種實(shí)現(xiàn):

<?php

namespace App\Orders;

use Illuminate\Contracts\Cache\Repository as Cache;

class Repository
{
    /**
     * 創(chuàng)建一個新的Repository實(shí)例
     *
     * @param  Cache  $cache
     * @return void
     */
    public function __construct(Cache $cache)
    {
        $this->cache = $cache;
    }
}

現(xiàn)在代碼就不與任何特定提供者耦合,甚至與 Laravel 都是無關(guān)的丝蹭。由于契約包不包含任何實(shí)現(xiàn)和依賴慢宗,你可以輕松的為給定契約編寫可選實(shí)現(xiàn)代碼,你可以隨意替換緩存實(shí)現(xiàn)而不用去修改任何緩存消費(fèi)代碼奔穿。

簡單
當(dāng)所有 Laravel 服務(wù)都統(tǒng)一在簡單接口中定義镜沽,很容易判斷給定服務(wù)提供的功能。契約可以充當(dāng)框架特性的簡明文檔贱田。

此外缅茉,基于簡單接口,代碼也更容易理解和維護(hù)湘换。在一個龐大而復(fù)雜的類中宾舅,與其追蹤哪些方法是有效的,不如轉(zhuǎn)向簡單彩倚、干凈的接口筹我。

如何使用契約

那么,如何實(shí)現(xiàn)契約呢帆离?這很簡單蔬蕊。
Laravel中很多類都是通過服務(wù)容器進(jìn)行解析,包括控制器哥谷,以及監(jiān)聽器岸夯、中間件、隊列任務(wù)们妥,甚至路由閉包猜扮。所以,要實(shí)現(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ù)庫實(shí)現(xiàn)齿桃。
     */
    protected $redis;

    /**
     * 創(chuàng)建一個新的事件處理器實(shí)例。
     *
     * @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閱讀 212,454評論 6 493
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件充易,死亡現(xiàn)場離奇詭異理卑,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)蔽氨,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,553評論 3 385
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來帆疟,“玉大人鹉究,你說我怎么就攤上這事∽俪瑁” “怎么了自赔?”我有些...
    開封第一講書人閱讀 157,921評論 0 348
  • 文/不壞的土叔 我叫張陵,是天一觀的道長柳琢。 經(jīng)常有香客問我绍妨,道長,這世上最難降的妖魔是什么柬脸? 我笑而不...
    開封第一講書人閱讀 56,648評論 1 284
  • 正文 為了忘掉前任他去,我火速辦了婚禮,結(jié)果婚禮上倒堕,老公的妹妹穿的比我還像新娘灾测。我一直安慰自己,他們只是感情好垦巴,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,770評論 6 386
  • 文/花漫 我一把揭開白布媳搪。 她就那樣靜靜地躺著,像睡著了一般骤宣。 火紅的嫁衣襯著肌膚如雪秦爆。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,950評論 1 291
  • 那天憔披,我揣著相機(jī)與錄音等限,去河邊找鬼。 笑死,一個胖子當(dāng)著我的面吹牛精刷,可吹牛的內(nèi)容都是我干的拗胜。 我是一名探鬼主播,決...
    沈念sama閱讀 39,090評論 3 410
  • 文/蒼蘭香墨 我猛地睜開眼怒允,長吁一口氣:“原來是場噩夢啊……” “哼埂软!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起纫事,我...
    開封第一講書人閱讀 37,817評論 0 268
  • 序言:老撾萬榮一對情侶失蹤勘畔,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后丽惶,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體炫七,經(jīng)...
    沈念sama閱讀 44,275評論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,592評論 2 327
  • 正文 我和宋清朗相戀三年钾唬,在試婚紗的時候發(fā)現(xiàn)自己被綠了万哪。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,724評論 1 341
  • 序言:一個原本活蹦亂跳的男人離奇死亡抡秆,死狀恐怖奕巍,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情儒士,我是刑警寧澤的止,帶...
    沈念sama閱讀 34,409評論 4 333
  • 正文 年R本政府宣布,位于F島的核電站着撩,受9級特大地震影響诅福,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜拖叙,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 40,052評論 3 316
  • 文/蒙蒙 一氓润、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧憋沿,春花似錦旺芽、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,815評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至壶辜,卻和暖如春悯舟,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背砸民。 一陣腳步聲響...
    開封第一講書人閱讀 32,043評論 1 266
  • 我被黑心中介騙來泰國打工抵怎, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留奋救,地道東北人。 一個月前我還...
    沈念sama閱讀 46,503評論 2 361
  • 正文 我出身青樓反惕,卻偏偏與公主長得像尝艘,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子姿染,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,627評論 2 350

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

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