[PHPのはじめ方] Part29: Composerによる依存管理

こんにちは！PHPの学習、順調に進んでいますか？😊 これまでPHPの基本的な文法やデータベース操作などを学んできましたね。 今回は、PHP開発をさらに効率化するための強力なツール、「Composer」について学びましょう！

Composerは、PHPプロジェクトで利用する外部のライブラリ（パッケージとも呼ばれます）を管理するためのツールです。 例えば、「この機能、便利なライブラリがないかな？」と思ったときに、Composerを使えば簡単にライブラリを探して、自分のプロジェクトに追加・管理することができます。

ライブラリを使うと、自分で一からコードを書かなくても、高度な機能を簡単に実装できるようになります。 しかし、たくさんのライブラリを使うようになると、どのライブラリがどのバージョンに依存しているかなどを手動で管理するのは大変です。💦 Composerは、このような「依存関係」を自動で解決してくれる、まさにPHP開発の救世主なんです！

この章では、以下の内容を学びます。

• Composerのインストール方法
• Composerの基本的な使い方（ライブラリの追加、更新）
• オートローディングの仕組み

Composerをマスターして、モダンなPHP開発の世界へ飛び込みましょう！🚀

Composerを使うためには、まずお使いのコンピュータにComposerをインストールする必要があります。 インストールは、OS（Windows, macOS, Linux）ごとに少し手順が異なりますが、基本的にはComposer公式サイトからインストーラーをダウンロードして実行します。

注意： Composerを実行するには、PHP本体が事前にインストールされている必要があります。まだPHPをインストールしていない場合は、先にインストールを済ませてください。（Step 1の内容を参考にしてくださいね！）

brew install composer

# インストーラーをダウンロード
php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"

# インストーラーの正当性を検証 (ハッシュ値は公式サイトで確認してください)
php -r "if (hash_file('sha384', 'composer-setup.php') === 'edb40769019ccf227279e3bdd1f5b2e9950eb000c3233ee85148944e555d97be3ea4f40c3c2fe73b22f875385f6a5155') { echo 'Installer verified'; } else { echo 'Installer corrupt'; unlink('composer-setup.php'); } echo PHP_EOL;"

# インストーラーを実行
php composer-setup.php

# インストーラーを削除
php -r "unlink('composer-setup.php');"

# composer.phar をパスの通ったディレクトリに移動して、どこからでも使えるようにする
sudo mv composer.phar /usr/local/bin/composer

composer --version

Composerのインストールが完了したら、早速基本的な使い方を見ていきましょう！

1. `composer.json` ファイル

Composerを使うプロジェクトでは、まずプロジェクトのルートディレクトリ（一番上の階層）に composer.json というファイルを作成します。 このファイルは、プロジェクトがどのライブラリに依存しているか（どのライブラリを使っているか）を定義するための、いわば「設計図」のようなものです。

最初は空のファイルでも良いですが、手動で作成する代わりに、後述する composer require コマンドを使うと自動で生成・更新されます。

{
    "require": {

    }
}

require の中に、使用したいライブラリ名とそのバージョンを記述していきます。

2. ライブラリの追加 (`composer require`)

プロジェクトに新しいライブラリを追加したい場合、composer require コマンドを使います。 ターミナル（またはコマンドプロンプト）で、プロジェクトのルートディレクトリに移動し、以下の形式でコマンドを実行します。

composer require ベンダー名/パッケージ名

例えば、PHPで人気のロギングライブラリである「Monolog」を追加してみましょう。

composer require monolog/monolog

このコマンドを実行すると、Composerは以下の処理を自動で行います。

1. Packagist（Composerの公式パッケージリポジトリ）で monolog/monolog を探し、最新の安定バージョンを確認します。
2. composer.json ファイルに "monolog/monolog": "^バージョン番号" のような行を追加（または更新）します。
3. Monologが必要とする他のライブラリ（依存ライブラリ）があれば、それらも自動で特定します。
4. 必要なライブラリ群をダウンロードし、プロジェクトルートに作成される vendor ディレクトリ内に配置します。
5. 実際にインストールされたライブラリとその正確なバージョン情報を composer.lock ファイルに記録します。

3. 依存関係のインストール (`composer install`)

composer.json ファイルや composer.lock ファイルが既にあるプロジェクト（例えば、他の人が作成したプロジェクトをGitからクローンした場合など）で、必要なライブラリをインストールするには composer install コマンドを使います。

composer install

このコマンドは、composer.lock ファイルが存在する場合はその内容に基づいて、存在しない場合は composer.json ファイルに基づいて、必要なライブラリを vendor ディレクトリにインストールします。 チーム開発で環境を統一する際に非常に重要です。

4. ライブラリの更新 (`composer update`)

インストール済みのライブラリを、composer.json で指定されたバージョン制約の範囲内で最新版に更新したい場合は、composer update コマンドを使います。

composer update

特定のライブラリだけを更新したい場合は、パッケージ名を指定します。

composer update monolog/monolog

update コマンドを実行すると、composer.lock ファイルも更新されます。

5. オートローディング (`vendor/autoload.php`)

Composerでインストールしたライブラリを使うには、通常、たくさんの require 文を書く必要がありますが、Composerはその手間も省いてくれます！ vendor ディレクトリの中に autoload.php というファイルが自動生成されており、このファイルを1行だけ読み込むだけで、インストールしたライブラリのクラスをPHPが自動で見つけられるようになります（オートロード）。

使い方は簡単で、PHPスクリプトの最初に以下のコードを追加するだけです。

<?php

// vendor/autoload.php を読み込む
require __DIR__ . '/vendor/autoload.php';

// これで、インストールしたライブラリのクラスが使えるようになる！
// 例: Monolog を使う場合
use Monolog\Logger;
use Monolog\Handler\StreamHandler;

// ロガーを作成
$log = new Logger('mylogger');
$log->pushHandler(new StreamHandler('path/to/your.log', Logger::WARNING));

// ログを出力
$log->warning('これは警告ログです。');
$log->error('これはエラーログです。');

echo 'ログが出力されました！';

?>

require __DIR__ . '/vendor/autoload.php'; の一行だけで、Monolog\Logger や Monolog\Handler\StreamHandler といったクラスが自動的に読み込まれるようになります。とても便利ですね！✨

自分の作成したクラスもオートロードの対象にしたい場合は、`composer.json`に`autoload`セクションを追加し、名前空間とディレクトリの対応を定義します。

{
    "require": {
        "monolog/monolog": "^3.5"
    },
    "autoload": {
        "psr-4": {
            "MyApp\\": "src/"
        }
    }
}

上記のように設定した後、`composer dump-autoload` コマンドを実行すると、`src/` ディレクトリ以下のクラスが `MyApp` という名前空間でオートロードされるようになります。

composer dump-autoload

composer.json ファイルには、require 以外にもプロジェクトに関する様々な情報を記述できます。 主要なキーとその役割をいくつか見てみましょう。

バージョン制約の指定方法

require や require-dev でライブラリを指定する際には、バージョンも指定します。 特定のバージョンを固定するのではなく、ある程度の範囲を指定することで、互換性を保ちつつ新しい機能やバグ修正を取り込むことができます。 よく使われるバージョン制約の記号には以下のようなものがあります。

一般的には、後方互換性を維持しつつ新しい機能や修正を取り込める ^ (キャレット) を使うことが推奨されています。 これにより、意図しない大きな変更（メジャーバージョンアップ）による互換性の問題を避けやすくなります。