契约

简介

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

每个契约都有相应的实现，由框架提供。例如，Laravel 提供了多种驱动程序的队列实现，以及由 Symfony Mailer 提供支持的邮件发送实现。

所有的 Laravel 契约都存储在他们自己的 GitHub 存储库中。这为所有可用的契约提供了一个快速参考点，并提供了一个可以在构建与 Laravel 服务交互的包时使用的单一、解耦的包。

契约 Vs. 门面

Laravel 的门面和辅助函数提供了一种在不需要对服务容器进行类型提示和解析的情况下利用 Laravel 服务的简单方式。在大多数情况下，每个门面（Facade）都有一个对应的契约（Contract）。

与门面不同，它们不需要在类的构造函数中引用；契约允许您为类定义显式的依赖项。一些开发人员喜欢以这种方式明确地定义它们的依赖项，因此喜欢使用契约，而其他开发人员则喜欢使用门面的便利性。一般来说，在开发过程中，大多数应用程序都可以使用门面，而不会出现问题。

何时使用契约

选择使用契约还是门面，将取决于个人偏好和你的开发团队的喜好。契约和门面都可以用来创建健壮的、经过良好测试的 Laravel 应用。契约和门面并不是互斥的。你的应用的某些部分可能使用门面，而其他部分则依赖于契约。只要你保持你的类的责任焦点，你会发现在使用契约和门面之间的实际差异非常少。

总的来说，大多数应用在开发过程中都可以无问题地使用门面。如果你正在构建一个与多个 PHP 框架集成的包，你可能希望使用 illuminate/contracts 包来定义你与 Laravel 服务的集成，而无需在你的包的 composer.json 文件中要求 Laravel 的具体实现。

如何使用契约

那么，如何获取契约的实现呢？实际上非常简单。

在 Laravel 中，许多类型的类都是通过服务容器解析的，包括控制器、事件侦听器、中间件、队列作业，甚至路由闭包。因此，为了获得契约的实现，您只需在被解析的类的构造函数中“类型提示”接口即可。

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

<?php

namespace App\Listeners;

use App\Events\OrderWasPlaced;
use App\Models\User;
use Illuminate\Contracts\Redis\Factory;

class CacheOrderInformation
{
    /**
     * 创建一个新的事件处理程序实例。
     */
    public function __construct(protected Factory $redis) {}

    /**
     * 处理事件。
     */
    public function handle(OrderWasPlaced $event): void
    {
        // ...
    }
}

当事件监听器被解析时，服务容器将读取类的构造函数上的类型提示，并注入适当的值。要了解有关在服务容器中注册事物的更多信息，请查看其文档。

契约参考

以下表格提供了 Laravel 所有契约及其等效门面的快速参考：