如何在 Debian 11 上安装和使用 Composer
引言
Composer是PHP的一款流行的依赖管理工具,主要用于简化项目依赖项的安装和更新。Composer的工作原理是检查特定项目依赖的其他软件包,然后根据项目要求使用适当的版本进行安装。Composer还常用于基于流行的PHP框架(如Symfony和Laravel)创建新项目的引导。
在这个指南中,您将在一台 Debian 11 服务器上安装并使用 Composer。
先决条件
要按照这个教程进行操作,你需要设立一个Debian 11服务器,同时需要一个非root用户并启用sudo权限以及启用防火墙。你可以按照我们的Debian 11初始服务器设置指南来完成这个操作。
第一步 – 安装依赖项。
除了可能已包含在您的Debian 11系统中的依赖项之外,Composer还需要php-cli来在命令行中执行PHP脚本,并需要unzip来提取压缩文件。
首先更新软件包管理器的缓存。
- sudo apt update
接下来,安装依赖项。您需要使用curl来下载Composer和php-cli来安装和运行它。php-mbstring包是必需的,以提供本教程中将使用的库的功能。Composer使用git来下载项目依赖项,而unzip用于解压缩压缩包。您可以使用以下命令来安装所有内容:
- sudo apt install curl php-cli php-mbstring git unzip
所有依赖已安装完毕,现在您可以安装Composer。
步骤2 — 下载并安装Composer
Composer提供了一个用PHP编写的安装程序。您将下载它,验证其是否未损坏,然后使用它来安装Composer。
首先,确保你在你的主目录下:
- cd ~
然后,使用curl检索安装程序。
- curl -sS https://getcomposer.org/installer -o composer-setup.php
接下来,验证安装程序是否匹配Composer公钥/签名页面上最新安装程序的SHA-384哈希值。为了简化验证步骤,你可以使用以下命令以编程方式从composer页面获取最新的哈希值,并将其存储在一个shell变量中。
- HASH=`curl -sS https://composer.github.io/installer.sig`
要输出获得的值,请运行:
- echo $HASH
55ce33d7678c5a611085589f1f3ddf8b3c52d662cd01d4ba75c0ee0459970c2200a51f492d557530c71c15d8dba01eae
现在执行以下PHP代码,该代码在Composer下载页面中提供,以验证安装脚本是否可以安全运行:
- php -r “if (hash_file(‘SHA384’, ‘composer-setup.php’) === ‘$HASH‘) { echo ‘Installer verified’; } else { echo ‘Installer corrupt’; unlink(‘composer-setup.php’); } echo PHP_EOL;”
您的结果将是以下内容。
Installer verified
如果收到一条显示安装程序损坏的消息,你需要重新下载安装脚本并验证你是否使用了正确的哈希值。然后再次运行命令验证安装程序。一旦你有了经过验证的安装程序,你就可以继续进行。
要在全局安装Composer,在终端中使用以下命令下载并安装Composer,安装后将把Composer作为系统命令命名为composer,位于/usr/local/bin目录下。
- sudo php composer-setup.php –install-dir=/usr/local/bin –filename=composer
你的输出将是以下这些内容。
All settings correct for using Composer Downloading… Composer (version 2.3.10) successfully installed to: /usr/local/bin/composer Use it: php /usr/local/bin/composer
通过运行这个命令来测试你的安装。
- composer
然后,您的输出将显示Composer的版本和参数,类似于以下内容:
______ / ____/___ ____ ___ ____ ____ ________ _____ / / / __ \/ __ `__ \/ __ \/ __ \/ ___/ _ \/ ___/ / /___/ /_/ / / / / / / /_/ / /_/ (__ ) __/ / \____/\____/_/ /_/ /_/ .___/\____/____/\___/_/ /_/ Composer version 2.3.10 2022-07-13 15:48:23 Usage: command [options] [arguments] Options: -h, –help Display help for the given command. When no command is given display help for the list command -q, –quiet Do not output any message -V, –version Display this application version –ansi|–no-ansi Force (or disable –no-ansi) ANSI output -n, –no-interaction Do not ask any interactive question –profile Display timing and memory usage information –no-plugins Whether to disable plugins. –no-scripts Skips the execution of all scripts defined in composer.json file. -d, –working-dir=WORKING-DIR If specified, use the given directory as working directory. –no-cache Prevent use of the cache -v|vv|vvv, –verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug . . .
这证实Composer在您的系统上安装成功并且可以在整个系统范围内使用。
Note
要实现这一点,使用命令 php composer-setup.php。这将在当前目录中生成一个 composer.phar 文件,可以使用 ./composer.phar命令执行。
现在您已经安装了Composer,在下一步中,您将学习如何使用Composer来管理PHP依赖项。
第三步 – 在PHP项目中使用Composer
PHP项目经常依赖于外部库,管理这些依赖库及其版本可能会很棘手。Composer通过跟踪您的依赖关系并使之更易于他人安装,解决了这个问题。
为了在项目中使用Composer,您需要一个composer.json文件。composer.json文件告诉Composer需要为您的项目下载哪些依赖项,以及可安装的每个软件包的版本。这对于保持项目一致性、避免安装可能导致向后兼容性问题的不稳定版本非常重要。
你不需要手动创建这个文件,因为这样做容易出错且可能会导致语法错误。当你使用composer命令添加依赖项到你的项目时,Composer会自动生成composer.json文件。你可以通过相同的方式添加其他依赖项,无需手动编辑这个文件。
使用Composer在项目中安装依赖包的过程包括以下步骤:
- Identify what kind of library the application needs.
- Research a suitable open-source library on Packagist.org, the official package repository for Composer.
- Choose the package you want to depend on.
- Run composer require to include the dependency in the composer.json file and install the package.
你可以用演示应用程序测试一下。
这个应用的目标是将给定的句子转换为一个适用于URL的字符串,称为slug。slug通常用于将页面标题转换为URL路径,例如本教程的URL的最后一部分。
从开始菜单中进入你的用户文件夹:
- cd ~
然后创建一个目录,名为slugify。
- mkdir slugify
创建完成后,请切换到该目录。
- cd slugify
现在是时候在Packagist.org上搜索一个能够帮助生成简洁URL的软件包了。如果你在Packagist上搜索“slug”,你会得到一个类似以下的结果。
列表中的每个软件包右侧会显示两个数字。箭头向下的图标旁边的数字表示该软件包被安装的次数,星星图标旁边的数字表示该软件包在 GitHub 上被标星的次数。您也可以根据这些数字重新排序搜索结果。一般来说,安装次数和标星次数更多的软件包更加稳定,因为有很多人在使用。同时,检查软件包描述也很重要,以确保它符合您的需求。
为了这个教程,你需要一个字符串转换成slug的工具。从搜索结果来看,cocur/slugify这个包是一个很好的选择,安装量和星级评价都相当合理。
Packagist上的软件包具有供应商名称和软件包名称。每个软件包都有一个唯一的标识符(命名空间),格式与GitHub用于其代码库的格式相同,为供应商/软件包。您想要安装的库使用命名空间cocur/slugify。您需要命名空间以便在您的项目中要求该软件包。
现在你知道要安装的包,运行composer require来包含它作为一个依赖,并生成项目的composer.json文件。
- composer require cocur/slugify
当Composer下载完依赖项时,你的输出将返回以下内容。
Using version ^4.1 for cocur/slugify ./composer.json has been created Running composer update cocur/slugify Loading composer repositories with package information Updating dependencies Lock file operations: 1 install, 0 updates, 0 removals – Locking cocur/slugify (v4.1.0) Writing lock file Installing dependencies from lock file (including require-dev) Package operations: 1 install, 0 updates, 0 removals – Downloading cocur/slugify (v4.1.0) – Installing cocur/slugify (v4.1.0): Extracting archive Generating autoload files
根据此输出,Composer会自动决定要使用的软件包版本。如果您现在检查项目目录,将会包含两个新文件:composer.json和composer.lock,以及一个vendor目录。
- ls -l
total 12 -rw-r–r– 1 sammy sammy 59 Aug 2 22:19 composer.json -rw-r–r– 1 sammy sammy 3462 Aug 2 22:19 composer.lock drwxr-xr-x 4 sammy sammy 4096 Aug 2 22:19 vendor
composer.lock文件是用于存储每个安装的软件包版本信息的。它还确保当有人克隆您的项目并安装其依赖项时,使用的是相同的版本。供应商目录是项目依赖项的位置。供应商文件夹不需要提交到版本控制中,您只需要包含composer.json和composer.lock文件就可以了。
Note
接下来,审查版本约束。如果您检查composer.json文件的内容,您会看到如下所示的内容:
- cat composer.json
{ “require”: { “cocur/slugify”: “^4.1” } }
你可能会注意到composer.json文件中版本号前面的特殊字符^。Composer支持多种不同的约束和格式来定义所需的软件包版本,以提供灵活性同时保持项目稳定性。自动生成的composer.json文件中使用的^操作符是推荐的操作符,以实现最大的互操作性,遵循语义化版本控制。在这种情况下,它将4.1定义为最低兼容版本,并允许更新到未来版本的任何版本,但不超过5.0。
通常情况下,您不需要修改composer.json文件中的版本约束。然而,在某些情况下,您可能需要手动编辑约束。例如,当所需库的一个重大版本发布并且您想要升级时,或者您想要使用的库不遵循语义化版本控制。
这里有一些例子,可以让你更好地理解Composer版本限制的工作原理:
Constraint | Meaning | Example Versions Allowed |
---|---|---|
^1.0 | >= 1.0 < 2.0 | 1.0, 1.2.3, 1.9.9 |
^1.1.0 | >= 1.1.0 < 2.0 | 1.1.0, 1.5.6, 1.9.9 |
~1.0 | >= 1.0 < 2.0.0 | 1.0, 1.4.1, 1.9.9 |
~1.0.0 | >= 1.0.0 < 1.1 | 1.0.0, 1.0.4, 1.0.9 |
1.2.1 | 1.2.1 | 1.2.1 |
1.* | >= 1.0 < 2.0 | 1.0.0, 1.4.5, 1.9.9 |
1.2.* | >= 1.2 < 1.3 | 1.2.0, 1.2.3, 1.2.9 |
要对Composer版本约束有更深入的了解,请查阅官方文档。
接下来,您将学习如何使用Composer自动加载依赖项。
第四步 – 包括自动加载脚本
由于PHP本身不会自动加载类,Composer提供了一个 autoload 脚本,你可以将其包含在项目中,以使自动加载正常工作。这有助于在处理依赖关系时使用。
只需要在您的PHP脚本中在任何类实例化之前包含vendor/autoload.php文件即可。当您添加第一个依赖项时,Composer会自动生成这个文件。
您可以在您的应用程序中测试它。创建test.php文件,并在您喜欢的文本编辑器中打开它。这里使用的是nano。
- nano test.php
将以下代码添加到项目中,引入vendor/autoload.php文件,加载cocur/slugify依赖项,并创建slug。
<?php
require __DIR__ . '/vendor/autoload.php';
use Cocur\Slugify\Slugify;
$slugify = new Slugify();
echo $slugify->slugify('Hello World, this is a long sentence and I need to make a slug from it!');
存储文件并退出编辑器。如果你正在使用nano编辑器,可以通过按下CTRL + X,然后按Y和回车键来实现。
现在运行脚本。 .)
- php test.php
这将产生以下输出:
hello-world-this-is-a-long-sentence-and-i-need-to-make-a-slug-from-it
当新版本出来时,依赖需要更新,所以你将在最后一步学习如何处理它们。
步骤5 — 更新项目依赖
当你想要将项目依赖更新到更新的版本时,请运行更新命令。
- composer update
这将检查您在项目中添加为要求的库的较新版本。如果找到一个较新的版本,并且它与composer.json文件中定义的版本限制兼容,Composer将替换之前安装的版本。composer.lock文件将被更新以反映这些更改。
您还可以通过以下方式指定更新一个或多个特定的库:
- composer update vendor/package vendor2/package2
更新依赖后,务必将更改提交到你的 composer.json 和 composer.lock 文件中,这样项目中的其他人才能得到相同的软件包版本。
結論
Composer是每个PHP开发者都应该拥有的强大工具。在本教程中,你在Debian 11上安装了Composer并将其用于一个项目中。现在你知道如何安装和更新依赖项了。
除了提供一种可靠的管理项目依赖关系的方法外,Composer 还为共享和发现社区创建的 PHP 包建立了新的标准。