XDebugでPHPプロジェクトをデバッグする

XDebugは、PHP開発において強力なデバッグ機能やパフォーマンス解析、コードカバレッジを提供する拡張モジュールです。ServBayのローカル開発環境にXDebugを統合することで、PHPプロジェクトの開発効率やコード品質を大幅に向上させることができます。XDebugを使えば、コード上でブレークポイントを設定したり、変数値を確認したり、関数のコールスタックを追跡したり、パフォーマンスボトルネックを解析するなど、トラブルシューティングをより効果的・効率的に行うことができます。

XDebugとは

XDebugはPHP専用に設計された拡張機能で、強力なデバッグと解析能力を提供します。DBGpプロトコルを用いたリモートデバッグ、ブレークポイント設定、ステップ実行、変数ウォッチ、コールスタックの追跡、スクリプトパフォーマンスのプロファイリング、カバレッジレポートの生成などに対応しています。XDebugを活用することで、コードの実行フローや状態を深く把握し、問題点の特定や解決までをスムーズに実施できます。

XDebugにはいくつかの動作モードがありますが、最も一般的なのが対話的なブレークポイントデバッグを実現するdebugモードです。

ServBayでXDebugを有効化・設定する

ServBayには対応するPHPバージョンごとにXDebug拡張があらかじめプリインストールされています。手動でダウンロードやビルドを行う必要はありません。

XDebugモジュールの有効化: ServBayアプリの画面を開き、言語 - PHPに進み、XDebugを有効化したいPHPバージョンを選択します。「拡張機能」からxdebugモジュールを見つけて「有効」になっていることを確認してください。有効になっていなければクリックして有効化します。XDebugを有効化した後はPHP-FPMサービスの再起動が必要となる場合があります（多くの場合、ServBayが自動で処理します）。
IDEの設定: お使いの統合開発環境（例：PHPStormやVS Code）でXDebug接続を設定します。通常、XDebugのリッスンポートの指定（ServBayのUIで設定したXDebugのポートと一致させる）や、場合によってはリモートパスのマッピングも行います（ただし、ServBayのローカル環境であれば通常はマッピング不要です）。
IDE設定の詳細はこちら
各種IDE（PHPStorm、VS Codeなど）でのXDebug設定については、該当IDEの公式ドキュメントやServBay付属Xdebugモジュールの有効化方法をご参照ください。

実践：ServBayでPHPプロジェクトをデバッグする

シンプルなサンプルプロジェクトを使って、ServBayでXDebugを活用したデバッグ方法を説明します。

1. ServBayサイトの用意

まず、サンプルプロジェクトを配置するためにServBay上に新しいウェブサイトを作成します。

ServBayのウェブサイトルートディレクトリ /Applications/ServBay/www/ の下に、servbay-xdebug-app といった新しいプロジェクトフォルダを作成します。
ServBayアプリを開き、「サイト」セクションに進みます。
新しいサイトを追加し、サイトルートを /Applications/ServBay/www/servbay-xdebug-app に指定します。
ローカルホスト名（例： servbay-xdebug-app.servbay.demo ）を割り当てます。
利用するPHPバージョンを設定し、前述の手順に従ってXDebugが有効・設定済みであることを確認します。
保存して設定を反映します。ServBayが自動的にCaddy/Nginxやhostsファイル（またはServBayのDNSサービス）を更新します。

2. サンプルプロジェクトの構造とコード

/Applications/ServBay/www/servbay-xdebug-app/ ディレクトリ内に以下のファイルとフォルダを作成します。

servbay-xdebug-app/
├── src/
│   └── Calculator.php
└── index.php

src/Calculator.php の内容は次の通りです。

php

<?php
namespace App;

class Calculator
{
    public function add($a, $b)
    {
        // この行にブレークポイントを設定
        return $a + $b;
    }

    public function subtract($a, $b)
    {
        return $a - $b;
    }
}

index.php の内容は次の通りです。

php

<?php
// Composerを利用している場合は、オートローダーを読み込む
// Composerを利用していなければ、この部分を実際の状況に合わせて変更してください
require __DIR__ . '/vendor/autoload.php';

use App\Calculator;

echo "Debugging Example:\n";

$calculator = new Calculator();
$num1 = 5;
$num2 = 3;

$sum = $calculator->add($num1, $num2);
$difference = $calculator->subtract($num1, $num2);

echo "Sum: " . $sum . "\n";
echo "Difference: " . $difference . "\n";

echo "Done.\n";
?>

注意: 上記の require __DIR__ . '/vendor/autoload.php'; はComposer利用を想定しています。簡単な動作検証のみの場合はこの行を削除し、use App\Calculator; を require __DIR__ . '/src/Calculator.php'; に置き換えてください。

3. ブレークポイントの設定

IDE（例：PHPStorm）で /Applications/ServBay/www/servbay-xdebug-app/src/Calculator.php を開き、add メソッド内の return $a + $b; 行の行番号付近をクリックしてブレークポイントを打ちます。

4. デバッグセッションの開始

IDE上でXDebug接続のリッスン（監視）を開始します。PHPStormの場合、上部ツールバーの「Start Listening for PHP Debug Connections」ボタン（電話の受話器や虫眼鏡のアイコン）をクリックします。
ブラウザで、ServBayの該当サイトの index.php （例： https://servbay-xdebug-app.servbay.demo/index.php ）にアクセスします。
xdebug.start_with_request が trigger に設定されている場合、ブラウザ拡張やパラメータでXDebugトリガーを付与する必要があります（例： https://servbay-xdebug-app.servbay.demo/index.php?XDEBUG_TRIGGER=1 にアクセス）。

5. デバッグの流れ

ブラウザから index.php へのリクエストをトリガーすると、XDebugが自動的にIDEと接続し、設定したブレークポイントでコード実行が一時停止します。
IDEがデバッグビュー（ウィンドウ）に切り替わり、Calculator.php の add メソッド内でコードが止まっている状態が表示されます。

6. 変数値の確認

IDEのデバッグウィンドウで、現在実行中のコード行やコールスタック、変数リストなどが確認できます。
「Variables」パネルで、現在のスコープ内での各変数値が確認できます（例：$a=5、$b=3 など）。

7. ステップ実行

IDEのステップ実行ボタン（通常は Step Over (F8)、Step Into (F7)、Step Out (Shift+F8)）で操作します。
- Step Over：現在の行を実行し、関数呼び出しがあってもそのまま通過し、次の行に移ります。
- Step Into：関数呼び出し行の場合、その関数内部の1行目に入っていきます。
- Step Out：現在の関数の残りを全て実行し、呼び出し元に戻ります。
ステップ実行を使うことで、コードの実行フローや変数値の変化を一行ずつ追うことができます。

8. 続行実行

IDEの「プログラムの再開（Resume Program）」ボタン（通常は緑色の再生アイコンやF9キー）をクリックすると、処理が再開され、次のブレークポイントまたはプログラム終了まで進みます。

9. 出力結果の確認

実行が完了したら、ブラウザ（もしくはCLIデバッグの場合はターミナル）で出力をチェックします。今回の例では、以下の出力が得られるはずです。
text
```
Debugging Example:
Sum: 8
Difference: 2
Done.
```
1
2
3
4

注意点

ファイアウォール: OSのファイアウォールで、IDEが監視するポート（デフォルトは9003）がブロックされていないことを確認しましょう。
ポート競合: XDebug用に設定したポートが他のアプリケーションで使用されていないか確認してください。
パフォーマンスへの影響: xdebug.mode=debug かつ xdebug.start_with_request=yes の場合、全てのPHPリクエストでデバッグが動作し、サイトのパフォーマンスに大きな影響があります。デバッグが不要な場合はXDebugを無効化、もしくは xdebug.start_with_request を trigger に設定することを推奨します。
CLIスクリプトのデバッグ: XDebugはPHP CLIスクリプトのデバッグにも対応しています。コマンドラインで環境変数を設定したり、引数でトリガーする方法など、詳しくはXDebugの公式ドキュメントを参照してください。
IDEのバージョン・設定: IDEによって設定画面や手順が異なる場合があります。各IDEの公式ドキュメントもあわせて確認しましょう。

よくある質問 (FAQ)

Q: IDEがXDebugに接続できません。どうしたら良いですか？

A: 以下の点をご確認ください。

ServBayで対象PHPバージョンのXDebugモジュールが有効になっているか。
php.ini の xdebug.mode、xdebug.client_host、xdebug.client_port の各設定が正しく、IDEで設定したポート・ホストと一致しているか。
xdebug.start_with_request = trigger を使っている場合、GET/POSTパラメータやCookie、Headerによるトリガーが正しく送信されているか。
OSのファイアウォールがXDebugのポート通信を許可しているか。
IDE側で該当ポートのリッスンが有効になっているか。

Q: XDebugを有効化するとサイトが遅くなるのはなぜ？

A: xdebug.start_with_request が yes になっている場合、全てのリクエストでデバッグを開始しようとするため、負荷がかかり動作が遅くなります。手動で必要なときのみデバッグを行いたい場合は trigger に設定してください。

Q: XDebugでAJAXリクエストのデバッグは可能ですか？

A: 可能です。AJAXリクエストも通常のHTTPリクエストと同じく、XDebugトリガー（CookieやHeaderで付与）を含めることでデバッグができます。

Q: PHPStorm以外にもVS Codeなど他のIDEでServBayのXDebugは使えますか？

A: はい。ServBayのXDebugは標準PHP拡張であり、DBGpデバッグプロトコル対応のIDEやエディタ（VS Code＋PHP Debug拡張、NetBeans、Eclipseなど）なら利用可能です。設定手順も基本的に同様で、各IDEでリッスンポートを指定してください。

まとめ

ServBayにプリインストールされたXDebugを活用すれば、PHPプロジェクトのローカルデバッグが圧倒的に効率化されます。ブレークポイントや変数ウォッチ、ステップ実行などのデバッグ基礎技術を習得することで、問題特定や解決能力が大きく向上し、結果としてコード品質も高まります。ServBayの便利な環境管理機能と合わせて、XDebugはPHP開発ワークフローの頼もしいパートナーとなるでしょう。この機会に、ServBay環境でXDebugを活用し、より快適で効率的なPHP開発を体験してみてください！

XDebugでPHPプロジェクトをデバッグする ​

XDebugとは ​

ServBayでXDebugを有効化・設定する ​

実践：ServBayでPHPプロジェクトをデバッグする ​

1. ServBayサイトの用意 ​

2. サンプルプロジェクトの構造とコード ​

3. ブレークポイントの設定 ​

4. デバッグセッションの開始 ​

5. デバッグの流れ ​

6. 変数値の確認 ​

7. ステップ実行 ​

8. 続行実行 ​

9. 出力結果の確認 ​

注意点 ​

よくある質問 (FAQ) ​

まとめ ​