Outil de gestion des dépendances des packages que les développeurs PHP doivent connaître : Composer

Composer est un outil de gestion des dépendances de packages PHP très populaire, qui a remplacé le gestionnaire de packages PEAR. Mastering Composer est un incontournable pour les développeurs PHP

Pour les utilisateurs, Composer est très simple. Vous pouvez télécharger le package de code requis dans le répertoire du fournisseur avec une simple commande, puis les développeurs peuvent introduire le package et l'utiliser

La clé réside dans la définition de votre projet composer.json. , vous pouvez définir les packages dont le projet doit dépendre (il peut y en avoir plusieurs), et les packages dépendants peuvent dépendre d'autres packages (c'est l'avantage des composants. Vous n'avez pas à vous en soucier, Composer le fera). téléchargez automatiquement tout ce dont vous avez besoin. , tout réside dans la définition de composer.json

Composer est très transparent pour les utilisateurs, mais le concept qui le sous-tend doit encore être compris, et sa naissance n'est pas accidentelle, grâce à. la rapidité de Github Avec le développement, le langage PHP devient de plus en plus moderne et semble plus avancé.

Afin de comprendre Composer, il faut d'abord avoir une compréhension générale de sa structure :

Structure de Composer

Outil de ligne de commande Composer :

Cette compréhension est relativement simple, grâce à la définition de l'utilisateur Composer.json pour télécharger le code dont vous avez besoin. Si vous utilisez simplement Composer, vous pouvez alors maîtriser certaines commandes spécifiques

Chargeur de code à chargement automatique :

Grâce à Composer, les développeurs peuvent l'utiliser de différentes manières, et la clé réside dans le concept d'espace de noms de PHP et le développement du standard PSR-4. Composer n'a développé qu'un chargeur automatique de code basé sur ces deux <.>

Github :

Avec Github, les développeurs PHP peuvent y héberger du code open source, et le développement de Composer provenant de Github télécharge essentiellement le code sur Github vers le. local.

Packagist :

Pour les utilisateurs, l'outil de ligne de commande de Composer est utilisé, alors comment l'outil de ligne de commande sait-il combien de packages peuvent être utilisés par le utilisateur ? Eh bien, cela repose principalement sur Packagist. Packagist est le principal référentiel d'informations sur les packages de Composer. Les développeurs de packages hébergent des codes spécifiques sur Github et soumettent les informations sur les packages à Packagist, afin que les utilisateurs puissent les utiliser via Composer.

Le compositeur interroge Packagist. sur la base des informations composer.json définies localement, Packagist analyse les informations Composer.json/Package.json et correspond finalement au référentiel github. Lorsque Composer télécharge enfin le code, cela dépend également du référentiel Github. trois types de composer.json impliqués ici, les significations sont différentes

Composer.json :

C'est le cœur de Composer Les règles de Composer, les trois. Les types de Composer.json sont également mentionnés ci-dessus. Vous devez faire attention à la distinction lorsque vous les utilisez. J'ai toujours raté la première fois que j'ai appris

Outils de ligne de commande Composer<.>

composer init

Les utilisateurs peuvent créer composer.json sous leurs propres projets pour définir les packages de dépendances de votre projet, ou ils peuvent passer composer init de manière interactive pour créer composer .json.

composer install

devrait être la commande la plus couramment utilisée. Composer téléchargera le package d'installation en fonction du composer.json local. Mettez le package dans le fournisseur. sous le projet, et placez les informations sur la version du package lors de l'installation dans composer.lock pour verrouiller la version

En fait, lors de l'installation, si la version de composer.lock s'avère être la même que la version actuelle. Si la version du code dans le répertoire du fournisseur est cohérente, Composer ne fera rien. Le but de composer.lock est de vous permettre de travailler dans la version actuelle sans obtenir la dernière version du package

. composer update

Alors, comment mettre à jour composer.lock pour obtenir la dernière version du package ? Utilisez cette commande pour mettre à jour la dernière version du package

composer config

🎜 >

Il est recommandé de comprendre cette commande. La configuration globale est enregistrée dans COMPOSER_HOME/config.json et les informations de configuration non globales sont stockées dans le répertoire du projet.

composer config --list -g
composer config -g notify-on-install false
composer global config bin-dir --absolute
composer create-project

Ceci. La commande n'est pas couramment utilisée. Mais je pense personnellement qu'elle est toujours très importante. Utiliser la commande d'installation ordinaire consiste à télécharger tous les packages dépendants du projet dans le répertoire fournisseur du projet. Avec cette commande, tout le code et ses packages dépendants. sont placés dans un répertoire, ce qui est tout à fait Yu exécuté une commande git clone Généralement, les développeurs de packages peuvent utiliser cette commande pour corriger les bogues

composer global

C'est. une commande d'installation globale, elle vous permet d'exécuter des commandes Composer dans le répertoire COMPOSER_HOME, telles que l'installation et la mise à jour. Bien sûr, votre COMPOSER_HOME doit être dans l'environnement $PATH

Par exemple, exécutez composer global require fabpot. /php-cs-fixer, la ligne de commande php -cs-fixer peut désormais être exécutée globalement. Si vous souhaitez la mettre à jour plus tard, exécutez simplement composer global update

composer dump-autoload<. 🎜>

lorsque vous modifiez le projet Il n'est pas nécessaire d'exécuter la commande composer update pour mettre à jour le fichier composer.json sous Pratique pour illustrer cette commande.

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