【Composer】PHP开发者必须了解！

composer是一个非常流行的php包依赖管理工具,已经取代pear包管理器,对于php开发者来说掌握composer是必须的.

对于使用者来说composer非常的简单,通过简单的一条命令将需要的代码包下载到vendor目录下,然后开发者就可以引入包并使用了.

其中的关键在于你项目定义的composer.json,可以定义项目需要依赖的包(可能有多个),而依赖的包可能又依赖其他的包(这就是组件的好处),这些都不用你烦心,composer会自动下载你需要的一切,一切在于composer.json的定义.

composer对于使用者来说是很透明,但是其背后的理念还是需要了解一下的,其的诞生也不是偶然的,得益于github的快速发展,php语言也越来越现代化,显得更高大上了.

更多php相关知识请关注我的专栏php​zhuanlan.zhihu.com

为了理解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开发者必须了解！的详细内容