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