合同
介绍
Laravel 的“合同”是一组接口,定义了框架提供的核心服务。例如,Illuminate\Contracts\Queue\Queue
合同定义了队列作业所需的方法,而 Illuminate\Contracts\Mail\Mailer
合同定义了发送电子邮件所需的方法。
每个合同都有一个由框架提供的相应实现。例如,Laravel 提供了一个具有多种驱动程序的队列实现,以及一个由 Symfony Mailer 提供支持的邮件发送实现。
所有 Laravel 合同都位于 自己的 GitHub 存储库 中。这为所有可用合同提供了一个快速参考点,以及一个可以在构建与 Laravel 服务交互的包时使用的单一、解耦的包。
合同与外观
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
{
/**
* 创建一个新的事件处理程序实例。
*/
public function __construct(
protected Factory $redis,
) {}
/**
* 处理事件。
*/
public function handle(OrderWasPlaced $event): void
{
// ...
}
}
当事件监听器被解析时,服务容器将读取类构造函数上的类型提示,并注入适当的值。要了解有关在服务容器中注册内容的更多信息,请查看 其文档。
合同参考
此表提供了所有 Laravel 合同及其等效外观的快速参考: