契约 (Contracts)

• 简介
  • 契约 VS 门面
• 何时使用契约
  • 低耦合
  • 简单性
• 如何使用 Contracts
• Contract 参考

简介

Laravel 的契约是一组定义框架核心服务的接口。例如，Illuminate\Contracts\Queue\Queue 契约定义了队列任务所需的方法，而 Illuminate\Contracts\Mail\Mailer 契约中定义了发送电子邮件所需的方法。

框架对每个契约都提供了相应的实现。例如，Laravel 为队列提供了各种驱动的实现，为邮件提供了由 SwiftMailer 驱动的实现。

所有的 Laravel 契约都有相应的 GitHub 库。这为所有可用的契约提供了一个快速参考指南，同时也可单独作为低耦合的扩展包给其他包开发者去使用。

契约 VS 门面

门面 和一些辅助函数都提供了一种使用 Laravel 服务的简单方法，即不再需要通过类型约束和在服务容器之外解析契约。在大多数情况下，每个门面都有一个等效契约。

不像门面，门面不需要你在类构造函数中约束什么，契约则需要你在类中明显地定义依赖关系。一些开发人员喜欢契约这种方式明显地去定义它们的依赖关系，而另一些开发人员则更喜欢门面带来的便捷。

{tip} 对于大多数应用程序来说不管是使用门面还是契约都可以。但是，如果你正在构建一个扩展包，为了方便测试，你应该使用契约比较好。

何时使用契约 (contracts)

综上所述，使用契约或是门面很大程度上归结于个人或者开发团队的喜好。不管是契约还是门面都可以创建出健壮的、易测试的 Laravel 应用程序。如果你长期关注类的单一职责，你会注意到使用契约和门面其实没多少实际意义上的区别。

然而，你可能还是会有几个关于契约的问题。例如，为什么要使用接口？使用接口会不会更加复杂？下面让我们谈下使用接口的原因：低耦合和简单性。

低耦合

首先，让我们来看一些缓存实现高耦合的代码。如下:

<?php

namespace App\Orders;

class Repository
{
    /**
     * 缓存实例。
     */
    protected $cache;

    /**
     * 创建一个仓库实例。
     *
     * @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))    {
            //
        }
    }
}

在这个类中，程序跟缓存实现之间是是高耦合的。因为我们依赖于一个扩展包的特定缓存类。一旦这个扩展包的 API 被更改了，我们的代码就必须跟着改变。

同样的，如果我们想要将底层的的缓存技术（ Memcached ）替换为另一种缓存技术（ Redis ），那又得再次修改这个 repository 类。而 repository 类不应该知道这么多信息，比如关于谁提供了这些数据，或是他们是如何提供的等等。

比起上面的做法，我们可以使用一个简单、和扩展包无关的接口来改进我们的代码：

<?php

namespace App\Orders;

use Illuminate\Contracts\Cache\Repository as Cache;

class Repository
{
    /**
     * 缓存实例。
     */
    protected $cache;

    /**
     * 创建一个仓库实例。
     *
     * @param  Cache  $cache
     * @return void
     */
    public function __construct(Cache $cache)
    {
        $this->cache = $cache;
    }
}

现在，更改之后的代码没有与任何扩展包耦合，甚至是 Laravel 。而契约扩展包不包含实现和依赖，你可以轻松地写任何契约的替代实现。比如不修改任何关于缓存的代码就可以替换缓存实现。

简单性

当所有的 Laravel 服务都使用简洁的接口定义，就能够很容易决定一个服务需要提供的功能。 可以将契约视为说明框架特色的简洁文档。

除此之外，当依赖的接口足够简洁时，代码的可读性和可维护性会大大提高。比起搜索一个大型复杂的类中有哪些可用的方法，不如检索一个简单、 干净的接口来参考更妥当。

如何使用契约 (Contracts)

那么，如何获取一个契约的实现呢？这其实很简单。

Laravel 中的许多类型的类都是通过 服务容器 解析出来的，包括控制器、事件监听器、中间件、任务队列，甚至路由的闭包。所以说，要获得一个契约的实现，你只需要解析类的构造函数中对应的类型约束即可。

例如，看看这个事件监听器：

<?php

namespace App\Listeners;

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

class CacheOrderInformation
{
    /**
     * Redis 数据库实现。
     */
    protected $redis;

    /**
     * 创建事件处理器实例。
     *
     * @param  Database  $redis
     * @return void
     */
    public function __construct(Database $redis)
    {
        $this->redis = $redis;
    }

    /**
     * 处理事件。
     *
     * @param  OrderWasPlaced  $event
     * @return void
     */
    public function handle(OrderWasPlaced $event)
    {
        //
    }
}

当事件监听器被解析时，服务容器会从类的构造函数中读取到类型约束，并注入对应的值。想了解更多关于服务容器的注册，请查看 服务容器。

Contract 参考

下表提供了所有 Laravel 契约及其对应门面的快速参考

译者署名

用户名	头像	职能	签名
@iwzh		翻译	码不能停 @iwzh at Github