我们先来看看官方文档中对contracts的定义:
Laravel’s Contracts are a set of interfaces that define the core services provided by the framework.
意思是说Laravel的Contracts是一个由 框架提供 的定义了 核心服务接口 的集合。
也就是说,每一个Contract都是一个接口,对应一个框架核心服务。
那它的意义何在?官网给出的解释也很简单:使用接口是为了 松耦合 和 简单 。
先不讲大道理,先来点干货,看看怎么使用contract
先浏览下contracts接口列表:
<br />Illuminate\Contracts\Auth\Guard<br />Illuminate\Contracts\Auth\PasswordBroker<br />Illuminate\Contracts\Bus\Dispatcher<br />Illuminate\Contracts\Cache\Repository<br />Illuminate\Contracts\Cache\Factory<br />Illuminate\Contracts\Config\Repository<br />Illuminate\Contracts\Container\Container<br />Illuminate\Contracts\Cookie\Factory<br />Illuminate\Contracts\Cookie\QueueingFactory<br />Illuminate\Contracts\Encryption\Encrypter<br />Illuminate\Contracts\Routing\Registrar<br />
…… 太多了,懒得继续贴了,官网手册里有。我们就拿 Illuminate\Contracts\Routing\Registrar 这个contract来演示一下吧。
首先,打开 app/Providers/AppServiceProvider.php,注意register方法:
<br />public function register()<br />{<br /> $this->app->bind(<br /> 'Illum<div style="color:transparent">!本文来源gaodai.ma#com搞#代!码(网</div><em>搞gaodaima代码</em>inate\Contracts\Auth\Registrar',<br /> 'App\Services\Registrar'<br /> );<br />}<br />
$this->app 就是Application对象,也是容器对象,通过 $this->app->bind 方法我们绑定了一个实现Illuminate\Contracts\Auth\Registrar接口的类App\Services\Registrar。
注意,Illuminate\Contracts\Auth\Registrar就是一个contract。App\Services\Registrar 这个类文件在 app/Services/Registrar.php。
接着我们看 App\Http\Controllers\Auth\AuthController 这个控制器类,看到它有 __construct 构造函数:
<br />public function __construct(Guard $auth, Registrar $registrar)<br />{<br /> $this->auth = $auth;<br /> $this->registrar = $registrar;</p><p> $this->middleware('guest', ['except' => 'getLogout']);<br />}<br />
它有两个参数,对应的类命名空间在脚本开头可以看到:
<br />use Illuminate\Contracts\Auth\Guard;<br />use Illuminate\Contracts\Auth\Registrar;<br />
这两个都是contract,但我们这里就拿 Registrar 说,我们注意到这里面只是通过参数类型指明了$registrar的接口类型,而实际调用的时候实际上是 App\Services\Registrar 这个类,这就是依赖注入的特性了,Laravel会自动在容器中搜索实现了接口Illuminate\Contracts\Auth\Registrar的类或对象,有的话就取出来作为实际参数传到构造函数里。
整个使用流程其实就可以总结为两个步骤:
向容器中注册实现contract接口的对象。
构造函数参数类型指定为contract接口类,框架会自动找到符合条件的对象。
那么再来说说contract的好处。
松耦合
官网给了一个例子解释什么是紧耦合以及Contract接口为何能够松耦合。
先来看看紧耦合的代码:
<br /><?php namespace App\Orders;<br />class Repository {<br /> /**<br /> * The cache.<br /> */<br /> protected $cache;<br /> /**<br /> * Create a new repository instance.<br /> *<br /> * @param \SomePackage\Cache\Memcached $cache<br /> * @return void<br /> */<br /> public function __construct(\SomePackage\Cache\Memcached $cache)<br /> {<br /> $this->cache = $cache;<br /> }<br /> /**<br /> * Retrieve an Order by ID.<br /> *<br /> * @param int $id<br /> * @return Order<br /> */<br /> public function find($id)<br /> {<br /> if ($this->cache->has($id))<br /> {<br /> //<br /> }<br /> }<br />}<br />
可以看到构造函数中注入了一个详细的缓存实现 \SomePackage\Cache\Memcached ,如果换Redis作为缓存服务器或者更改了api方法,就需要修改,而如果项目很大,你不知道还有多少地方需要修改。
那么,Contract接口是如何解决这个问题的?请看代码:
<br /><?php namespace App\Orders;<br />use Illuminate\Contracts\Cache\Repository as Cache;<br />class Repository {<br /> /**<br /> * Create a new repository instance.<br /> *<br /> * @param Cache $cache<br /> * @return void<br /> */<br /> public function __construct(Cache $cache)<br /> {<br /> $this->cache = $cache;<br /> }<br />}<br />
注意,缓存实现我们使用了一个接口,也就是contract,Illuminate\Contracts\Cache\Repository,因为它只是接口,不需要关心背后是memcache还是redis。
简单性
如果所有服务都使用接口定义,就可以很简单的决定一个服务需要的功能,更加容易维护和扩展,并且contract接口还能看作一个简洁的文档便于阅读。