Contracts
Laravel 的 Contracts 是一组定义了框架核心服务的接口。例如, contract 定义了队列任务所需要的方法,而 contract 定义了寄送 e-mail 需要的方法。
框架对于每个 contract 都有提供对应的实现,例如,Laravel 提供各种驱动程序的队列实现,以及由 提供的 mailer 实现。
Laravel 所有的 contracts 放在一个单独的 GitHub 代码库。除了提供给所有可用的 contracts 一个快速的参考,也可以单独作为一个低耦合的扩展包来让其他扩展包开发者使用。
Laravel 的 facades 提供一个简单的方法来使用服务,而不需要使用类型约束和在服务容器之外解析 contracts。大多数情况下,每个 facade 都有一个相应的 contract。
不像 facades 那样,contracts 需要你为你的类显示的定义依赖关系。有些开发者喜欢这种显示的依赖定义,所以他们喜欢使用 contracts,而其他开发者更喜欢方便的 facades。
正如我们所说,到底是选择 facade 还是 contracts 取决于你或你的团队的喜好。不管是 facade 还是 contracts,都可以创建出健壮的,易测试的应用。随着你长期关注于类的功能层面,你会发现其实 facades 和 contracts 之间并没有太大的区别。
首先,让我们来查看这一段和缓存功能有高耦合的代码,如下:
在此类中,程序和缓存实现之间是高耦合。因为它是依赖于扩展包的特定缓存类。一旦这个扩展包的 API 更改了,我们的代码也要跟着改变。
同样的,如果想要将底层的缓存实现(比如 Memcached )切换成另一种(像 Redis ),又一次的我们必须修改这个 类。我们的 类不应该知道这么多关于谁提供了数据,或是如何提供等细节。
比起上面的做法,我们可以使用一个简单、和扩展包无关的接口来改进代码:
现在上面的代码没有跟任何扩展包耦合,甚至是 Laravel。既然 contracts 扩展包没有包含实现和任何依赖,你就可以很简单的对任何 contract 进行实现,你可以很简单的写一个替换的实现,甚至是替换 contracts,让你可以替换缓存实现而不用修改任何用到缓存的代码。
当所有的 Laravel 服务都使用简洁的接口定义,就能够很容易决定一个服务需要提供的功能。 可以将 contracts 视为说明框架特色的简洁文档。
除此之外,当依赖的接口足够简洁时,代码的可读性和可维护性大大提高。比起搜索一个大型复杂的类里有哪些可用的方法,你有一个简单,干净的接口可以参考。
那么,如何获取一个 contract 的实现呢?其实真的非常简单。
Laravel 里很多类型的类都是通过服务容器解析出来的。包括控制器,事件监听器,中间件,任务队列,甚至是路由的闭包。所以说,想要获得一个 contract 的实现,你只需要在类的构造函数里添加相应的类型约束就好了。
举个例子,看一下这个事件监听器:
当事件监听器被解析时,服务容器会从构造函数里读取到类型约束,并且注入合适的类。想了解如何注册绑定到容器,请参考。
下面的表格提供了 Laravel contracts 及其对应的 facades 的参考:
用户名 | 头像 | 职能 | 签名 |
---|---|---|---|
翻译 | 专注于 PHP 和 Laravel |
{note} 欢迎任何形式的转载,但请务必注明出处,尊重他人劳动共创开源社区。
转载请注明:本文档由 Laravel China 社区 [laravel-china.org] 组织翻译,详见 翻译召集帖。
文档永久地址: