【後編】XDebugを利用してPHPのデバッグを行う【XAMPP + VS Code】｜ブログ

はじめに 【前編】ではXDebugのインストールとPHPでの設定を行いました。 【後編】ではXDebugをVSCode上で利用するための方法を解説したいと思います。 前編についてはこちらを参照ください。 > 【前編】XDebugを利用してPHPのデバッグを行う【XAMPP + VS Code】 /blog/phpxdebug1/ VS Code に「PHP Debug」をインストール VS Code で XDebug を利用して PHP をデバッグするには、まず「PHP Debug」という拡張機能をインストールする必要があります。 早速 VS Code で「PHP Debug」をインストールしてみましょう。 １．VS Code で「拡張機能」のアイコンをクリックします。 ２．検索バーに「PHP Debug」と入力します。 ３．「PHP Debug」の拡張機能から「インストール」をクリックします。 同じ名前の拡張機能がありますが、ダウンロード数（13Mや426Kと表示されている部分）の一番多いものを選んでください。 PHP Debug の設定を行う 先ほど XDebug を使って PHP のデバッグを行うための拡張機能である「PHP Debug」をインストールしました。 続いて、その「PHP Debug」の設定を行っていきます。 プロジェクトの作成 「PHP Debug」の設定は、作成した PHP のプロジェクトごとに設定が可能です。設定ファイルもそのプロジェクトのフォルダに生成されるので、まずは PHP のプロジェクトを作成しそれを VS Code で開いてみましょう。 今回は XAMPP の htdocs フォルダに「phpdebug」というフォルダを作成し、その中に「index.php」が存在するという単純なプロジェクトを作り、進めていきます。 launch.json を作成する プロジェクトのフォルダが出来たら、早速「PHP Debug」の設定ファイルを作成しましょう。 １．VS Code で「実行とデバッグ」のアイコンをクリックします。 ２．メニューに表示される「launch.jsonファイルを作成します。」をクリックします。 クリックした時点で自動でファイルが作成されるはずです。 このように 「.vscode」フォルダが作成され、その中に「launch.json」が出来ているはずです。 launch.json の編集 では、作成された「launch.json」ファイルを編集して「PHP Debug」の設定を行いましょう。 「launch.json」ファイルを開きます。 json { // IntelliSense を使用して利用可能な属性を学べます。 // 既存の属性の説明をホバーして表示します。 // 詳細情報は次を確認してください: https://go.microsoft.com/fwlink/?linkid=830387 "version": "0.2.0", "configurations": [ { "name": "Listen for Xdebug", "type": "php", "request": "launch", "port": 9003 }, { "name": "Launch currently open script", "type": "php", "request": "launch", "program": "${file}", "cwd": "${fileDirname}", "port": 0, "runtimeArgs": [ "-dxdebug.startwithrequest=yes" ], "env": { "XDEBUGMODE": "debug,develop", "XDEBUGCONFIG": "clientport=${port}" } }, { "name": "Launch Built-in web server", "type": "php", "request": "launch", "runtimeArgs": [ "-dxdebug.mode=debug", "-dxdebug.startwithrequest=yes", "-S", "localhost:0" ], "program": "", "cwd": "${workspaceRoot}", "port": 9003, "serverReadyAction": { "pattern": "Development Server \$http://localhost:([0-9]+)\$ started", "uriFormat": "http://localhost:%s", "action": "openExternally" } } ] } 結構な記述量がありますが、XAMPP などのローカルサーバーで PHP Debug を行うのであれば、殆どの記述が不要になります。不要な部分を削除したものは次のようになります。 必要な設定は一番上にある設定だけになります。 json { // IntelliSense を使用して利用可能な属性を学べます。 // 既存の属性の説明をホバーして表示します。 // 詳細情報は次を確認してください: https://go.microsoft.com/fwlink/?linkid=830387 "version": "0.2.0", "configurations": [ { "name": "Listen for Xdebug", "type": "php", "request": "launch", "port": 9003 } ] } name： デバッグの設定名になります。自由につけていただいて問題ありません。 type ： 今回は PHP のデバッグを行うので “php” と設定 request： デフォルト（launch）のまま。 port： XDebug で利用しているポート番号を指定します。XDebug はデフォルトは9003を利用するので “9003” を指定しましょう。もし設定を変更していれば合わせて変更する必要があります。 これで VS Code で XDebug を利用して PHP のデバッグを行う準備が整いました。 VS Code でデバッグを行う 実際に VS Code で PHP のデバッグをしていきましょう。 まず先ほど作成したプロジェクトにある「index.php」を以下のように編集しましょう。 php <?php phpinfo(); 【前編】にもありました PHP の情報を表示するための記述を追加しました。 これで「http://localhost/phpdebug」にアクセスすると画面には PHP の情報が表示されているかと思います。 では PHP Debug を動かします。 １．VS Code で「実行とデバッグ」のアイコンをクリックします。 「launch.json」が作成されていると、先ほどと表示が異なるはずです。 ２．「Listen for XDebug」の左にある をクリックします。 「Listen for XDebug」と表示されている部分は「launch.json」ファイルの “name” に基づいており、”name” を変更すると合わせて変更されます。 XDebug や PHP Debug の設定が正常に完了している場合、これでデバッグが開始されます。 きちんとデバッグが開始されれば、アイコンに数字がついているはずです。 またデバッグが実行されている場合、VS Code 上のどこかにデバッグ用のメニューが表示されているはずです。 左から順に 一時停止： デバッグを一時停止します。 ステップオーバー：ブレークポイントによる実行の中断の際に、次の実行に進みます。次の実行が関数だった場合、関数の中には入らず、関数を超えてその次の実行に進みます。 ステップイン：ブレークポイントによる実行の中断の際に、次の実行に進みます。次の実行が関数だった場合、関数の中に入り関数の中の実行に進みます。 ステップアウト：ブレークポイントによる実行の中断の際に、次の実行に進みます。中断している場所が関数内だった場合、その関数から抜け出して次の実行に進みます。 再起動：デバッグの再起動を行います。 停止：デバッグを停止します。 ブレークポイント ブレークポイントとは、デバッグを実行中に指定した位置で実行を止めることができます。 ブレークポイントはソースコードエディタから追加することが可能です。 このブレークポイントを追加した状態で再度「http://localhost/phpdebug」にアクセスすると画面が表示されないはずです。そして VS Code を確認すると以下のようになっているかと思います。 これはブレークポイントでプログラムの実行が一時停止している状態です。 この場合、”phpinfo()” が実行される”前”で停止されています。 ブレークポイントを使ってプログラムを一時的に停止することで、停止時点の変数の値を確認することなどが可能です。またステップオーバーなどのステップ実行を行うことで順番に処理の流れを追うことができ、表示される変数の値も、それに合わせて変化していきます。 デバッグツールをうまく使って開発を効率よく！ これで VS Code 上でプログラムのデバッグを行えるようになりました。こういったデバッグツールを利用することで、開発をより効率よく進めていくことが可能になるかと思います。 PHP Debug については、ここでは解説しきれなかったことも多くあり、使いこなすことで大変便利なツールとなっています。 こういったデバッグツールは他にも様々あり、また PHP 以外のデバッグを行うこともできます。 もし興味があれば、調べてみてはいかがでしょうか。