避坑！用Docker搞定PHP开发环境 Nginx PhpStorm VSCode XDebug

文章版本：2019.7

由于最近换电脑的缘故须要从新部署一下本地的开发环境，以前采用的虚拟机方案，占用磁盘空间实在是太大，心疼SSD那么点地方，因此此次采用了Docker的方案来部署。
关于此次部署的原则，个人想法是尽可能使用官方的镜像来实现，尽可能不改动或少改动镜像。由于是本地的开发环境，因此想多尝尝鲜，尽可能使用高版本的软件来实现。
从结果上来讲，但愿能给一样有须要搭建环境的同窗起到一些帮助，少踩一些坑，若是能按照这篇文章的步骤一次搞定那是最好了。

先来讲一下环境：

Docker 18.09.2
Nginx 1.17.1
PHP 7.3.7
XDebug 2.7.2
PhpStorm 2019.1.3
VSCode 1.36.1

一、Docker的安装

这里你们直接在Docker官网下载Docker for Mac就行了，直接按照提示操做便可，此处就不赘述了。

二、安装Nginx

地址：https://hub.docker.com/_/nginx
直接执行 docker pull nginx 拉取最新的镜像；
根据上面的地址咱们能够看到官方提供的一些文档，咱们按照操做便可，我我的采用的方案是先将nginx的整个配置目录copy到本地一份，而后在运行的时候将目录绑定到nginx容器的配置目录，这样修改配置更加方便一些。

将nginx配置目录copy到本地：

$ docker run --name tmp-nginx -d nginx
$ docker cp tmp-nginx:/etc/nginx /Users/yourname/Workspace/etc/nginx
$ docker rm -f tmp-nginx

说明：/Users/yourname/Workspace/etc，这个是我我的的工做目录，到时候根据状况换成本身的就行；命令的做用就是启一个后台运行的nginx容器，将配置目录copy出来以后终止运行并删除容器。

能够先运行一下看看效果：

$ docker run --name run-nginx -d -p 80:80 -v /Users/yourname/Workspace/www:/usr/share/nginx/html:ro nginx

说明：-v参数绑定本地的一个目录到nginx容器中的web目录，这里面没有绑定配置目录，你们能够在web目录下创建一个hello.html，经过浏览器访问http://localhost/hello.html看...，这以后能够你们能够先删除容器，后面咱们改完配置再来启动它。
删除方法：

$ docker rm -f run-nginx

三、安装php-fpm

地址：https://hub.docker.com/_/php
由于这里咱们须要安装一些开发时用到的PHP扩展，因此最好的办法是根据Dockerfile生成咱们本身的镜像，以下是个人Dockerfile，你们能够参考，能够根据状况删减不须要的扩展，不然生成的镜像会比较大。

Dockerfile内容以下：

# 从官方基础版本构建
FROM php:7.3.7-fpm
# 官方版本默认安装扩展: 
# Core, ctype, curl
# date, dom
# fileinfo, filter, ftp
# hash
# iconv
# json
# libxml
# mbstring, mysqlnd
# openssl
# pcre, PDO, pdo_sqlite, Phar, posix
# readline, Reflection, session, SimpleXML, sodium, SPL, sqlite3, standard
# tokenizer
# xml, xmlreader, xmlwriter
# zlib

# 更新为国内镜像
RUN mv /etc/apt/sources.list /etc/apt/sources.list.bak \
    && echo 'deb http://mirrors.163.com/debian/ stretch main non-free contrib' > /etc/apt/sources.list \
    && echo 'deb http://mirrors.163.com/debian/ stretch-updates main non-free contrib' >> /etc/apt/sources.list \
    && echo 'deb http://mirrors.163.com/debian-security/ stretch/updates main non-free contrib' >> /etc/apt/sources.list \
    && apt-get update

# bcmath, calendar, exif, gettext, sockets, dba, 
# mysqli, pcntl, pdo_mysql, shmop, sysvmsg, sysvsem, sysvshm 扩展
RUN docker-php-ext-install -j$(nproc) bcmath calendar exif gettext sockets dba mysqli pcntl pdo_mysql shmop sysvmsg sysvsem sysvshm iconv

# GD 扩展
RUN apt-get install -y --no-install-recommends libfreetype6-dev libjpeg62-turbo-dev libpng-dev \
    && rm -r /var/lib/apt/lists/* \
    && docker-php-ext-configure gd --with-freetype-dir=/usr/include/ --with-jpeg-dir=/usr/include/ \
    && docker-php-ext-install -j$(nproc) gd

# imagick 扩展
RUN export CFLAGS="$PHP_CFLAGS" CPPFLAGS="$PHP_CPPFLAGS" LDFLAGS="$PHP_LDFLAGS" \
    && apt-get install -y --no-install-recommends libmagickwand-dev \
    && rm -r /var/lib/apt/lists/* \
    && pecl install imagick-3.4.4 \
    && docker-php-ext-enable imagick

# mcrypt 扩展 
RUN apt-get install -y --no-install-recommends libmcrypt-dev \
    && rm -r /var/lib/apt/lists/* \
    && pecl install mcrypt-1.0.2 \
    && docker-php-ext-enable mcrypt

# Memcached 扩展 
RUN apt-get install -y --no-install-recommends libmemcached-dev zlib1g-dev \
    && rm -r /var/lib/apt/lists/* \
    && pecl install memcached-3.1.3 \
    && docker-php-ext-enable memcached

# redis 扩展
RUN pecl install redis-5.0.0 && docker-php-ext-enable redis

# opcache 扩展 
RUN docker-php-ext-configure opcache --enable-opcache && docker-php-ext-install opcache

# xdebug 扩展
RUN pecl install xdebug-2.7.2 && docker-php-ext-enable xdebug

# swoole 扩展
RUN pecl install swoole-4.4.0 && docker-php-ext-enable swoole

# 镜像信息
LABEL Author="Stone"
LABEL Version="2019.7"
LABEL Description="PHP 7.3.7 开发环境镜像.

说明：这个Dockerfile我参考了https://www.jianshu.com/p/20fcca06e27e做者的内容，并作了一些调整，你们能够根据本身状况增减，由于是开发环境因此最好把xdebug留着，我们后面也会用到；
下面是将RUN串联起来的Dockerfile，这样生成的镜像能小一些，可是依然有636M，官方的php:7.3.7-fpm的镜像是371M，若是想优化也能够从官方提供的Alpine镜像生成，我们这里就先简单粗暴了。

FROM php:7.3.7-fpm

RUN mv /etc/apt/sources.list /etc/apt/sources.list.bak \
    && echo 'deb http://mirrors.163.com/debian/ stretch main non-free contrib' > /etc/apt/sources.list \
    && echo 'deb http://mirrors.163.com/debian/ stretch-updates main non-free contrib' >> /etc/apt/sources.list \
    && echo 'deb http://mirrors.163.com/debian-security/ stretch/updates main non-free contrib' >> /etc/apt/sources.list \
    && apt-get update \
    && export CFLAGS="$PHP_CFLAGS" CPPFLAGS="$PHP_CPPFLAGS" LDFLAGS="$PHP_LDFLAGS" \
    && apt-get install -y --no-install-recommends libfreetype6-dev libjpeg62-turbo-dev libpng-dev libmagickwand-dev libmcrypt-dev libmemcached-dev zlib1g-dev \
    && rm -rf /var/lib/apt/lists/* \
    && docker-php-ext-configure gd --with-freetype-dir=/usr/include/ --with-jpeg-dir=/usr/include/ \
    && docker-php-ext-install -j$(nproc) bcmath calendar exif gettext sockets dba mysqli pcntl pdo_mysql shmop sysvmsg sysvsem sysvshm iconv gd \
    && pecl install imagick-3.4.4 mcrypt-1.0.2 memcached-3.1.3 redis-5.0.0 xdebug-2.7.2 swoole-4.4.0\
    && docker-php-ext-enable imagick mcrypt memcached redis xdebug swoole \
    && docker-php-ext-configure opcache --enable-opcache && docker-php-ext-install opcache

LABEL Author="Stone"
LABEL Version="2019.7"
LABEL Description="PHP 7.3.7 开发环境镜像. "

说一下踩的坑：apt-get的源最好换成国内的源，不然可能会在构建镜像的时候卡死；由于默认状况下官方容器是基于Debian的，查找源的时候不少都是过期的，如当前的Debian代号是stretch，却使用了jessie的包那确定是会报错的，“E: Unable to correct problems, you have held broken packages.”；你们直接按照我上面的Dockerfile生成镜像便可，测试经过。

在Dockerfile所在目录下执行：

docker build -t my-php-fpm:2019.7 .

-t参数设置镜像名称和标签，请根据本身状况命名，镜像建立完成以后，能够像上面咱们copy出nginx配置同样，将php的相关配置也copy到本地。

$ docker run --name tmp-my-php-fpm -d my-php-fpm:2019.7
$ docker cp tmp-my-php-fpm:/usr/local/etc /Users/yourname/Workspace/etc/php
$ docker rm -f tmp-my-php-fpm

四、修改nginx、php-fpm、xdebug的配置文件

修改nginx配置文件，打开/Users/yourname/Workspace/etc/nginx/default.conf，加入下面的内容：

location ~ \.php$ {
        fastcgi_pass   php-fpm-container:9000;
        fastcgi_index  index.php;
        fastcgi_param  SCRIPT_FILENAME  /var/www/html$fastcgi_script_name;
        fastcgi_param  SCRIPT_NAME      $fastcgi_script_name;
        include        fastcgi_params;
    }

增长的内容里面有一处须要说明，“php-fpm-container”这个是我们本身建立的php-fpm容器的别名，具体是在运行时候指定的，以后我们会提到。

修改php相关配置文件，进入/Users/yourname/Workspace/etc/php下，将php.ini-development复制更名为php.ini，配置内容根据本身状况修改便可。
修改xdebug的配置文件，/Users/yourname/Workspace/etc/php/conf.d/docker-php-ext-xdebug.ini，加入以下内容

xdebug.remote_enable = On
xdebug.remote_handler = dbgp
xdebug.remote_host = host.docker.internal 
xdebug.remote_port = 9001
xdebug.remote_log = /var/log/php/xdebug.log
xdebug.idekey = PHPSTOR

以上设置主要是开启xdebug的远程调试模式，由于php-fpm使用了9000端口，因此这里咱们把xdebug的端口改成了9001；“host.docker.internal”是docker 18.03新加入的，能够解析得到宿主机的ip地址，这样就不用写死ip地址了。

五、启动php-fpm、nginx容器

$ docker run --name run-my-php-fpm \
-v /Users/yourname/Workspace/www:/var/www/html \
-v /Users/yourname/Workspace/etc/php:/usr/local/etc \
-v /Users/yourname/Workspace/log/php:/var/log/php \
-d my-php-fpm:2019.7

$ docker run --name run-nginx \
-p 80:80 \
--link run-my-php-fpm:php-fpm-container \
-v /Users/yourname/Workspace/www:/usr/share/nginx/html \
-v /Users/yourname/Workspace/etc/nginx:/etc/nginx \
-v /Users/yourname/Workspace/log/nginx:/var/log/nginx \
-d nginx

说明：我将配置目录、日志目录和web目录都分别进行了绑定，方便在本地环境中修改。还记得上面提到的nginx中有个配置填写的“php-fpm-container”吗？实际上就是在这里指定的，链接两个容器，并给php-fpm容器起了个别名，配置中经过别名访问。

在/Users/yourname/Workspace/www中建立一个phpinfo.php文件，输出php信息，经过http://localhost/phpinfo.php...。

六、安装Chrome浏览器插件xdebug helper

可能会被墙，请自行解决。

七、PhpStorm调试环境配置

创建/Users/yourname/Workspace/www/xdebug/demo.php，php文件里面随便写点php代码，也能够经过PhpStorm新创建一个空项目，可是位置要在咱们和php-fpm容器绑定的目录。

菜单：PhpStorm->Preferences… 进入偏好设置，按照下图进行设置。

根据上图提示进入CLI Interpreter设置窗口，点“+”添加配置。


继续配置Debug相关设置，以下图：

进入主界面，选择右上的“Add Configuration...”

进入debug配置窗口后选择“+”，选择“PHP Web Page“，设置名称后进入Servers设置，同时设置Start URL：“/xdebug/demo.php”


进入主窗口，在程序中打几个断点，而后点击那个绿色的甲虫就能够了。

八、VSCode调试环境配置

首先安装PHP Debug插件，而后打开上面建立的xdebug目录。以下图所示，进入调试面板，点齿轮选择PHP，而后会建立一个launch.json文件，修改这个文件加入pathMappings配置，这个配置参数用于设置服务器路径与本地路径的对应关系，低版本使用的是localSourceRoot和serverSourceRoot，目前已经被废除。另外记得将端口改成9001。

进入demo.php，随意设置两个断点，而后点左侧的运行按钮，进入调试模式，接下来刷新http://localhost/xdebug/demo....，左侧已经列出调试信息，可选择单步执行跟踪程序的运行。

结尾：实际上此次部署环境踩了很多坑，主要缘由是网上的资料都比较陈旧，不少文章也没有后续的更新，或者方向和我不太一致，例如hub中直接就有xdebug的镜像，可是我仍是想尽可能用官方提供的镜像本身建立，为了不踩坑，你们最好仍是多多参考官方文档，通常都写的比较清楚了。得益于docker的便利，我会不按期的更新这篇文章，这也是我在文章开头设置了一个版本号的缘由，但愿对你们有所帮助。