Composer - это популярный менеджер зависимостей PHP, который упрощает процесс установки и обновления зависимостей проекта. Он проверяет, от каких прочих пакетов зависит конкретный проект, а затем устанавливает все необходимые версии пакетов в соответствии с требованиями. Composer также часто используется для загрузки новых проектов на основе популярных инфраструктур PHP, таких как Symfony и Laravel.
Шаг 1 - Установка PHP и необходимых зависимостей
В дополнение к зависимостям, уже входящим в комплект системы Ubuntu 20.04, таким как git и curl, Composer требует php-cli для выполнения скриптов PHP в командной строке и unzip для распаковки архивов. Сейчас мы установим эти зависимости. Во-первых, необходимо обновить кэш менеджера пакетов:
sudo apt update
Запустите следующую команду для установки требуемых пакетов:
sudo apt install php-cli unzip
Для подтверждения установки введите Y и нажмите ENTER. После установки обязательных компонентов можно переходить к установке Composer.
Шаг 2 - Загрузка и установка Composer
Composer предоставляет написанный на PHP скрипт installer. Мы должны загрузить его, убедиться, что он не поврежден, а затем использовать его для установки Composer. Убедитесь, что вы находитесь в домашней директории, а затем загрузите установщик с помощью curl:
cd ~ curl -sS https://getcomposer.org/installer -o composer-setup.php
Далее мы убедимся, что хэш установщика совпадает с хэшем SHA-384 для последней версии установщика на странице Composer Public Keys / Signatures. Чтобы упростить проверку, вы можете использовать следующую команду для программного получения последней версии хэша со страницы Composer и ее сохранения в переменной оболочки:
HASH=`curl -sS https://composer.github.io/installer.sig`
Для проверки полученного значения можно использовать следующую команду:
echo $HASH
Теперь выполните следующий код 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
Если вы увидите сообщение Installer corrupt, вам нужно повторно загрузить скрипт установки и еще раз убедиться, что вы используете правильный хэш. Затем повторите процедуру проверки. После успешной проверки установщика вы можете продолжить.
Чтобы выполнить глобальную установку composer, используйте следующую команду, которая выполнит загрузку и установку Composer в качестве общесистемной команды composer в каталоге /usr/local/bin:
Вывод будет выглядеть следующим образом:
All settings correct for using Composer Downloading... Composer (version 2.2.5) successfully installed to: /usr/local/bin/composer Use it: php /usr/local/bin/composer
Чтобы протестировать установку, запустите команду:
composer
Это подтверждает, что диспетчер зависимостей Composer был успешно установлен и доступен в рамках всей системы.
Шаг 3 - Использование Composer в проекте PHP
PHP проекты часто зависят от внешних библиотек, и управление этими зависимостями и их версиями может вызывать затруднения. Composer решает эту проблему посредством отслеживания версий и зависимостей проектов, а также упрощает процесс поиска, установки и обновления пакетов, требуемых для проекта.
Чтобы использовать Composer в вашем проекте, вам потребуется файл composer.json. Файл composer.json указывает Composer, какие зависимости для вашего проекта нужно загрузить, а также какие версии каждого пакета можно использовать. Это очень важно для сохранения последовательности вашего проекта и отказа от установки нестабильных версий, которые могут вызывать проблемы с обратной совместимостью.
Вам не нужно создавать этот файл вручную, потому что при этом можно легко допустить ошибку в синтаксисе. Composer предлагает интерактивный способ создания нового файла composer.json на основе ввода пользователя. Этот вариант будет полезным, если вы захотите опубликовать свой проект как общедоступный пакет в Packagist. Также Composer автоматически генерирует чистый файл composer.json при запуске команды composer require для добавления зависимости в новом проекте.
Использование Composer для установки пакета в качестве зависимости в проект подразумевает следующие шаги:
Давайте попробуем сделать это на примере демо-приложения.
Приложение преобразует указанное предложение в понятную человеку часть URL-адреса (slug). Как правило, подобные приложения используются для преобразования названия страницы в URL-адрес. Начнем с создания директории для нашего проекта. Мы назовем его slugify.
cd ~ mkdir slugify cd slugify
Хотя это не требуется, вы можете запустить команду composer init для создания детального файла composer.json для вашего проекта. Поскольку единственная цель нашего проекта - продемонстрировать установку зависимостей на Composer, мы используем более простой файл composer.json, который будет сгенерирован автоматически, когда нам потребуется наш первый пакет. Теперь нужно найти на Packagist.org пакет, который поможет нам генерировать понятные человеку части URL-адреса.
Вы увидите два числа с правой стороны каждого пакета в списке. Число сверху указывает на количество установок пакета через Composer, а число внизу показывает, какие оценки пакету ставили на GitHub. Как правило, пакеты с большим количеством установок и большим количеством звезд более стабильны, потому что многие люди их используют. Также важно проверить описание пакета на соответствие тому, что вам нужно.
Нам нужен конвертер из строки в понятную человеку часть URL-адреса. Среди результатов поиска хорошо подходит пакет cocur/slugify, для которого указано существенное количество установок и звезд.
Пакеты на Packagist имеют имя автора и имя пакета. Каждый пакет имеет уникальный идентификатор (пространство имен) в том же формате, который использует GitHub для своих репозиториев: vendor/package. Библиотека, которую мы хотим установить, использует пространство имен cocur/slugify. Для ее указания в вашем проекте требуется пространство имен пакета.
Теперь, когда вы знаете, какой пакет хотите установить, запустите composer require, чтобы добавить его в качестве зависимости, а также сгенерировать файл composer.json для вашего проекта. При запросе пакетов важно учитывать, что Composer отслеживает как зависимости на уровне приложений, так и зависимости на уровне системы. Зависимости на уровне системы важны, чтобы показать, на какие модули PHP полагается пакет. Для пакета cocur/slugify требуется модуль PHP, который мы еще не установили.
Если требуемый пакет использует системную библиотеку, которая еще не установлена на вашем сервере, вы получите сообщение об ошибке с указанием невыполненного требования:
composer require cocur/slugify
Как видите, Composer автоматически определил, какую версию пакета использовать. Если вы сейчас проверите каталог вашего проекта, он будет содержать два новых файла: composer.json и composer.lock, а также каталог vendor.
Файл composer.lock используется для хранения информации о том, какие версии каждого пакета установлены, а также для использования одних и тех же версий пакетов, если кто-либо будет клонировать ваш проект и устанавливать зависимости. Каталог vendor служит местом расположения зависимостей проекта. Папка vendor не обязательно должна использоваться для контроля версий, в нее следует поместить только файлы composer.json и composer.lock.
При установке проекта, который уже содержит файл composer.json, запустите composer install, чтобы загрузить зависимости проекта.
Давайте быстро пробежимся по ограничениям версии. Если вы просмотрите содержимое файла composer.json, то увидите следующее:
cat composer.json
{
"require": {
"cocur/slugify": "^4.1"
}
}
Вы можете заметить специальный символ ^ перед номером версии в файле composer.json. Composer поддерживает несколько ограничений и форматов для определения требуемой версии пакета, чтобы обеспечить гибкость и одновременно сохранить стабильность вашего проекта. Оператор карет (^), используемый в автоматически генерируемом файле composer.json, рекомендуется применять для обеспечения максимальной совместимости в соответствии с семантическим управлением версиями. В данном случае он определяет 4.1 в качестве минимальной совместимой версии и позволяет обновляться до любой будущей версии ниже 5.0.
Как правило, вам не нужно изменять ограничения версии в файле composer.json. Однако в некоторых ситуациях может потребоваться вручную отредактировать ограничения для экземпляра, например, при выходе крупного обновления требуемой библиотеки, а также в случае, когда библиотека, которую вы хотите использовать, не соответствует требованиям семантического управления версиями.
Ниже представлены примеры, которые помогут лучше понять, как работают ограничения версии в Composer:
Ограничение Значение Пример допустимых версий ^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.
Шаг 4 - Включение скрипта автозагрузки
Поскольку PHP не загружает классы автоматически, Composer предоставляет скрипт автозагрузки, который можно включить в ваш проект, чтобы использовать в нем автозагрузку. Composer автоматически генерирует этот файл при добавлении первой зависимости. Вам нужно будет только включить файл vendor/autoload.php в скрипты PHP перед созданием экземпляра любого класса.
Протестируем его в нашем демонстрационном приложении. Откройте в текстовом редакторе новый файл с именем test.php:
nano test.php
Добавьте следующий код, который будет подключать файл vendor/autoload.php, загружать зависимость cocur/slugify и использовать ее для создания понятной человеку части URL-адреса:
<?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!');
Сохраните файл и закройте редактор.
Запустите скрипт:
php test.php
Вы должны получить вывод:
hello-world-this-is-a-long-sentence-and-i-need-to-make-a-slug-from-it
Зависимости нуждаются в обновлениях при выходе новых версий, так что давайте рассмотрим, как решить эту проблему.
Шаг 5 - Обновление зависимостей проекта
Если вам нужно обновить зависимости проекта на более поздние версии, запустите команду update:
composer update
Она будет проверять новые версии библиотек, которые требуются вам в вашем проекте. Если будет найдена новая версия, которая совместима с ограничением версии, определенным в файле composer.json, Composer заменит ранее установленную версию на новую. Файл composer.lock будет обновлен, чтобы отразить эти изменения.
Вы также можете обновить одну или несколько конкретных библиотек, указав их следующим образом:
composer update vendor/package vendor2/package2
Обязательно зарегистрируйте файлы composer.json и composer.lock в системе контроля версий после обновления зависимостей, чтобы другие тоже могли установить обновленные версии.