合约
介绍
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
{
/**
* Redis 工厂实现。
*
* @var \Illuminate\Contracts\Redis\Factory
*/
protected $redis;
/**
* 创建一个新的事件处理程序实例。
*
* @param \Illuminate\Contracts\Redis\Factory $redis
* @return void
*/
public function __construct(Factory $redis)
{
$this->redis = $redis;
}
/**
* 处理事件。
*
* @param \App\Events\OrderWasPlaced $event
* @return void
*/
public function handle(OrderWasPlaced $event)
{
//
}
}
当事件监听器被解析时,服务容器将读取类构造函数上的类型提示,并注入适当的值。要了解有关在服务容器中注册内容的更多信息,请查看其文档。
合约参考
此表提供了所有 Laravel 合约及其等效门面的快速参考: