laravel 基础教程 —— 契约

契约

简介

laravel 的契约是对应用框架的核心服务所要求的一种强有力的约束。它本身定义一些接口,要求服务必须要遵守。比如,Illuminate\Contracts\Queue\Queue 契约定义了队列任务所必须的方法,而 Illuminate\Contracts\Mail\Mailer 契约定义了一些发送邮件所必须的方法。

每种契约在框架中都有相应的提供者去进行实现。比如,laravel 提供了多种驱动的队列任务的实现,还有其中一个的邮件服务的实现是由 SwiftMailer 集成的。

所有的 laravel 契约你都可以在这里找到:GitHub。这里提供了一个对 laravel 契约参考的快速入口,你可以很好的对这些单一解耦的包进行独立实现的开发。

契约 Vs. 假面(Facades)

laravel 的假面模式提供了一种简单的方法去从服务容器中取出服务而不需要使用类型提示。使用契约可以使你明确的定义类间的依赖。而对于大多数应用来说,使用假面模式就可以了。但是,如果你想要松耦合易扩展的服务,那么契约可以实现。

为什么使用契约?

对于契约,你可能会产生很多的疑问。为什么要总是使用接口?使用接口不是会变的更复杂吗?让我们来提炼一下使用接口的原因:松耦合和简洁性。

松耦合

首先,让我们来看一下一个紧耦合的关于缓存的实现,请阅读下面的代码好好思考一下:

<?php

namespace App\Orders;

class Repository
{
  /**
   * The cache instance.
   */
   protected $cache;

   /**
    * Create a new repository instance.
    *
    * @param \SomePackage\Cache\Memcached $cache
    * @return void
    */
    public function __construct(\SomePackage\Cache\Memcatched $cache)
    {
      $this->cache = $cache;
    }

    /**
     * Retrieve an Order by ID.
     *
     * @param int $id
     * @return Order
     */
     public function find($id)
     {
       if ($this->cache->has($id)) {
          //
       }
     }
}

在上面的类中,代码给予了类一个紧耦合的缓存的实现。之所以说是紧耦合的,是因为它依赖于一个具体的实现类,也就是说它和这个包的供应商是紧密耦合的。如果我们需要换一个包的供应商,那么我们就要修改我们的代码。

同样的,如果我们想要切换我们的底层缓存驱动,从 memcached 切换到 redis,那么我们也必须要修改大量的业务代码。所以,鉴于此,我们的资料库不应该对所提供的依赖需要知道的太多,而仅仅需要知道他们提供了我们所需的就可以了(这和鸭子类型的故事有点相似)。

鉴于此,我们可以采取一种与上述相反的方法来进行解耦。我们提供一个无关具体实现的接口:

<?php

namespace App\Orders;

use Illuminate\Contracts\Cache\Repository as Cache;

class Respository
{
  /**
   * The cache instance.
   */
   protected $cache;

   /**
    * Create a new repository instance.
    *
    * @param Cache $cache
    * @return void
    */
    public function __construct(Cache $cache)
    {
      $this->cache = $cache;
    }
}

现在上面的代码并没有连接到任何的具体实现库,甚至是 laravel。因为契约只定义了接口,它并不包含任何的依赖和实现,所以你可以非常简单的去实现任何给定的契约,你只需要根据契约编写一个不同的实现就可以进行轻松的替换。而并不用修改之前写过的代码。

简单

当所有的 laravel 的服务都通过简单整洁的接口进行定义,那么它就可以被非常轻松的确定所给定服务具有哪些功能。这样也可以说 laravel 的契约服务其实是已经提供了简洁的功能文档了。

契约参考

下面是 laravel 契约及其对应的假面的参考:

Contract References 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

怎么使用契约

那么,如何得到一个契约的实现呢?其实这相当的简单。

在 laravel 中很多类型的类都是通过服务容器来获取的,包括控制器,事件监听器,中间件,队列任务,和路由闭包。所以,你可以直接通过在构造函数中使用类型提示来构造接口依赖,这样在类被解析时会自动的获取契约的实例,我们通过一个简单的例子来看一下:

<?php

namespace App\Listeners;

use App\User;
use App\Events\NewUserRegistered;
use Illuminate\Contracts\Redis\Database;

class CacheUserInformation
{
  /**
   * The Redis database implementation.
   */
   protected $redis;

   /**
    * Create a new event handler instance.
    *
    * @param Database $redis
    @ @return void
    */
    public function __construct(Database $redis)
    {
      $this->redis = $redis;
    }

    /**
     * Handle the event.
     *
     * @param NewUserRegistered $event
     * @return void
     */
     public function handle(NewUserRegistered $event)
     {
        //
     }
}

一旦事件监听器被解析,服务容器就会读构造函数中的类型提示,然后根据类型提示去注入适当的实例。关于更多的在服务容器中进行类的绑定注册,你可以查看服务容器的文档。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,902评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,037评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,978评论 0 332
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,867评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,763评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,104评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,565评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,236评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,379评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,313评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,363评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,034评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,637评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,719评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,952评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,371评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,948评论 2 341

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,566评论 18 139
  • 简介 laravel 使实施认证的变得非常简单,事实上,它提供了非常全面的配置项以适应应用的业务。认证的配置文件存...
    Dearmadman阅读 6,100评论 2 13
  • 原文链接 必备品 文档:Documentation API:API Reference 视频:Laracasts ...
    layjoy阅读 8,597评论 0 121
  • 概述 Laravel 的 Contracts 是一组定义了框架核心服务的接口( interfaces )。 例如I...
    伊Summer阅读 2,774评论 0 2
  • 缓存 配置 Laravel 对多种缓存系统提供了统一的 API。缓存的配置文件存放在 config/cache.p...
    Dearmadman阅读 11,959评论 0 8