PHP開發者必須了解的套件依賴管理工具：Composer

Composer是一個非常流行的PHP套件依賴管理工具,已經取代PEAR套件管理器,對於PHP開發者來說掌握Composer是必須的.

對於用戶來說Composer非常的簡單,透過簡單的一條命令將需要的代碼包下載到vendor目錄下,然後開發者就可以引入包並使用了.

其中的關鍵在於你項目定義的composer.json,可以定義專案需要依賴的套件(可能有多個),而依賴的套件可能又依賴其他的套件(這就是元件的好處),這些都不用你煩心,Composer會自動下載你需要的一切,一切在於composer.json的定義.

Composer對於使用者來說是很透明,但是其背後的理念還是需要了解一下的,其的誕生也不是偶然的,得益於Github的快速發展,PHP語言也越來越現代化,顯得更高大上了.

為了理解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上.

PHP中文网，有大量免费的PHP教程，欢迎大家学习！

本文转自：https://www.jianshu.com/p/d8bb33c53482