PHP 開発者が知っておくべきパッケージの依存関係管理ツール: Composer

Composer は、非常に人気のある PHP パッケージの依存関係管理ツールです。PEAR パッケージ マネージャーに取って代わりました。PHP 開発者は Composer をマスターする必要があります。

ユーザー向け, Composer は非常にシンプルです。簡単なコマンドで必要なコード パッケージをベンダー ディレクトリにダウンロードでき、開発者はパッケージを導入して使用できます。

鍵はプロジェクト コンポーザーの定義にあります。 json では、プロジェクトが依存する必要があるパッケージ (複数の可能性があります) を定義でき、依存パッケージは他のパッケージに依存する場合があります (これはコンポーネントの利点です)。これらについて心配する必要はありません。必要なものはすべて自動的にダウンロードされます。すべてはcomposer.jsonの定義にあります。

Composerはユーザーにとって非常に透過的ですが、その背後にある概念を理解する必要があり、その誕生は偶然ではありません、ありがとうGithub の速度に合わせて Composer の開発により、PHP 言語はますます最新のものになり、ますます高度になっているように見えます。

Composer を理解するには、まず一般的な言語を理解する必要があります。構造の理解:

Composer の構造

##Composer コマンド ライン ツール:

これを理解するのは比較的簡単です。ユーザー定義 Composer.json を使用して、必要なコードをダウンロードします。単純に Composer を使用するだけであれば、いくつかの特定のコマンドを習得できます。

コードの自動読み込みloader:

Composer を介して、開発者はさまざまな方法で Composer を使用できますが、その鍵は PHP の名前空間の概念と PSR-4 標準の開発にあります。Composer は自動コードのみを開発しました。これら 2 つに基づくローダー

Github:

Github を使用すると、PHP 開発者はオープン ソース コードをホストでき、Composer の開発は Github から始まりました。Composer は基本的にダウンロードします。 Github のコード ローカルに移動します。

Packagist:

ユーザーの場合、Composer のコマンド ライン ツールが使用されますが、コマンド ライン ツールはどのようにしてその数を知るのでしょうか。ユーザーはパッケージを使用できますか? そうですね、これは主に Packagist に依存しています。Packagist は Composer の主要なパッケージ情報リポジトリです。パッケージ開発者は Github で特定のコードをホストし、パッケージ情報を Packagist に送信するため、ユーザーは Composer を通じてパッケージ情報を使用できます。

Composer は、ローカルに定義された作曲家.json 情報に基づいて Packagist にクエリを実行します。Packagist は、Composer.json/Package.json に基づいて情報を解析し、最終的に github リポジトリに対応します。Composer が最終的にコードをダウンロードするとき、コードは Github にも依存します。

Composer.json:

これは Composer のコアです。 . Composer のルール、Composer.json の 3 種類についても上で説明しました。使用する際には区別に注意する必要があります。私は最初に学んだときはいつも失敗してしまいました。

Composer コマンド ライン ツール

composer init

ユーザーは、自分のプロジェクトの下にcomposer.jsonを作成して、プロジェクトの依存関係パッケージを定義できます。これらは、composer init を対話的に渡すことができ、composer.json を作成します。

composer install

は、最も一般的に使用されるコマンドです。Composer は、ローカルの Composer に基づいてインストール パッケージをダウンロードします.json パッケージをプロジェクトの下のベンダー ディレクトリに置き、インストール中にパッケージのバージョン情報をcomposer.lockに入れてバージョンをロックします。

実際には、インストール中にcomposer.lockのバージョンが見つかった場合、現在のバージョンと同じであること ベンダー ディレクトリ内のコード バージョンが同じである場合、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 コマンドを使用すると、プロジェクトのすべての依存パッケージがプロジェクトのベンダー ディレクトリにダウンロードされます。 git clone コマンドが実行されるため、通常、パッケージ開発者はこのコマンドを使用してバグを修正します。

##これはグローバル インストール コマンドです。これを使用すると、インストールや更新などの COMPOSER_HOME ディレクトリで Composer コマンドを実行できます。もちろん、COMPOSER_HOME は $PATH 環境にある必要があります。

たとえば、composer global require fabpot/php-cs-fixer を実行すると、php -cs-fixer コマンド ラインをグローバルに実行できるようになります。後で更新したい場合は、composer global update を実行してください

composer dump-autoload

プロジェクトを変更するときは、このコマンドを説明するために「練習」の下にあるcomposer update コマンドを実行してcomposer.jsonファイルを更新する必要はありません。

作曲家が必要

假如手动或者交互式创建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