阿月很乖

念念不忘,必有回响

  menu
102 文章
260530 浏览
1 当前访客
ღゝ◡╹)ノ❤️

Phpstorm + Docker / Docker Compose + xdebug 环境搭建

刚换笔记本,不想搞太多环境,什么 Apache、Mysql 啥的,想全部交给 Docker 管理,复杂一点的直接 Docker compose 编排一下就好了。乐得清闲,升级又容易,php 的环境也不例外,所以将它搭建一下:

环境准备

不需要安装 php,不需要安装 apach,也不需要配置 xdebug,啥都不用,安排。

开始

创建一个 phpstrom 空项目,然后创建一个 index.php 文件

<?php
$world = "World";
echo "hello,", $world;

Docker 方式

两种方式拉去镜像

主要提供两种类型的镜像(以 7.4 php 为例,注意:7.4 版本官方没有传到 Docker Hub,可以使用 7.3 的):

  • php-74-cli-xdebug-29:主要提供基础的 php 7.4 + xdebug 2.9 + mysqli 环境,不提供web环境与端口暴露。
  • php-74-apache-xdebug-29:主要提供 php 7.4 + xdebug 2.9 + mysqli+ apache2 环境,同时安装了 php 部分依赖(见 Docker 官方构建文件),提供web环境,内部暴露端口 80

本次以 php-74-apache-xdebug-29 为例,在项目所在的目录启动并拉取容器:

docker run --name php-web-dev -p 80:80 -e XDEBUG_CONFIG=remote_host=host.docker.internal -v $(pwd):/var/www/html -d phpstorm/php-73-apache-xdebug-27

具体参数不做解释啦,能安装 Docker 的应该都能明白,可以通过 man 查一下。

需要注意以下两点:

  1. 其中的 ${pwd} 是获取当前的工作目录路径,可以自己手动指定。或者
    • 对于 Windowscmd 可以是 %cd%
    • 对于 Windowspowershell 可以不变。如果不行可以尝试 ${PWD}
  2. 通过 -e 设置的环境变量 XDEBUG_CONFIG 指定了远程的主机地址,对于 windowsMac 来说,host.docker.internal 即是主机地址(参考 官网文档1官网文档2)。而对于 Linux,则是无法进行识别的(参考 Github Issue),这个时候可以使用 主机名 来指定(通过 hostname 获取),请自己根据情况修改 。

然后直接访问 127.0.0.1,结果如下:

image-20200731211328720

这样就跑起来啦。

Docker Compose 方式

注意:如果你是一步一步的来,请先停止上一步的容器:

docker stop php-web-dev

项目根目录创建一个 docker-compose.yml 文件,如下:

version: '3.8'
services:
  webserver:
    image: phpstorm/php-73-apache-xdebug-27
    ports:
      - "80:80"
    volumes:
      - ./:/var/www/html
    environment:
      XDEBUG_CONFIG: remote_host=host.docker.internal

对于 Linux ,修改 environment

   ...
    environment:
      XDEBUG_CONFIG: remote_host=<hostname>

注意:Docker Compose 和 Docker 的版本有所关系,具体参见 官方文档

创建完成直接运行即可

image-20200731212509592

Tips: phpstormidea 一样,都有 services,可以直接通过 services 进行容器管理。

image-20200731212534550

访问测试 127.0.0.1,结果同上。

Debug

浏览器安装 xdebug 扩展插件,见 官方文档Zend Debugger 没有试过。

访问 127.0.0.1 ,开启插件 debug 模式

image-20200731214409388

上述两种方式的 Debug 的方式都是一样的,所以一起说啦。首先打断点

image-20200731212639298

开启 phpstormdebug 监听

(开启前)

image-20200731212753466

(开启后)

image-20200731212834049

无论上述两种的那种运行方式,直接访问 127.0.0.1,会弹出如下界面:

image-20200731213100779

选择当前项目,ACCEPT 即可!随后就可以看到效果啦

image-20200731213555345

发生了什么

其实这个过程很好理解,通过查看他的构建方式就知道,主要有以下几步:

  1. 拉取 php7.4 镜像,完成基本的依赖安装、apachexdebug安装
  2. 指定当前工作目录映射到容器内的 apache 下,端口 80 进行映射
  3. 指定 xdebug 的主机地址为我们宿主机
  4. 开启 phpstorm 的监听,以及文件的 debug映射

这里需要提一下,其实我们在倒数第二部 ACCEPT 那里,主要是配置了一个 php server

image-20200731214550471

这个配置是十分重要的,你可以提前将它配置好,然后倒数第二部里面进行选择即可。如果是 Zend Debugger ,无非就是修改 Debugger,但是没有官方镜像支持

Docker Compose 编排

下面我们加上另外一个容器:Mysql8,很简单:

version: '3.8'
services:
  mysql-php-dev:
    container_name: mysql-php-dev
    image: mysql:8
    command: --default-authentication-plugin=mysql_native_password
    environment:
      MYSQL_ROOT_PASSWORD: 123456
    networks:
      - php-mysql
  webserver:
    container_name: php-web-dev-1
    depends_on:
      - mysql-php-dev
    image: phpstorm/php-73-apache-xdebug-27
    ports:
      - "80:80"
    volumes:
      - ./:/var/www/html
    environment:
      XDEBUG_CONFIG: remote_host=host.docker.internal
    networks:
      - php-mysql

networks:
  php-mysql:

修改代码:

<?php
$world = "World";
echo "Hello,", $world;
$servername = "mysql-php-dev";
$username = "root";
$password = "123456";

$conn = mysqli_connect($servername, $username, $password);
if (!$conn) {
    die("Connection failed: " . mysqli_connect_error());
}
echo "连接成功";

访问测试一下:

image-20200731215831768

搞定!

念念不忘,必有回响。

PS:如果觉得文章不错或者帮到了您,帮忙点点下面广告呗~谢谢啦~