PHP × Xdebug × Docker × VSCodeで快適な開発環境をつくってみた

.
├── .devcontainer
│   └── devcontainer.json
├── app
│　　　　　　├──　.vscode
│　　　　　　│   └── launch.json // 後述しますが、VSCodeの左のバーにある虫マークをクリックすると生成されます。
│　　　　　　└──　addNum.php      // デバッグテスト用のファイル
├── docker
│   └── php
│        ├── Dockerfile
│        ├── xdebug.ini
│        └── php.ini
└── docker-compose.yml

mkdir php_xdebug_app
cd php_xdebug_app

touch docker-compose.yml
mkdir docker/php
touch docker/php/Dockerfile
touch docker/php/php.ini
touch docker/php/xdebug.ini
touch .devcontainer/devcontainer.json

# プロジェクトパス(デバッグしていきたいファイルなどを格納します。)
mkdir app

version: "3.8"

services:
  php:
    build:
      context: .
      dockerfile: docker/php/Dockerfile
    volumes:
      - ./app:/var/www/html
    ports:
      - "8000:80"

FROM php:7.4-fpm

WORKDIR /var/www/html

RUN apt-get update \
  && apt-get install -y libonig-dev libzip-dev unzip \

# xdebug install
  && pecl install xdebug \
  && docker-php-ext-enable xdebug

# composer （今回は使用しませんが。。）
COPY --from=composer:2 /usr/bin/composer /usr/bin/composer

# docker-compose.ymlで指定した volumes と同じように書いてください。
# COPY [コピーする(ローカル)] [コピー先(コンテナ内)]　（詳しくは参考文献をご覧ください。）
COPY ./app /var/www/html
COPY ./docker/php/php.ini /usr/local/etc/php/php.ini
COPY ./docker/php/xdebug.ini /usr/local/etc/php/conf.d/xdebug.ini

display_errors = On
display_startup_errors = On
max_execution_time = 30
session.gc_divisor = 1000
session.sid_bits_per_character = 5
output_buffering = 4096
memory_limit = 128M
upload_max_filesize = 64M
post_max_size = 64M
max_input_vars = 1000
log_errors = On
error_log = /dev/stderr
error_reporting = E_ALL
expose_php = On
zend.exception_ignore_args = Off

xdebug.client_host = host.docker.internal
xdebug.start_with_request = yes
xdebug.mode = debug
# port 番号はデフォルトで9003番ですがわかりやすいように明示的に書いています。9003ではなくても空いているポートなら大丈夫です。
# 後述する .devcontainer/devcontainer.json　に書く port と同じにしてください。
xdebug.client_port = 9003
xdebug.log = /var/log/xdebug.log

{
    "name": "php_xdebug_app",           // お好きな名前
    "dockerComposeFile": [              // docker-compose.ymlのパスを記載
        "../docker-compose.yml",
    ],
    "service": "php",                   // docker-compose.yml に記載しているサービス名で起動したいコンテナ
    "workspaceFolder": "/var/www/html", // 作業するパス
    "forwardPorts": [                   // xdebug.iniに書いたport番号と同じにする
        9003
    ],
    "extensions": [                     // コンテナ内で使用したい拡張機能、お好みに合わせて設定してください。
        "felixfbecker.php-debug",
        "coenraads.bracket-pair-colorizer-2",
        "oderwat.indent-rainbow",
        "streetsidesoftware.code-spell-checker",
        "mosapride.zenkaku"
    ]
}

# build
docker-compose build

# コンテナ立ち上げ
docker-compose up

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "XDebug on docker", // お好きな名前
      "type": "php",              // 今回はPHPなので
      "request": "launch", 
      "port": 9003,               // portはxdebug.iniで設定したportと一緒にする
      "stopOnEntry": true,        // デバッグが有効なときにプログラムを中断する
    }
  ]
}

<?php

function addNum(int $num1, int $num2): int
{
    return $num1 + $num2;
}

$num1 = 1;
$num2 = 2;

$result = addNum($num1, $num2);
print_r($result);