Docker、VScode環境でデバッグ

はじめに

毎度環境構築で時間を使っているので、記憶にあるうちに備忘録として纏めます。
今回は、Docker + PHP + Xdebug + VScodeでのデバッグする方法になります。

目次

1.環境
2.ディレクトリ構成
3.各種設定ファイル
4.拡張機能必要ライブラリ
5.実際の流れ

環境

windows11 home
docker
Xdebug 3系

ディレクトリ構成

.
├── .devcontainer
│ └── devcontainer.json
├── app
│　　　　　　├──　.vscode
│　　　　　　│ └── launch.json
│　　　　　　└──　sample.php
├── docker
│ └── php
│ ├── Dockerfile
│ ├── xdebug.ini
│ └── php.ini
└── docker-compose.yml

各種設定ファイル

・Docker
docker-compose.yml
→Docker Compose というツールが使用する設定ファイル

Dockerfile
→Dockerのイメージを作成するための設定ファイル。

・php
php.ini
→phpの動作に関係する設定ファイル

・xdebug
xdebug.ini
→PHPのデバッグツールであるXdebugについて設定するファイル

・json
devcontainer.json
→VSCodeのContainerで使用される設定ファイル

launch.json
→ VSCode のデバッグ設定ファイル

拡張機能必要ライブラリ

実際の流れ

準備 → docker起動 → コンテナ接続 →デバッグ起動

準備
ディレクトリ構成にあわせて、必要ファイル等を用意する

docker-compose.yml

Dockerfile

php..ini

xdebug.ini

devcontainer.json

launch.json

コンテナの作成とdockerの起動

コンテナの作成
docker-compose build

コンテナの立ち上げ

コンテナ作成

docker起動

コンテナ接続
VScodeの左下の><のようなマークをクリック

Reopen in Containerをクリック

デバッグ起動

ブレークポイントを付ける

叩いてみる

画像のように変数の中を確認できれば完了！

終わりに

xdebugをローカルでインストールしてしまうと認識されずうまくデバッグができない。xdebugはあくまでもリモート上で、インストールする必要がある。また、launch.jsonやdevcontainer.jsonのパスと合わせないとファイルの階層がおかしく認識されて、デバッグ出来ない時もあったので、個人的に気を付けたいと思いました。