契约
简介
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 the event listener.
*/
public function __construct(
protected Factory $redis,
) {}
/**
* Handle the event.
*/
public function handle(OrderWasPlaced $event): void
{
// ...
}
}当事件监听器被解析时,服务容器将读取构造函数上的类型提示,并注入适当的值。要了解更多关于在服务容器中注册的内容,请查看其文档。
契约参考
下表提供了所有 Laravel 契约及其等效门面的快速参考: