PHP 的包管理工具 -- Composer

compose

缘起

Composer 是 PHP 的一个包管理和包依赖管理的工具 ( 官方的定义是 "Dependency Manager for PHP" ), 类似 Mac 的 Homebrew, CentOS 的 yum, Windows 的 Chocolatey, 以及 Node.js 的 npm 和 Python 的 pip.

在 Composer 出现之前使用 PHP 第三方包的操作:

  1. 上网寻找类库, 从官方或者第三方网站下载源码;
  2. 解压, 调试;
  3. 假如该类库依赖于另外一个类库, 返回第 1 步;

PS. 可以查看我的另一篇文章-- CentOS 编译安装 PHP 的 Memcached 扩展, 安装 PHP 的 Memcached 插件时, 就需要考虑依赖的库, 如果用 CentOS 的包管理工具 -- yum 就可以比较轻松地解决

这种方式带来的问题:

  1. 没有统一的规范的资源仓库, 各种类库散落在互联网的各个角落, 不方便比较和下载; 如果多个类库的作者更新了版本, 需要逐个去搜素下载和调试;
  2. 如果第三方网站提供的源码被植入恶意代码, 会引入安全问题;
  3. 遇到类库的依赖关系, 需要手动下载和调试;
  4. 版本更新不方便. 这就意味着很可能作者更新了版本, 但是你还在使用带 Bug 的旧版本;

安装

Composer 要求 PHP 5.3.2 以上 (官方推荐使用 5.3.4 以上, 以避免潜在的问题).
如果在安装时提醒缺少组件, 跟着提示解决即可.

  • 在 Mac 终端中依次粘贴下面命令以安装 Composer (考虑安全问题, 更加建议直接到官网拷贝安装命令):

    php -r "copy('https://install.phpcomposer.com/installer', 'composer-setup.php');"
    
    php composer-setup.php
    
    php -r "unlink('composer-setup.php');"
    
  • 安装后就可以使用 php composer.phar 来执行命令;

  • 为了全局调用, 可以修改环境变量 mv ./composer.phar /usr/local/bin/composer, 之后就可以直接使用 composer 命令;

composer_installed

使用

连接国内的第三方镜像库

由于众所周知的原因, 访问 Composer 官方的 packagist 网站速度比较慢, 可以选用第三方在国内做的全景镜像, 提高速度:

composer config -g repo.packagist composer https://packagist.phpcomposer.com

使用 composer 在已有项目中引入类库

以使用 markdown 为例:

  • 1.搜索: 在 Packagist 搜索类库, 选用下载量最大的 cebe/markdown 类库;

  • 2.配置: 在项目根目录新建 "composer.json" 文件, 文件内容:

    语法:

    {
        "require":{
            "厂商/类库":"版本"
        }
    }
    

    比如:

    {
         "require":{
            "cebe/markdown":"1.1.1"
        }
    }
    

PS: 配置文件中的 JSON 必须使用"双引号", 而不能使用"单引号" (因为"双引号"是 JSON 标准的规定的)

  • 3.安装
    • 2.1 cd 到该项目根目录, 运行 composer install;
    • 2.2 安装完毕后, 可以看到根目录多出来一个 "vendor" 文件夹, 打开文件夹, 可以看到 "cebe" 文件夹, 里面有 "markdown" 的类库源码;
composer_success
  • 4.加载
    疑问: 如果我们在项目中用 Composer 安装了十几个类库, 需要逐个 require 加载到我们的项目中吗?
    回答: 不需要. 因为 Composer 的作者已经考虑了这个问题. 打开安装之后生成的 "vendor" 文件, 里面有个 "autoload.php" 文件. 只要引入这个文件, 所有通过 Composer 安装的类库就会全部加载完成:

    require(__DIR__.'/vendor/autoload.php');
    
  • 5.如果以后需要新增类库

    • 第一种方法: 使用命令 composer require, 比如 composer require phpunit/phpunit:~5.7, 比如 composer require twbs/bootstrap:4.0.0-beta.3;
    • 第二种方法: 在 "composer.json" 文件中追加, 然后执行 composer update;
    {
        "require":{
            "cebe/markdown":"1.1.1",
            "phpunit/phpunit":"5.7.5"
        }
    }
    

通过 composer 直接创建某框架的项目

有些包并不是提供一个特定功能的类库, 而是提供一个完整的框架, 比如说 Laravel 和 yii2.

直接创建项目的 Composer 命令是:

composer create-project 厂商/类库 安装路径 版本

所以用 Composer 直接创建一个 Laravel 或者 yii2 的项目的命令是:

composer create-project laravel/laravel ./my_laravel_demo ~5.5.0

composer create-project yiisoft/yii2 ./my_yii2_demo 2.*

PS. 5.5 是 Laravel 的 LTS (Long Time Support) 版本.


如何指定类库版本?

类别 实例 说明
指定版本号 5.7.5 直接指定确切的版本号
指定版本范围 >=5.6.7,<5.7 5.6.7或者以上,但是不到5.7的版本
通配符 5.7.* 相当于>=5.7.0,<5.8.0
波浪号 ~5.7.5 相当于>=5.7.5,<5.8.0

如何更新类库?

更新指定类库

composer update 厂商/类库

该命令主要有 2 个作用:

  • 升级 composer.json 中的指定类库, 并自动更新其依赖
  • 更新自动加载的文件 -- autoload.php

如果只是需要更新自动加载的文件而不需要升级类库(比如我们新建了类), 可以执行 composer dump-autoload.

更新全部类库 (慎用)

composer update

注意: 执行 composer update, 将会升级 composer.json 中所有可升级的类库, 并自动更新升级其依赖. 这将引发一种问题 -- 某些类库尽管不是最新版本, 但是运行很正常很稳定, 我们并不需要更新他们. 如果使用"全部更新", 会自动将这些运行稳定的旧版本类库升级到最新版本, 却可能引入新的 Bug 和不确定性, 因此推荐使用"指定更新", 慎用"全部更新"


如何删除引入的类库?

composer remove 厂商/类库

比如:

composer remove cebe/markdown

参考


题外

公司开始规范开发, 逐步引入 PSR, Laravel 框架, PHPUnit, Composer...
从个人来说, 真的很幸运, 能够在这么一个时期加入公司, 在顺流中借势成长. 这也是为什么写这篇博客的原因 -- 当然, 这也是一个博客系列的开始


文章历史

  • 2017/01/08 (第一次发布)
  • 2017/04/04 增加"连接国内的第三方镜像库"
  • 2017/05/25 更新安装 Composer 的方法
  • 2017/05/31 介绍 composer dump-autoload 命令
  • 2017/06/11 删掉"最小化操作流程"章节, 避免用户困惑; 介绍 composer update 命令; 提示 JSON 必须使用双引号;
  • 2017/07/09 增加"安装 PHP 的 Memcached 插件的例子", 反衬包管理工具的好处;
  • 2017/09/11 去掉"最小使用方法"章节, 避免用户混淆; 更新 Laravel 的 LTS;
  • 2019/09/29 完善了 composer update 章节. 感谢 Zyn_fb28 的提醒

如果你觉得我的文章对你有用, 请打个"喜欢", 或者给些改进的建议 _

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,390评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,821评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,632评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,170评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,033评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,098评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,511评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,204评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,479评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,572评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,341评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,213评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,576评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,893评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,171评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,486评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,676评论 2 335

推荐阅读更多精彩内容