Contracts
合约(Contracts)
介绍
Laravel 的“合约”是一组接口,用来定义框架提供的核心服务。例如,Illuminate\Contracts\Queue\Queue
合约定义了队列任务所需的方法,而 Illuminate\Contracts\Mail\Mailer
合约定义了发送邮件所需的方法。
每个合约都有对应的框架实现。例如,Laravel 提供了带有多种驱动的队列实现,以及基于 Symfony Mailer 的邮件发送实现。
所有 Laravel 合约都托管在 它们自己的 GitHub 仓库 中。这提供了一个快速查阅所有可用合约的入口,同时也是一个独立解耦的包,可用于构建与 Laravel 服务交互的包。
合约与门面
Laravel 的 门面 和辅助函数提供了一种简单的方式来使用 Laravel 服务,无需在服务容器中类型提示并解析合约。在大多数情况下,每个门面都有一个对应的合约。
与不需要在类构造函数中显式依赖注入的门面不同,合约允许你为类定义明确的依赖关系。一些开发者喜欢通过这种方式显式定义依赖,因此更喜欢使用合约,而另一些开发者则享受门面的便利。通常来说,大多数应用在开发时使用门面不会有问题。
何时使用合约
选择使用合约还是门面(facades)主要取决于你个人以及团队的偏好。合约和门面都可以用来构建健壮且经过良好测试的 Laravel 应用程序。合约和门面并不是互斥的。你的应用中部分地方可以使用门面,而其他地方可以依赖合约。只要你保持类的职责单一,实际上使用合约和门面之间几乎没有什么实际差别。
一般来说,大多数应用在开发过程中直接使用门面不会有问题。如果你正在构建一个需要集成多个 PHP 框架的包,可能希望使用 illuminate/contracts
包来定义与 Laravel 服务的集成,而无需在你的包的 composer.json
文件中强制依赖 Laravel 的具体实现
如何使用合约
那么,如何获取合约的实现呢?其实非常简单。
Laravel 中的许多类型的类都会通过服务容器进行解析,包括控制器、事件监听器、中间件、队列任务,甚至路由闭包。因此,要获取合约的实现,只需在被解析类的构造函数中对接口进行“类型提示(type-hint)”。
例如,看看下面这个事件监听器:
<?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 所有合约及其对应门面的快速参考:
本译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。