用 Docker 搭建 Laravel 開發環境

KevinYan發表於2019-03-03
DockerLaravel開發環境

在這篇文章中我們將通過Docker在個人本地電腦上構建一個快速、輕量級、不依賴本地電腦所安裝的任何開發套件的可複製的Laravel和Vue專案的開發環境（開發環境的所有依賴都安裝在Docker構建容器裡），加入Vue只是因為有的專案裡會在Laravel專案中使用Vue做前後端分離開發，開發環境中需要安裝前端開發需要的工具集，當然前後端也可以分成兩個專案開發，這個話題不在本篇文章的討論範圍內。

所以我們的目標是：

  • 不在本地安裝Mamp/Wamp這樣的軟體
  • 不使用類似Vagrant這樣的虛擬機器
  • 不在本地電腦全域性安裝PHP開發所需要的工具集
  • 不在本地電腦全域性安裝前端開發所需要的工具集
  • 不在本地電腦全域性安裝Mysql和Nginx

開始前你需要先去安裝一個Docker客戶端，Docker的官網中有詳細的安裝方法。

第一步：獲取Laravel的原始碼包

因為我們電腦上不安裝Composer，所以就不能使用Composer來建立Laravel專案了， 這裡我使用cURL直接從github上下載了最新的Laravel原始碼包，你也可以使用wget或者git clone 來獲取原始碼包。

curl -L -O  https://github.com/laravel/laravel/archive/v5.5.0.tar.gz /
&& tar -zxvf v5.5.0.tar.gz /
&& rm v5.5.0.tar.gz

上面的命令在curl下載完原始碼包後會解壓原始碼壓縮包，解壓完成後在把原始碼壓縮包v5.5.0.tar.gz刪掉，執行完後你會看到一個laravel-5.5.0的專案目錄。

第二步：新增docker-compose.yml

在專案中建立docker-compose.yml檔案。

Compose 專案是 Docker 官方的開源專案，負責實現對 Docker 容器叢集的快速編排。我們知道使用一個 Dockerfile 模板檔案，可以讓使用者很方便的定義一個單獨的應用容器。在這裡我們會用到四個容器分別將PHP、Mysql、Nginx放在四個不同的容器中，通過compose將四個應用容器關聯到一起組成專案。

編排檔案的開頭如下:

version: '2'
services:
   # our services will go here

在編排檔案中，把每個容器叫做一個服務，services下定義整個應用中用到的所有服務（即容器）。

App服務

APP服務的容器將執行我們專案中的程式碼。

app:
  build:
    context: ./
    dockerfile: app.dockerfile
  working_dir: /var/www
  volumes:
    - ./:/var/www
  environment:
    - "DB_PORT=3306"
    - "DB_HOST=database"

Notes:

  • 我們使用app.dockerfile這個映象檔案來構建我們的App容器，在映象檔案中我們會對專案中用到的PHP模組映象配置，也會額外安裝NPM用來構建前端程式碼。
  • working_dir: /var/www把工作目錄設定成了/var/www，在容器中專案程式碼將會被放在/var/www目錄下面，包括使用docker exec app執行的命令也都是以/var/www為當前工作目錄的。
  • volumes是容器內資料卷所掛載路徑設定，在這裡我們只定義一個資料卷，把宿主機專案目錄掛到在容器中的/var/www上，這樣我們在本地電腦對專案程式碼進行的更改就會馬上同步到容器中去，反過來也是一樣，容器中對程式碼做的更改也會及時反饋到本地電腦的專案中。
  • environment設定環境變數名，這裡我們設定了DB_PORT和DB_HOST 這樣就不用修改專案中的.env檔案裡關於這兩項的值了，當然任何你需要在開發環境單獨設定的環境變數都可以寫到這裡，Laravel讀取配置使用的DotEnv會檢測是否系統有指定環境變數的設定，有的話就不會在去讀取.env檔案了。

現在我們需要建立上面build環節中提到的app.dockerfile這個檔案了，具體內容如下:

FROM php:7.1.22-fpm

# Update packages
RUN apt-get update

# Install PHP and composer dependencies
RUN apt-get install -qq git curl libmcrypt-dev libjpeg-dev libpng-dev libfreetype6-dev libbz2-dev

# Clear out the local repository of retrieved package files
# RUN apt-get clean

# Install needed extensions
# Here you can install any other extension that you need during the test and deployment process
RUN apt-get clean; docker-php-ext-install pdo pdo_mysql mcrypt zip gd pcntl opcache bcmath

# Installs Composer to easily manage your PHP dependencies.
RUN curl --silent --show-error https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer

# Install Node
RUN apt-get update &&\
    apt-get install -y --no-install-recommends gnupg &&\
    curl -sL https://deb.nodesource.com/setup_10.x | bash - &&\
    apt-get update &&\
    apt-get install -y --no-install-recommends nodejs &&\
    npm config set registry https://registry.npm.taobao.org --global &&\
    npm install --global gulp-cli

CMD php-fpm

Notes:

  • 我在這裡先將NPM和Composer裝到了app容器中，因為在開發時經常需要執行他們，如果釋出到生產環境，一般是使用單獨的composer對專案程式碼進行構建而不是放在執行應用的容器裡，容器的核心思想之一就是保持單一，這樣才能做到快速增加相同角色的容器。

Web服務

接下來，我們需要配置一個Web伺服器用，我們把這個容器在編排檔案中命名成web

web:
  build:
    context: ./
    dockerfile: web.dockerfile
  working_dir: /var/www
  volumes_from:
    - app
  ports:
    - 8080:80

Notes:

  • volumes_from用來複用在app服務中定義的資料卷路徑

  • 通過ports將本地電腦的8080埠對映到web容器的80埠，這樣在開發環境中我們就不用設定hosts檔案，直接通過IP加埠就能訪問服務了。

    Web伺服器選用nginx，所以我們需要用一個nginx映象檔案來構建這個容器，在這之前我們需要在nginx映象的基礎上再設定一下專案中用到的vhost，所以我們需要一個web.dockerfile檔案，它的定義如下：

FROM nginx:1.10

ADD vhost.conf /etc/nginx/conf.d/default.conf

根據映象檔案的定義，我們把專案中的vhost.conf複製到了容器的/etc/nginx/conf.d/default.conf中，這樣基本的nginx配置就配置好了，vhost.conf中的定義如下:

server {
    listen 80;
    index index.php index.html;
    root /var/www/public;

    location / {
        try_files $uri /index.php?$args;
    }

    location ~ \.php$ {
        fastcgi_split_path_info ^(.+\.php)(/.+)$;
        fastcgi_pass app:9000;
        fastcgi_index index.php;
        include fastcgi_params;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        fastcgi_param PATH_INFO $fastcgi_path_info;
    }
}

Notes:

  • 因為是開發環境我們就只進行最簡單的配置，不做調優考慮了。
  • fastcgi_pass app:9000; nginx將對PHP的請求通過fastcgi傳遞給了app服務的9000埠，docker-compose會自動把services中定義的容器服務連線起來，各個服務相互之間使用服務名稱引用。

Mysql服務

接下來我們將配置Mysql服務，與上面兩個服務有點不一樣的是，在PHP-FPM和Nginx的容器中，我們配置本地電腦的檔案可以同步到容器中供容器訪問，這讓我們開發時對檔案作的更改能夠快速的在容器中得到反饋加快我們的開發過程。但是在資料庫容器中我們希望容器中建立的檔案能夠持久化（預設容器銷燬時，容器內建立的檔案也會被銷燬），我們可以通過Docker的資料捲來實現上述功能，只不過這次不用再把本地電腦的檔案掛在到資料捲上了，Docker客戶端會管理建立的資料卷的在本地電腦上具體儲存的位置。

下面是編排檔案中對database服務的設定


version: '2'
services:

  database:
    image: mysql:5.7
    volumes:
      - dbdata:/var/lib/mysql
    environment:
      - "MYSQL_DATABASE=homestead"
      - "MYSQL_USER=homestead"
      - "MYSQL_PASSWORD=secret"
      - "MYSQL_ROOT_PASSWORD=secret"
    ports:
        - "33061:3306"

volumes:
  dbdata:

Notes:

  • 在檔案的最下面我們通過volumes命令建立了一個名為dbdata的資料卷（dbdata後面的冒號是有意寫上去的，這是YML檔案的一個語法限制，不用太關心）
  • 定義完資料卷後，在上面我們使用<name>:<dir>的格式，通知Docker，將dbdata資料卷掛在到容器中的/var/lib/mysql目錄上
  • environments中設定的是Mysql的docker映象需要的四個必要引數。
  • ports埠對映中，我們將本地電腦的33061埠對映到容器的3306埠，這樣我們就能通過電腦上的資料庫工具連線到docker內的Mysql了。

將所有服務編排到一起

下面是完整的docker-compose.yml檔案，通過編排檔案我們將三個應用容器關聯在一起組成了專案的服務端

version: '2'
services:

  # The Application
  app:
    build:
      context: ./
      dockerfile: app.dockerfile
    working_dir: /var/www
    volumes:
      - ./:/var/www
    environment:
      - "DB_PORT=3306"
      - "DB_HOST=database"

  # The Web Server
  web:
    build:
      context: ./
      dockerfile: web.dockerfile
    working_dir: /var/www
    volumes_from:
      - app
    ports:
      - 8080:80

  # The Database
  database:
    image: mysql:5.6
    volumes:
      - dbdata:/var/lib/mysql
    environment:
      - "MYSQL_DATABASE=homestead"
      - "MYSQL_USER=homestead"
      - "MYSQL_PASSWORD=secret"
      - "MYSQL_ROOT_PASSWORD=secret"
    ports:
        - "33061:3306"

volumes:
  dbdata:

啟動服務

按照上面的步驟配置好編排檔案還有指定的docker映象檔案後，我們就可以通過下面的命令啟動服務了，執行完後會啟動上面檔案裡定義的三個服務。

docker-compose up -d

第一次啟動時，由於docker客戶端要下載上面提到的三個映象並且構建服務所以啟動速度會慢一些，等到下載完映象並構建完成後，以後的啟動都會非常快。

初始化Laravel專案

啟動完服務後我們可以初始化Laravel專案了，步驟跟官方文件裡介紹的一樣，但是需要在啟動的app服務的容器裡執行：

docker-compose exec app composer install
docker-compose exec app npm install // 如果包含前端專案的話再執行相關命令
docker-compose exec app cp .env.example .env
docker-compose exec app php artisan key:generate
docker-compose exec app php artisan optimize
docker-compose exec app php artisan migrate --seed
docker-compose exec app php artisan make:controller MyController

Notes：

  • docker-compose exec 將命令傳送到指定的容器中去執行
  • app是定義在docker-compose.yml中的一個服務，它是一個執行著php-fpm的容器
  • php artisan migrate 是要在容器裡執行的命令

檢視nginx日誌的方法:

  • docker ps 找到nginx服務的container id
  • docker exec -it < contianer id > /bin/bash 進入nginx容器
  • nginx日誌的具體路徑請檢視專案中的vhost.conf

執行完上面的命令後你就能通過http://127.0.0.1:8080/訪問到專案啦。

在我的Github gist有一組參考檔案方便同學們參考https://gist.github.com/kevinyan815/fa0760902d29f19a4213b4a16fe0501b

gist裡的檔案稍微舊一些，後來在使用的過程中又加入些新的PHP模組和Node，之前composer也單獨放到了一個容器中，不過相信聰明的你看到這裡應該已經會根據需求更改這些檔案啦。

關注微信公眾號網管叨bi叨不錯過每一篇好文

相關文章