Laravel5中contracts详解


Posted in PHP onMarch 02, 2015

我们先来看看官方文档中对contracts的定义:

Laravel's Contracts are a set of interfaces that define the core services provided by the framework.
意思是说Laravel的Contracts是一个由 框架提供 的定义了 核心服务接口 的集合。

也就是说,每一个Contract都是一个接口,对应一个框架核心服务。

那它的意义何在?官网给出的解释也很简单:使用接口是为了 松耦合 和 简单 。

先不讲大道理,先来点干货,看看怎么使用contract

先浏览下contracts接口列表:

Illuminate\Contracts\Auth\Guard

Illuminate\Contracts\Auth\PasswordBroker

Illuminate\Contracts\Bus\Dispatcher

Illuminate\Contracts\Cache\Repository

Illuminate\Contracts\Cache\Factory

Illuminate\Contracts\Config\Repository

Illuminate\Contracts\Container\Container

Illuminate\Contracts\Cookie\Factory

Illuminate\Contracts\Cookie\QueueingFactory

Illuminate\Contracts\Encryption\Encrypter

Illuminate\Contracts\Routing\Registrar

…… 太多了,懒得继续贴了,官网手册里有。我们就拿 Illuminate\Contracts\Routing\Registrar 这个contract来演示一下吧。
首先,打开 app/Providers/AppServiceProvider.php,注意register方法:

public function register()

{

    $this->app->bind(

        'Illuminate\Contracts\Auth\Registrar',

        'App\Services\Registrar'

    );

}

$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 构造函数:

public function __construct(Guard $auth, Registrar $registrar)

{

    $this->auth = $auth;

    $this->registrar = $registrar;
    $this->middleware('guest', ['except' => 'getLogout']);

}

它有两个参数,对应的类命名空间在脚本开头可以看到:

use Illuminate\Contracts\Auth\Guard;

use Illuminate\Contracts\Auth\Registrar;

这两个都是contract,但我们这里就拿 Registrar 说,我们注意到这里面只是通过参数类型指明了$registrar的接口类型,而实际调用的时候实际上是 App\Services\Registrar 这个类,这就是依赖注入的特性了,Laravel会自动在容器中搜索实现了接口Illuminate\Contracts\Auth\Registrar的类或对象,有的话就取出来作为实际参数传到构造函数里。

整个使用流程其实就可以总结为两个步骤:

向容器中注册实现contract接口的对象。
构造函数参数类型指定为contract接口类,框架会自动找到符合条件的对象。
那么再来说说contract的好处。

松耦合

官网给了一个例子解释什么是紧耦合以及Contract接口为何能够松耦合。

先来看看紧耦合的代码:

<?php namespace App\Orders;

class Repository {

    /**

     * The cache.

     */

    protected $cache;

    /**

     * Create a new repository instance.

     *

     * @param  \SomePackage\Cache\Memcached  $cache

     * @return void

     */

    public function __construct(\SomePackage\Cache\Memcached $cache)

    {

        $this->cache = $cache;

    }

    /**

     * Retrieve an Order by ID.

     *

     * @param  int  $id

     * @return Order

     */

    public function find($id)

    {

        if ($this->cache->has($id))

        {

            //

        }

    }

}

可以看到构造函数中注入了一个详细的缓存实现 \SomePackage\Cache\Memcached ,如果换Redis作为缓存服务器或者更改了api方法,就需要修改,而如果项目很大,你不知道还有多少地方需要修改。

那么,Contract接口是如何解决这个问题的?请看代码:

<?php namespace App\Orders;

use Illuminate\Contracts\Cache\Repository as Cache;

class Repository {

    /**

     * Create a new repository instance.

     *

     * @param  Cache  $cache

     * @return void

     */

    public function __construct(Cache $cache)

    {

        $this->cache = $cache;

    }

}

注意,缓存实现我们使用了一个接口,也就是contract,Illuminate\Contracts\Cache\Repository,因为它只是接口,不需要关心背后是memcache还是redis。

简单性

如果所有服务都使用接口定义,就可以很简单的决定一个服务需要的功能,更加容易维护和扩展,并且contract接口还能看作一个简洁的文档便于阅读。

PHP 相关文章推荐
php正则
Jul 07 PHP
PHP中ADODB类详解
Mar 25 PHP
PHP注释实例技巧
Oct 03 PHP
PHP项目开发中最常用的自定义函数整理
Dec 02 PHP
php 解决旧系统 查出所有数据分页的类
Aug 27 PHP
PHP使用Session遇到的一个Permission denied Notice解决办法
Jul 30 PHP
PHP常用编译参数中文说明
Sep 27 PHP
thinkPHP5.0框架API优化后的友好性分析
Mar 17 PHP
Thinkphp5行为使用方法汇总
Dec 21 PHP
thinkPHP3.2使用RBAC实现权限管理的实现
Aug 27 PHP
浅谈laravel中的关联查询with的问题
Oct 10 PHP
PHP预定义接口――Iterator用法示例
Jun 05 PHP
php打印一个边长为N的实心和空心菱型的方法
Mar 02 #PHP
初识laravel5
Mar 02 #PHP
避免Smarty与CSS语法冲突的方法
Mar 02 #PHP
实现PHP+Mysql无限分类的方法汇总
Mar 02 #PHP
Java和PHP在Web开发方面对比分析
Mar 01 #PHP
php中return的用法实例分析
Feb 28 #PHP
php多次include后导致全局变量global失效的解决方法
Feb 28 #PHP
You might like
提高PHP编程效率的53个要点(经验小结)
2010/09/04 PHP
PHP7正式版测试,性能惊艳!
2015/12/08 PHP
PHP使用stream_context_create()模拟POST/GET请求的方法
2016/04/02 PHP
详解yii2使用多个数据库的案例
2017/06/16 PHP
PHP crc32()函数讲解
2019/02/14 PHP
TP5框架安全机制实例分析
2020/04/05 PHP
js函数使用技巧之 setTimeout(function(){},0)
2009/02/09 Javascript
Draggable Elements 元素拖拽功能实现代码
2011/03/30 Javascript
jquery实现微博文字输入框 输入时显示输入字数 效果实现
2013/07/12 Javascript
处理文本部分内容的TextRange对象应用实例
2014/07/29 Javascript
深入分析escape()、encodeURI()、encodeURIComponent()的区别及示例
2014/08/04 Javascript
IE6 hack for js 集锦
2014/09/23 Javascript
jQuery实现的输入框选择时间插件用法实例
2015/02/28 Javascript
JavaScript实现拖拽网页内元素的方法
2015/04/15 Javascript
js的flv视频播放器插件使用方法
2015/06/23 Javascript
jquery使用on绑定a标签无效 只能用live解决
2016/06/02 Javascript
js 获取范围内的随机数实例代码
2016/08/02 Javascript
JS实现根据用户输入分钟进行倒计时功能
2016/11/14 Javascript
Vue.js实现简单ToDoList 前期准备(一)
2016/12/01 Javascript
vue.js编译时给生成的文件增加版本号
2018/09/17 Javascript
使用 Node.js 实现图片的动态裁切及算法实例代码详解
2018/09/29 Javascript
webpack开发环境和生产环境的深入理解
2018/11/08 Javascript
小程序如何使用分包加载的实现方法
2019/05/22 Javascript
iview form清除校验状态的实现
2019/09/19 Javascript
在Python3中初学者应会的一些基本的提升效率的小技巧
2015/03/31 Python
python matplotlib画图实例代码分享
2017/12/27 Python
pandas分别写入excel的不同sheet方法
2018/12/11 Python
详解HTML5中ol标签的用法
2015/09/08 HTML / CSS
番木瓜健康和保健产品第一大制造商:Herbal Papaya
2017/04/25 全球购物
毕业生自荐书模版
2014/01/04 职场文书
离婚协议书范本(2014版)
2014/09/28 职场文书
优秀共产党员推荐材料
2014/12/18 职场文书
公司内部升职自荐信
2015/03/27 职场文书
医院中层管理人员培训心得体会
2016/01/11 职场文书
申论不会写怎么办?教您掌握这6点思维和原则
2019/07/17 职场文书
Python实战之OpenCV实现猫脸检测
2021/06/26 Python