使用 PhpStorm + Docker 搭建開發環境

bigbug發表於2021-05-18
PHPORMDocker開發環境

前提

  • 會 docker 的基本操作。
  • 會 dockerfile 的編寫。
  • 會 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

3.1 配置 php 支援 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, 配置本地目錄，和容器目錄的對映
    我電腦電腦如下：
    settings
    debug 欄目的 Xdebug 埠
    新增一個 servers

設定好了上面後，還需要配置 IED 的 RUN:
遠端的除錯
遠端debug settings

至此，我的環境是OK了。

3.3 打斷點，使用 Xdebug

使用

結束語

本博文如果能給你提供一些幫助，那我的目的就達到了！

在我使用嘗試使用 docker 過程中，看了幾遍文件，終於可以定製一個簡單的 dockerfile,使用 docker-compose 更是反反覆覆嘗試看文件，當練習到一定程度，突然之前的不理解變得合乎情理，如果不懂，就多看文件，多嘗試！

參考資料

Docker — 從入門到實踐

本作品採用《CC 協議》，轉載必須註明作者和本文連結
Less is more.

相關文章