契约

• 简介
  • 契约 vs. 外观模式
• 何时使用契约
• 如何使用契约
• 契约参考

简介

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

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

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

契约 vs. 外观模式

Laravel 的外观模式和助手函数提供了一种简单的方法来利用 Laravel 的服务，而无需在服务容器中输入提示和解析契约。在大多数情况下，每个外观都有一个等效的契约。

与不需要您在其类的构造函数中要求它们的外观模式不同，契约允许您为类定义显式依赖项。一些开发人员喜欢以这种方式显式定义他们的依赖项，因此更喜欢使用契约，而其他开发人员则喜欢外观模式的便利性。一般来说，大多数应用程序可以在开发过程中毫无问题地使用外观模式。

何时使用契约

使用契约还是外观模式的决定将取决于个人品味和您的开发团队的品味。契约和外观模式都可以用来创建健壮、经过良好测试的 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
{
    /**
     * Create a new event handler instance.
     */
    public function __construct(
        protected Factory $redis,
    ) {}
 
    /**
     * Handle the event.
     */
    public function handle(OrderWasPlaced $event): void
    {
        // ...
    }
}

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

契约参考

下表提供了所有 Laravel 契约及其等效外观模式的快速参考