Tutoriel d'utilisation de Composer (utilisation de base)

Composer est un outil de gestion des dépendances pour PHP. Grâce à lui, nous pouvons facilement utiliser une commande pour référencer d'autres excellents codes dans nos projets. Ci-dessous, la colonne tutoriel d'utilisation de Composer expliquera l'utilisation de base de Composer. J'espère que cela sera utile aux amis dans le besoin !

Utilisation de base

Introduction

Présentation de l'utilisation de base, nous installerons monologue Bibliothèque de journalisation /monolog à titre d'exemple. Tel que

Remarque : Par souci de simplicité, nous supposons que vous avez installé Composer localement.

composer.json : Paramètres du projet

Pour utiliser Composer dans votre projet, vous avez besoin d'un fichier composer.json. Ce fichier décrit les dépendances de votre projet et d'autres métadonnées.

require key

La première (et généralement la seule) chose que vous devez faire est de définir la clé require dans votre fichier composer.json. Vous devez indiquer brièvement à Composer de quels packages dépend votre projet.

{
    "require": {
        "monolog/monolog": "1.0.*"
    }
}

Comme indiqué ci-dessus, require obtient un objet json avec un nom de package (par exemple monolog/monolog) mappé à une contrainte de version (par exemple 1.0.*).

Composer utilise ces informations pour rechercher les fichiers appropriés dans le référentiel de versions spécifié par la clé de référentiels que vous avez enregistrée dans Composer.json ou dans le référentiel de packages par défaut dans Packagist. Dans l'exemple ci-dessus, comme aucune autre information de référentiel n'est enregistrée dans le fichier composer.json, il suppose que le package monolog/monolog est dans Packagist par défaut. (Voir ci-dessous pour plus d'informations sur Packagist, ou en savoir plus ici.

Nom du package

Le nom du package se compose du nom du fournisseur et du nom du projet. Généralement dans dans le cas où ces noms sont identiques, la présence du nom du fournisseur résout les conflits de noms. Par exemple, cela permet à deux personnes différentes de créer une bibliothèque avec le même nom que igorw/json et seldaek/json .

Ici, vous pouvez en savoir plus sur la publication des packages et la dénomination des packages

Notez que vous pouvez également spécifier des « packages de plate-forme » comme dépendances, ce qui vous permet de personnaliser certaines versions du logiciel serveur

.

Contraintes de version du package ci-dessous

Dans l'exemple ci-dessus, la version du monologue que nous avons introduite est spécifiée comme 1.0.* Cela signifie que toute branche de développement à partir de 1.0 correspondra aux versions supérieures à. ou égal à 1,0 et inférieur à 1,1

Veuillez lire pour des informations plus détaillées sur les versions, comment elles sont liées les unes aux autres ou comment contrôler les versions

Comment Composer télécharge-t-il le bon fichier Quand ? vous spécifiez une dépendance dans composer.json, Composer obtient d'abord le nom du package que vous avez demandé et le recherche dans tous les référentiels enregistrés avec la clé de bibliothèque. Si vous n'enregistrez aucun référentiel supplémentaire, ou si ce n'est pas le cas. recherchez un package portant ce nom dans le référentiel que vous avez spécifié, il revient à Packagist (détails ci-dessous) lorsque Composer est dans le packager. Lorsque le package correct est trouvé ou dans le référentiel du package spécifié, il utilise la fonctionnalité de gestion de versions de. le VCS du package (c'est-à-dire les branches et les balises) pour essayer de trouver la meilleure correspondance pour les contraintes de version que vous avez spécifiées. Assurez-vous de lire les versions et les déclarations du package

Remarque : si vous essayez d'obtenir un package et. Composer renvoie une erreur sur la stabilité du package, la version que vous avez spécifiée peut ne pas répondre aux exigences minimales de stabilité par défaut, seules les versions stables seront prises en compte lors de la recherche de versions de package valides dans VCS

Si vous souhaitez également obtenir DEV, Versions Alpha, Beta ou RC, veuillez en savoir plus sur l'indicateur stable et la clé de stabilité minimale sur la page du schéma

Installer les dépendances

Utilisez la commande d'installation pour installer. les dépendances définies pour votre projet

php composer.phar install

Exécutez cette commande, composer sera installé de l'une des deux manières suivantes selon la situation

Installation non-composer.lock

Si vous n'avez jamais exécuté la commande auparavant, elle ne le sera pas. Lorsque le fichier composer.lock apparaît, Composer analysera uniquement les dépendances que vous avez répertoriées dans le fichier composer.json et téléchargera la dernière version dans le répertoire des fournisseurs de votre projet. (le fournisseur est le répertoire habituel du projet où tout le code tiers est stocké). Dans notre exemple ci-dessus, vous vous retrouveriez avec tous les fichiers sources Monolog dans le répertoire supplier/monolog/monolog/. Si Monolog a des dépendances, elles apparaîtront également dans supplier/.

Conseil :

Si vous utilisez git dans votre projet, vous souhaiterez peut-être ajouter supplier à .gitignore. Parce qu'ajouter tous les packages tiers au référentiel semble idiot.

Lorsque Composer termine l'installation, il écrira tous les packages téléchargés et les informations de version exactes dans le fichier composer.lock pour verrouiller les versions des packages tiers dans le projet. Vous devez placer composer.lock dans le référentiel du projet afin que tous les membres du projet puissent être verrouillés sur la même version des dépendances

Utilisez le fichier composer.lock pour installer

这里来到了第二种安装方式。如果你在运行 composer install 命令之前已经存在了 composer.lock 和 composer.json 文件， 这意味着你之前使用了 install 命令， 或者项目中的其他成员使用了 install 命令并将 composer.lock 文件提交至了项目中 (这是非常好的)。

无论使用哪种方式，存在 composer.lock 文件时使用 install 命令安装依赖时 composer.lock 都会解析并安装你在 composer.json 中所列出来的依赖，但是 Composer 会严格使用 composer.lock 文件列出来的版本来确保项目中的所有成员所安装的版本都是一致的。因此，你可以获得 composer.json 文件列出的所有文件，但是与此同时他们可能并不是最新的可用版本 (一些在 composer.lock 文件中列出的依赖可能会在这个文件创建之后释放了新的版本)。这个是设计上的，这样的设计可以确保你的项目不会因为一些依赖的改变而崩溃。

提交你的 composer.lock 文件至版本控制工具

将此文件提交至 VC 是非常重要的。因为它可以确保项目中的任何人使用的都是与你是完全一致的依赖。 你的 CI 服务器，生产服务器，团队的其他开发人员，所有人都使用的是相同的依赖项，这减轻了仅部署某些部分而引起错误的可能性。即使你独立开发，在你重新安装项目的 6 个月内，你的依赖项发布了许多新的版本，你依然可以确信你的依赖项是可用的。(请参阅下边有关使用 update 的命令。)

更新依赖到最新版本

如上所述，composer.lock 文件将阻止你自动获取最新依赖版本。如果要更新依赖到最新版本，使用 update 命令。这将获取最新匹配的版本（根据你的 composer.json 文件）并将新版本更新到 composer.lock 文件。（这相当于删除 composer.lock 文件并再次运行 install）。

php composer.phar update

注意：当执行 install 命令时，由于 composer.json 的更改可能影响到依赖解析而未更新 composer.lock ，Composer 将显示警告。

如果只是想安装或更新一个依赖，可以将它们列出来：

php composer.phar update monolog/monolog [...]

注意：对于库来说，没必要提交 composer.lock 文件，请参考：库 - 锁文件。

Packagist

Packagist 是 Composer 的主要资源库。一个 Composer 库基本上是一个包的源：一个你可以得到包的地方。

Packagist 的目标是成为一个任何人都可以使用的中央仓库。这意味着你可以 require 那里的任何包，无需指定 Composer 查找包的位置。

当你访问 Packagist 网站 (packagist.org)，你可以浏览和搜索包。

建议使用 Composer 的开源项目在 Packagist 上发布包。虽然并不一定需要发布在 Packagist 上来被 Composer 使用，但是它能被其它的开发者更快的发现和采用。

平台包

Composer 将那些已经安装在系统上，但并不是由 Composer 安装的包视为虚拟的平台包。这包括 PHP 本身、PHP 扩展和一些系统库。

php 代表使用的 PHP 版本要求，允许你应用限制，例如 ^7.1 。如果需要 64 位版本的 PHP， 你可以使用 php-64bit 进行限制。

hhvm 代表 HHVM 运行环境的版本，并且允许你应用限制 ，例如，^2.3。

ext- 允许你依赖 PHP 扩展（包括核心扩展）。通常 PHP 拓展的版本可以是不一致的，将它们的版本约束为 * 是一个不错的主意。一个 PHP 扩展包的例子是：ext-gd。

lib- 允许对 PHP 库的版本进行限制。以下可用例子： curl， iconv， icu，libxml，openssl， pcre， uuid， xsl。

你可以使用命令 show --platform 去获取你本地可用的平台包。

自动加载

为了描述包的自动加载信息， Composer 会生成一个 vendor/autoload.php 文件，你可以简单的 include 这个文件，并在无需其它额外工作的情况下就可以使用这些包所提供的类：

require __DIR__ . '/vendor/autoload.php';
$log = new Monolog\Logger('name');
$log->pushHandler(new Monolog\Handler\StreamHandler('app.log', Monolog\Logger::WARNING));
$log->addWarning('Foo');

你甚至可以在 composer.json 中添加一个 autoload 指令，来添加自己的自动加载声明

{
    "autoload": {
        "psr-4": {"Acme\\": "src/"}
    }
}

Composer 会为 Acme 命名空间注册一个 PSR-4 的自动加载.

你定义一个命名空间指向目录的映射。 在 vendor 目录同级的 src 目录将成为你项目的根目录。一个案例，文件名 src/Foo.php 需包含 AcmeFoo 类。

添加 autoload 指令之后，你必需重新运行 dump-autoload 来重新生成 vendor/autoload.php 文件。

包含此文件后也可以接收到一个 autoloader 实例，由因此您可以将 include 调用的返回值存储在变量中并添加更多名称空间，这在测试套件中将会很有用，例如：

$loader = require DIR . '/vendor/autoload.php';
$loader->addPsr4('Acme\Test\', __DIR__);

作为 PSR-4 自动加载规范的补充，Composer 也支持 PSR-0、类表、文件清单的自动加载方式。具体请查询 autoload 引用。

你也可以查阅 optimizing the autoloader 了解关于自动加载器的优化.

注意：

Composer 提供自己的加载器，但如果你不想使用那个而想自己配置加载器的话，你可以试试 include vendor/composer/autoload_*.php 这些文件所返回的关联数组来实现。

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!