Contracts

简介

Laravel 的 Contracts 是一组定义了框架核心服务的接口。例如,Illuminate\Contracts\Queue\Queue contract 定义了队列任务所需要的方法,而 Illuminate\Contracts\Mail\Mailer contract 定义了寄送 e-mail 需要的方法。

框架对于每个 contract 都有提供对应的实现,例如,Laravel 提供各种驱动程序的队列实现,以及由 SwiftMailer 提供的 mailer 实现。

Laravel 所有的 contracts 放在一个单独的 GitHub 代码库。除了提供给所有可用的 contracts 一个快速的参考,也可以单独作为一个低耦合的扩展包来让其他扩展包开发者使用。

Contracts Vs. Facades

Laravel 的 facades 提供一个简单的方法来使用服务,而不需要使用类型约束和在服务容器之外解析 contracts。大多数情况下,每个 facade 都有一个相应的 contract。

不像 facades 那样,contracts 需要你为你的类显示的定义依赖关系。有些开发者喜欢这种显示的依赖定义,所以他们喜欢使用 contracts,而其他开发者更喜欢方便的 facades。

{tip} 大多数应用不管你是使用 facades 还是 contracts 都可以很好的工作,但是如果你打算构建扩展包的话,强烈建议使用 contracts,因为它们在扩展包的环境下更容易被测试。

何时使用 Contracts

正如我们所说,到底是选择 facade 还是 contracts 取决于你或你的团队的喜好。不管是 facade 还是 contracts,都可以创建出健壮的,易测试的应用。随着你长期关注于类的功能层面,你会发现其实 facades 和 contracts 之间并没有太大的区别。

你可能有很多关于 contracts 的问题。像是为什么要使用接口?使用接口会不会变的更复杂?让我们来提炼一下这样做的原因:低耦合和简单性。

低耦合

首先,让我们来查看这一段和缓存功能有高耦合的代码,如下:

  1. <?php
  2. namespace App\Orders;
  3. class Repository
  4. {
  5. /**
  6. * 缓存实例。
  7. */
  8. protected $cache;
  9. /**
  10. * 创建一个新的仓库实例。
  11. *
  12. * @param \SomePackage\Cache\Memcached $cache
  13. * @return void
  14. */
  15. public function __construct(\SomePackage\Cache\Memcached $cache)
  16. {
  17. $this->cache = $cache;
  18. }
  19. /**
  20. * 借由 ID 获取订单信息。
  21. *
  22. * @param int $id
  23. * @return Order
  24. */
  25. public function find($id)
  26. {
  27. if ($this->cache->has($id)) {
  28. //
  29. }
  30. }
  31. }

在此类中,程序和缓存实现之间是高耦合。因为它是依赖于扩展包的特定缓存类。一旦这个扩展包的 API 更改了,我们的代码也要跟着改变。

同样的,如果想要将底层的缓存实现(比如 Memcached )切换成另一种(像 Redis ),又一次的我们必须修改这个 Repository 类。我们的 Repository 类不应该知道这么多关于谁提供了数据,或是如何提供等细节。

比起上面的做法,我们可以使用一个简单、和扩展包无关的接口来改进代码:

  1. <?php
  2. namespace App\Orders;
  3. use Illuminate\Contracts\Cache\Repository as Cache;
  4. class Repository
  5. {
  6. /**
  7. * 缓存实例。
  8. */
  9. protected $cache;
  10. /**
  11. * 创建一个新的仓库实例。
  12. *
  13. * @param Cache $cache
  14. * @return void
  15. */
  16. public function __construct(Cache $cache)
  17. {
  18. $this->cache = $cache;
  19. }
  20. }

现在上面的代码没有跟任何扩展包耦合,甚至是 Laravel。既然 contracts 扩展包没有包含实现和任何依赖,你就可以很简单的对任何 contract 进行实现,你可以很简单的写一个替换的实现,甚至是替换 contracts,让你可以替换缓存实现而不用修改任何用到缓存的代码。

简单性

当所有的 Laravel 服务都使用简洁的接口定义,就能够很容易决定一个服务需要提供的功能。 可以将 contracts 视为说明框架特色的简洁文档。

除此之外,当依赖的接口足够简洁时,代码的可读性和可维护性大大提高。比起搜索一个大型复杂的类里有哪些可用的方法,你有一个简单,干净的接口可以参考。

如何使用 Contracts

那么,如何获取一个 contract 的实现呢?其实真的非常简单。

Laravel 里很多类型的类都是通过服务容器解析出来的。包括控制器,事件监听器,中间件,任务队列,甚至是路由的闭包。所以说,想要获得一个 contract 的实现,你只需要在类的构造函数里添加相应的类型约束就好了。

举个例子,看一下这个事件监听器:

  1. <?php
  2. namespace App\Listeners;
  3. use App\User;
  4. use App\Events\OrderWasPlaced;
  5. use Illuminate\Contracts\Redis\Database;
  6. class CacheOrderInformation
  7. {
  8. /**
  9. * Redis 数据库实现。
  10. */
  11. protected $redis;
  12. /**
  13. * 创建事件处理器实例。
  14. *
  15. * @param Database $redis
  16. * @return void
  17. */
  18. public function __construct(Database $redis)
  19. {
  20. $this->redis = $redis;
  21. }
  22. /**
  23. * 处理事件。
  24. *
  25. * @param OrderWasPlaced $event
  26. * @return void
  27. */
  28. public function handle(OrderWasPlaced $event)
  29. {
  30. //
  31. }
  32. }

当事件监听器被解析时,服务容器会从构造函数里读取到类型约束,并且注入合适的类。想了解如何注册绑定到容器,请参考这篇文档

Contract 参考

下面的表格提供了 Laravel contracts 及其对应的 facades 的参考:

Contract References Facade
Illuminate\Contracts\Auth\Factory Auth
Illuminate\Contracts\Auth\PasswordBroker Password
Illuminate\Contracts\Bus\Dispatcher Bus
Illuminate\Contracts\Broadcasting\Broadcaster  
Illuminate\Contracts\Cache\Repository Cache
Illuminate\Contracts\Cache\Factory Cache::driver()
Illuminate\Contracts\Config\Repository Config
Illuminate\Contracts\Container\Container App
Illuminate\Contracts\Cookie\Factory Cookie
Illuminate\Contracts\Cookie\QueueingFactory Cookie::queue()
Illuminate\Contracts\Encryption\Encrypter Crypt
Illuminate\Contracts\Events\Dispatcher Event
Illuminate\Contracts\Filesystem\Cloud  
Illuminate\Contracts\Filesystem\Factory File
Illuminate\Contracts\Filesystem\Filesystem File
Illuminate\Contracts\Foundation\Application App
Illuminate\Contracts\Hashing\Hasher Hash
Illuminate\Contracts\Logging\Log Log
Illuminate\Contracts\Mail\MailQueue Mail::queue()
Illuminate\Contracts\Mail\Mailer Mail
Illuminate\Contracts\Queue\Factory Queue::driver()
Illuminate\Contracts\Queue\Queue Queue
Illuminate\Contracts\Redis\Database Redis
Illuminate\Contracts\Routing\Registrar Route
Illuminate\Contracts\Routing\ResponseFactory Response
Illuminate\Contracts\Routing\UrlGenerator URL
Illuminate\Contracts\Support\Arrayable  
Illuminate\Contracts\Support\Jsonable  
Illuminate\Contracts\Support\Renderable  
Illuminate\Contracts\Validation\Factory Validator::make()
Illuminate\Contracts\Validation\Validator  
Illuminate\Contracts\View\Factory View::make()
Illuminate\Contracts\View\View  

译者署名

用户名 头像 职能 签名
@dinghua Contracts - 图1 翻译 专注于 PHP 和 Laravel

{note} 欢迎任何形式的转载,但请务必注明出处,尊重他人劳动共创开源社区。

转载请注明:本文档由 Laravel China 社区 [laravel-china.org] 组织翻译,详见 翻译召集帖

文档永久地址: http://d.laravel-china.org