使用 PhpStorm + Docker 搭建开发环境

2022-10-31 22:08:18

前提

1、会 docker 的基本操作。

2、会 dockerfile 的编写。

3、会 docker-compose。

以上技能是以下内容的前提。

PHP 开发者，会慢慢变成全栈

集成环境能达到快速写代码的目的，但对 “慢慢变成全栈” 是不利的！不是用 docker就会变成全栈，只是用一下之前没用过工具，会让自己学到新的知识，从而自我提升、掌握新的技能。

第一步：使用 dockerfile 定制一个 PHP 镜像

接手维护项目，写维护代码最好的环境是和服务器保持一致，那么 docker 可以轻松实现这一点。

比如，要维护一个用 PHP5.6.4、用 ThinkPHP5.0 开发的一个项目，可以用 php5.6.4 镜像为基础，在此基础上安装ThinkPHP5.0 所需的扩展，编写如下 dockerfile：

FROM  php:5.6.4-fpm

RUN apt-get update && apt-get install libssl-dev -y \

    && pecl install redis-2.2.5  xdebug-2.5.5 \

    && docker-php-ext-install pdo_mysql mbstring ftp

可以运行一下命令，生成定制镜像：

docker build -t php564:v1 .

第二步，使用 docker-compose 组合多个镜像

docker-compose 可以编排多个容器，相互配合来完成某项任务，让项目跑起来，还需要 Nginx, 所以新建了一个目录，来专门写 docker-compose 配置：

PS E:\docker\workEnv> pwd

Path                  

----                  

E:\docker\workEnv

2.1 搭建目录结构

建一个文件：docker-compose.yml

两个目录：nginx、php564 用于保存相关容器的一些东西

目录结构如下：

PS E:\docker\workEnv> ls

Directory: E:\docker\workEnv

Mode                 LastWriteTime         Length Name

----                 -------------         ------ ----

d-----        27/04/2021     13:20                nginx

d-----        18/05/2021     10:15                php564

-a----        18/05/2021     10:47            560 docker-compose.yml

PS E:\docker\workEnv>

2.2 定制的 php dockerfile 移到 php564 目录

其他同事可能也需要维护这个项目，把 dockerfile 放到这个目录，其他其它同事也用 docker 的话，可以直接把当前目录（我这里是workEnv）发给他，他通过 docker-compose 可直接编译。

在 php564 目录再建两个目录：conf.d、xdebug，用于映射配置和记录 xdebug
日志，在编写docker-compose.yml 会排上用场。

2.3 编写 docker-compose.yml

version: '3'

services: 

    web:

        image: nginx

        ports: 

            - "80:80"

            - "443:443"

            - "1212:1212"

        depends_on: 

            - php564

        volumes: 

            # nginx 目录映射到 nginx 容器配置目录

            - ./nginx:/etc/nginx/conf.d

            # 本地项目目录 映射到 nginx 容器工作目录

            - E:/www:/usr/share/nginx

    php564:

        build: ./php564

        volumes: 

            # 本地项目目录 映射到 php 容器工作目录

            - E:/www:/var/www

            # php 配置文件

            - ./php564/conf.d/php.ini:/usr/local/etc/php/conf.d/php.ini

            # xdebug 调试日志

            - ./php564/xdebug:/xdebug

        ports:

            - "9000:9000"

2.4 编写 nginx 配置

到 nginx 目录，建一个项目对应的配置文件，我这里建了 oldErp.conf:

# oldERP.conf

server {

    listen       1212;

    server_name  location;

    error_page   500 502 503 504  /50x.html;

    location = /50x.html {

        root   /usr/share/nginx/html;

    }

    location /erp/ {

        alias  /usr/share/nginx/olderp/;

        if (!-e $request_filename){

            rewrite  ^/erp/index.php/(.*)$  /index.php?s=/$1  last;

        }

    }

    location / {

        try_files $uri $uri/ /index.php?$query_string;

    }

    location ~ \.php$ {

       # 这里写php564，在docker-compose 定义好了

       fastcgi_pass   php564:9000;

       fastcgi_index  index.php;

       # 这里也要指定到php564容器内的项目路径

       fastcgi_param SCRIPT_FILENAME /var/www/olderp$fastcgi_script_name;

       include fastcgi_params;

    }

}

2.5 编译 docker-compose.yml

到 workEnv 目录，执行：

docker-compose up -d

然后可以看看容器情况：

PS E:\docker\workEnv> docker-compose top

workenv_php564_1

  UID       PID    PPID    C   STIME   TTY     TIME                              CMD

-------------------------------------------------------------------------------------------------------------

root       12463   12442   0   03:03   ?     00:00:01   php-fpm: master process (/usr/local/etc/php-fpm.conf)

www-data   12518   12463   0   03:03   ?     00:00:02   php-fpm: pool www

www-data   12519   12463   0   03:03   ?     00:00:02   php-fpm: pool www

root       12529   12442   0   03:03   ?     00:00:00   bash



workenv_web_1

 UID     PID    PPID    C   STIME   TTY     TIME                        CMD

-----------------------------------------------------------------------------------------------

root    12275   12254   0   02:50   ?     00:00:00   nginx: master process nginx -g daemon off;

uuidd   12352   12275   0   02:50   ?     00:00:00   nginx: worker process

PS E:\docker\workEnv>

第三步，配置 xdebug

不用 xdebug 也可以写 php 代码，但在程序需要调试的时候，可能就是到处的 var_dump、die 之类的断点代码…

使用 xdebug 可以避免这种尴尬，它可以一步一步慢慢调试，可以监听入参，可以改变入参，所以有的公司把是否会使用 xdebug纳入技能评级，这是有原因的。

要想使用 xdebug, 大概需要这两步：
1、配置 php 支持 xdebug
2、配置 phpstrom 远程调试 xdebug

在前面定制 php 镜像的已安装 xdebug, 不过还需要配置下一些参数，在编写 docker-compose.yml
文件的时候，做了配置映射：

# 省略其它

# php 配置文件

- ./php564/conf.d/php.ini:/usr/local/etc/php/conf.d/php.ini

# 省略其它

所以我们到 php564/conf.d 目录编写 php.ini：

extension=redis.so

zend_extension=xdebug.so

xdebug.idekey=PHPSTORM # IED关键字

xdebug.remote_autostart=on

xdebug.remote_enable=on

xdebug.remote_port=9100

xdebug.remote_host=192.168.2.159 # 本地IP

xdebug.remote_log=/xdebug/debug.log # Xdebug log

memory_limit=1024M

完成以上配置，在 workEnv 目录，执行 docker-compose restart 重启 docker：

PS E:\docker\workEnv> docker-compose restart

Restarting workenv_web_1    ... done

Restarting workenv_php564_1 ... done

PS E:\docker\workEnv>

3.2 配置 phpstrom 远程调试 xdebug

不同的版本可能界面不一样，但思路都一样：

打开设置（settings）

找到语言和框架（Languages & Frameworks）

找到 php，设置 debug 栏目的 Xdebug 端口

还是在 php, 添加一个 servers, 配置本地目录，和容器目录的映射

我电脑电脑如下：

至此，我的环境是 OK 了。

3.3 打断点，使用 Xdebug

结束语

本博文如果能给你提供一些帮助，那我的目的就达到了！

在我使用尝试使用 docker 过程中，看了几遍文档，终于可以定制一个简单的 dockerfile, 使用 docker-compose
更是反反复复尝试看文档，当练习到一定程度，突然之前的不理解变得合乎情理，如果不懂，就多看文档，多尝试！

码农公寓

相关文章