Composer 是一个非常流行的 PHP 包依赖管理工具, 已经取代 Pear 包管理器, 对于 PHP 开发者来说掌握 Composer 是必须的.
对于使用者来说 Composer 非常的简单, 通过简单的一条命令将需要的代码包下载到 vendor 目录下, 然后开发者就可以引入包并使用了.
其中的关键在于你项目定义的 Composer.JSON, 可以定义项目需要依赖的包(可能有多个), 而依赖的包可能又依赖其他的包(这就是组件的好处), 这些都不用你烦心, Composer 会自动下载你需要的一切, 一切在于 Composer.JSON 的定义.
Composer 对于使用者来说是很透明, 但是其背后的理念还是需要了解一下的, 其的诞生也不是偶然的, 得益于 GitHub 的快速发展, PHP 语言也越来越现代化, 显得更高大上了.
更多 PHP 相关知识请关注我的专栏 PHPzhuanlan.zhihu.com https://zhuanlan.zhihu.com/c_1178338184454402048
为了理解 Composer, 先大概了解下其结构:
Composer 的结构
Composer 命令行工具:
这个理解就比较简单了, 通过使用者定义的 Composer.JSON 去下载你需要的代码, 假如只是简单的使用 Composer, 那么掌握一些具体命令就完全可以了
Autoloading 代码加载器:
通过 Composer, 开发者可以通过多种方式去使用, 而其中的关键在于 PHP 的命名空间概念, 以及 PSR-4 标准的发展, Composer 只是根据这二者开发了一个代码自动加载器
GitHub:
有了 GitHub,PHP 开发人员可以将开源的代码托管在这上面, 而 Composer 的发展源于 GitHub,Composer 本质上就是将 GitHub 上的代码下载到本地.
Packagist:
对于使用者来说使用的是 Composer 的命令行工具, 那么命令行工具怎么知道有多少包可以被用户使用呢, 这主要就是依赖于 Packagist,Packagist 是 Composer 主要的一个包信息存储库, 包开发者将具体代码托管到 GitHub 上, 将包信息提交到 Packagist 上, 这样使用者就可以通过 Composer 去使用.
Composer 根据本地定义的 Composer.JSON 信息去查询 Packagist,Packagist 根据 Composer.JSON/Package.JSON 信息解析, 最终对应到 GitHub 仓库, Composer 最终下载代码的时候还要依赖于 GitHub 仓库上的 Composer.JSON, 这里涉及到三种类型的 Composer.JSON, 含义是不一样的.
Composer.JSON:
这是 Composer 的核心, 是 Composer 的规则, 上面也提到了三种类型的 Composer.JSON, 在使用的时候一定要注意区分, 我初学的时候就总是搞乱.
Composer 命令行工具
Composer init
使用者可以在自己的项目下创建 Composer.JSON 以便定义你项目的依赖包, 也可以通过 Composer init 交互式的创建 Composer.JSON.
Composer install
应该是最常用的命令, Composer 会根据本地的 Composer.JSON 安装包, 将下载的包放入项目下的 vendor 目录下, 同时将安装时候的包版本信息放入到 Composer.lock, 以便锁定版本.
其实在 install 的时候, 假如发现 Composer.lock 版本和目前 vendor 目录下的代码版本是一致的, 则 Composer 会什么也不做, Composer.lock 的目的就是让你安心在目前这个版本下工作, 而不获取最新版本的包.
Composer update
那么如何更新 Composer.lock 以便获取到最新版本的包呢? 通过这个命令即可更新最新版本的包
Composer config
这个命令还是建议了解下, 全局的配置保存在 COMPOSER_HOME/config.JSON, 非全局的配置信息则存储在本项目目录下.
- Composer config --list -g
- Composer config -g notify-on-install false
- Composer global config bin-dir --absolute
- Composer create-project
这个命令不常用, 但是个人觉得还是很重要的, 使用普通的 install 命令是将项目所有的依赖包下载到本项目 vendor 目录下. 而通过这个命令则是将所有的代码及其依赖的包放到一个目录下, 相当于执行了一个 Git clone 命令, 一般是包的开发者可能为了修复 bug 会使用该命令.
Composer global
这是一个全局的安装命令, 它允许你在 COMPOSER_HOME 目录下执行 Composer 的命令, 比如 install,update. 当然你的 COMPOSER_HOME 要在 $PATH 环境下.
比如执行 Composer global require fabpot/PHP-cs-fixer, 现在 PHP-cs-fixer 命令行可以全局运行了, 如果稍后想更新它, 只需要运行 Composer global update
Composer dump-autoload
当你修改项目下的 Composer.JSON 的文件, 并不一定要运行 Composer update 命令进行更新, 有的时候可以使用该命令来更新加载器, 比如你要引用本地自定义的包(不是来自于 packagist), 后面会通过实践来说明该命令.
Composer require
假如手动或者交互式创建 Composer.JSON 文件, 可以直接使用该命令来安装包
- Composer require cerdic/CSS-tidy:1.5.2
- Composer require "ywdblog/phpcomposer:dev-master"
-prefer-source 和 - prefer-dist 参数
-prefer-dist: 对于稳定的包来说, 一般 Composer 安装默认使用该参数, 这也能加快安装, 比如有可能直接从 packagist 安装了相应的包, 而不用实际去 GitHub 上下载包.
-prefer-source: 假如使用该参数, 则会直接从 GitHub 上安装, 安装包后 vendor 目录下还含有. Git 信息
- Composer require "ywdblog/phpcomposer:dev-master" --prefer-source
- # 在 vendor/ywdblog/phpcomposer 目录下含有. Git 信息
如何给 Composer 添加代理
在国内使用 Composer 下载特别慢, 可以通过二个方法进行加速
Composer config repo.packagist Composer "https://packagist.phpcomposer.com"
编辑 Composer.JSON
- "repositories": {
- "packagist": {
- "type": "composer",
- "url": "https://packagist.phpcomposer.com"
- }
- }
Autoloading 代码加载器
Composer 本身集成一个 autoloader, 支持 PSR-4,PSR-0,classmap,files autoloading.
这里通过一个例子来说明通过 Composer 如何引用 classmap,files, 本地符合 PSR-4 标准的代码
编辑 Composer.JSON
- "autoload": {
- "classmap": ["othsrc/","classsrc.php"],
- "files": ["othsrc/filesrc.php"],
- "psr-4": {"Foo\Bar\": "src"} }
- Composer dump-autoload
通过上述的操作, 对于 PSR-4 来说等同注册了一个 PSR-4 autoloader(从 FooBar 命名空间)
假如不想使用 Composer 的 autoloader, 可以直接包含 vendor/Composer/autoload_*.PHP 文件, 配置自己的加载器.
具体的例子托管在 GitHub 上, 可参考.
Repositories
关于 Repositories, 了解其不是必须的, 但是假如掌握则更能理解 Composer, 对于 Repositories, 其中文文档和英文文档解释的很好, 这里也进行了一些摘抄.
基本概念
包:
Composer 是一个依赖管理工具, 它在本地安装一些资源包和包的描述(比如包名称和对应的版本), 比较重要的元数据描述是 dist 和 source,dist 指向一个存档, 该存档是对一个资源包的某个版本的数据进行的打包. source 指向一个开发中的源, 这通常是一个源代码仓库(比如 Git)
资源库:
一个资源库是一个包的来源. 它是一个 packages/versions 的列表.
Composer 将查看所有你定义的 repositories 以找到项目需要的资源包(这句话很重要).
默认情况下已经将 http://Packagist.org 注册到 Composer(或者理解为 http://Packagist.org 是 Composer 资源库默认的仓库类型)
Composer 资源库类型
Composer 资源库包括四种类型, 默认的是 Composer 类型, 也就是 http://packagist.org 所使用的资源类型.
它使用一个单一的 packages.JSON 文件, 包含了所有的资源包元数据. 当你将包发布到 http://pckagist.org 上, 则默认系统会创建一个 packages.JSON, 不过我没有找到我的包对应的文件.
VCS 资源库类型
假如你想构建一个私有的 Composer 私有资源库类型, 可以使用该类型, 这里举一个例子, 比如你在自己项目的 Composer.JSON 定义如下, 则就可以使用对应的 GitHub 上的代码了.
- {
- "repositories": [
- {
- "type": "vcs",
- "url": "https://github.com/ywdblog/phpcomposer"
- }
- ],
- "require": {
- "ywdblog/phpcomposer": "dev-master"
- }
- }
当运行 Composer update 的时候, Comoser 实际上是从 GitHub 上下载包而不是从 http://pckagist.org 上下载.
另外假如需要使用 Package 资源库类型或者 Pear 资源库类型, 参考官方文档即可, 一般在 Composer.JSON 中定义 name,version 属性即可.
Composer.JSON
在本文上面也多次提到了 Composer.JSON, 比如你希望使用第三方包则需要在本地定义 Composer.JSON,Composer 安装第三方包后, 也会在第三方包目录下发现 Composer.JSON, 那么这二者都叫 Composer.JSON, 有什么区别呢? 理解这非常的重要.
假如你在自己的项目下面定义一个 Composer.JSON, 则这个包称之为 ROOT 包, 这个 Composer.JSON 定义你项目需要的条件(比如你的项目可能依赖一个第三方包).
Composer.JSON 中有些属性只能被 ROOT 包使用, 比如 config 属性只在 ROOT 包中生效.
一个资源包是不是 ROOT 包, 取决于它的上下文, 比如你 Git clone ywdblog/phpcomposer, 则这时候本地 phpcomposer 目录就是 ROOT 包, 假如你在本地 phpcomposer 目录下 Composer require ywdblog/phpcomposer, 则这时候你的项目 phpcomposer 就是 ROOT 包.
了解 Composer-schema.JSON 可参考该网址, Laravel 作为一个成熟的框架, 其定义的 Composer.JSON 非常经典
关于包的版本
当使用者在本地配置 Composer.JSON 的时候, 可以指定需要包的特定版本, Composer 支持从 GitHub 仓库中下载 Tag 或者分支下的包.
对于 GitHub 上的 Tag 来说, Packagist 会创建对应包的版本, 它符合 X.Y.Z,vX.Y.Z,X.Y.Z - 包类型, 就是说 GitHub 上虽然只有一个特定版本的包, 但 Composer 支持多种形式的引用方式, 比如:
- Composer require monolog/monolog 1.0.0-RC1
- Composer require monolog/monolog v1.0.0-RC1
- Composer require monolog/monolog 1.0.*
- Composer require monolog/monolog ~1.10
对于 GitHub 上的分支来说, Packagist 会创建对应包的版本, 假如分支名看起来像一个版本, 将创建 {分支名}-dev 的包版本号, 如果分支名看起来不像一个版本号, 它将会创建 dev-{分支名} 形式的版本号
总结:
理解 Composer, 最重要的是实践, 最后也能明白 PSR-4 和命名空间, 也可以尝试将你的项目发布到 http://pckagist.org 上.
以上就是[Composer] PHP 开发者必须了解! 的详细内容
来源: https://www.cnblogs.com/a609251438/p/12121898.html