在專案中，往往需要在 docker-compose.yml 檔案中使用環境變數來控制不同的條件和使用場景。本文集中介紹 docker compose 引用環境變數的方式。
說明：本文的演示環境為 ubuntu 16.04。

Compose CLI 與環境變數

Compose CLI(compose command-line 即 docker-compose 程式)能夠識別名稱為 COMPOSE_PROJECT_NAME 和 COMPOSE_FILE 等環境變數(具體支援的環境變數請參考這裡)。比如我們可以通過這兩個環境變數為 docker-compose 指定 project 的名稱和配置檔案：

$ export COMPOSE_PROJECT_NAME=TestVar
$ export COMPOSE_FILE
 
=~/projects/composecounter/docker-compose.yml

然後啟動應用，顯示的 project 名稱都是我們在環境變數中指定的：

如果設定了環境變數的同時又指定了命令列選項，那麼會應用命令列選項的設定：

$ docker-compose -p nickproject up -d

在 compose file 中引用環境變數

我們還可以在 compose file 中直接引用環境變數，比如下面的 demo：

version: '3'
  services:
    web:
      image: ${IMAGETAG}
      ports:
       
 
- "5000:5000"
    redis:
      image: "redis:alpine"

我們通過環境變數 ${IMAGETAG} 指定了 web 的映象，下面通過 export 的方式來為 compose 配置檔案中的環境變數傳值：

注意，如果對應的環境變數沒有被設定，那麼 compose 就會把它替換為一個空字串：

碰到這種情況，我們可以在 compose 的配置檔案中為該變數設定一個預設值：

version: '3'
services:
  web:
    image: ${IMAGETAG:-defaultwebimage}
    ports:
     - "5000:5000"
 

  redis:
    image: "redis:alpine"

這樣，如果沒有設定 IMAGETAG 變數，就會應用 defaultwebimage：

除了這種方式，我們還可以通過後面將介紹的 .env 檔案來為環境變數設定預設值。

把環境變數傳遞給容器

先來看一下在 compose file 中如何為容器設定環境變數：

web:
  environment:
    DEBUG: 1

compose file 中的 environment 節點用來為容器設定環境變數，上面的寫法等同於：

$ docker run -e DEBUG=1

要把當前 shell 環境變數的值傳遞給容器的環境變數也很簡單，去掉上面程式碼中的賦值部分就可以了：

web:
  environment:
    DEBUG:

這種情況下，如果沒有在當前的 shell 中匯出環境變數 DEBUG，compose file 中會把它解釋為 null：

在試試匯出環境變數 DEBUG 的情況：

$ export DEBUG=1

這才是我們設計的正確的使用場景！

使用檔案為容器設定多個環境變數

如果覺得通過 environment 為容器設定環境變數不夠過癮，我們還可以像 docker -run 的 --env-file 引數一樣通過檔案為容器設定環境變數：

web:
  env_file:
    - web-variables.env

注意，web-variables.env 檔案的路徑是相對於 docker-compose.yml 檔案的相對路徑。上面的程式碼效果與下面的程式碼相同：

$ docker run --env-file=web-variables.env

web-variables.env 檔案中可以定義一個或多個環境變數：

# define web container env
APPNAME=helloworld
AUTHOR=Nick Li
VERSION=1.0

檢查下結果：

原來 compose 把 env_file 的設定翻譯成了 environment！

.env 檔案

當我們在 docker-compose.yml 檔案中引用了大量的環境變數時，對每個環境變數都設定預設值將是繁瑣的，並且也會影響 docker-compose.yml 簡潔程度。此時我們可以通過 .env 檔案來為 docker-compose.yml 檔案引用的所有環境變數設定預設值！
修改 docker-compose.yml 檔案的內容如下：

version: '3'
services:
  web:
    image: ${IMAGETAG}                 
    environment:
      APPNAME:
      AUTHOR:
      VERSION:
    ports:
     - "5000:5000"
  redis:
    image: "redis:alpine"

然後在相同的目錄下建立 .env 檔案，編輯其內容如下：

# define env var default value.
IMAGETAG=defaultwebimage
APPNAME=default app name
AUTHOR=default author name
VERSION=default version is 1.0

檢查下結果，此時所有的環境變數都顯示為 .env 檔案中定義的預設值：

配置不同場景下的環境變數

從前面的部分中我們可以看到，docker compose 提供了足夠的靈活性來讓我們設定 docker-compose.yml 檔案中引用的環境變數，它們的優先順序如下：

1. Compose file
2. Shell environment variables
3. Environment file
4. Dockerfile
5. Variable is not defined

首先，在 docker-compose.yml 檔案中直接設定的值優先順序是最高的。
然後是在當前 shell 中 export 的環境變數值。
接下來是在環境變數檔案中定義的值。
再接下來是在 Dockerfile 中定義的值。
最後還沒有找到相關的環境變數就認為該環境變數沒有被定義。

根據上面的優先順序定義，我們可以把不同場景下的環境變數定義在不同的 shell 指令碼中並匯出，然後在執行 docker-compose 命令前先執行 source 命令把 shell 指令碼中定義的環境變數匯出到當前的 shell 中。通過這樣的方式可以減少維護環境變數的地方，下面的例子中我們分別在 docker-compose.yml 檔案所在的目錄建立 test.sh 和 prod.sh，test.sh 的內容如下：

#!/bin/bash
# define env var default value.
export IMAGETAG=web:v1
export APPNAME=HelloWorld
export AUTHOR=Nick Li
export VERSION=1.0

prod.sh 的內容如下：

#!/bin/bash
# define env var default value.
export IMAGETAG=webpord:v1
export APPNAME=HelloWorldProd
export AUTHOR=Nick Li
export VERSION=1.0LTS

在測試環境下，執行下面的命令：

$ source test.sh
$ docker-compose config

此時 docker-compose.yml 中的環境變數應用的都是測試環境相關的設定。

而在生產環境下，執行下面的命令：

$ source prod.sh
$ docker-compose config

此時 docker-compose.yml 中的環境變數應用的都是生產環境相關的設定。

總結

docker compose 對環境變數的使用提供了非常豐富支援和靈活的使用方式。希望通過本文的總結可以幫助大家理清相關的用法，並能夠以簡潔的方式為不同的使用場景提供支援。