前言
使用Docker可以輕松構(gòu)建一個項目并運行，然而在真實的使用場景中，我們的項目并非是單一的，而是多個項目相互依賴組成一個web應(yīng)用。
考慮這樣一個場景，一個正在運行的web應(yīng)用，它用到了vue、JAVA8、java15、Tomcat、Nginx、php、MySQL和redis。如果要將這個應(yīng)用遷移到一臺新的服務(wù)器上運行，那么就需要在這臺機器上重新安裝所需的軟件以及環(huán)境變量，這是很痛苦的。
那么，有沒有什么辦法來解決這個問題呢？當(dāng)然有，那就是本文的主角docker-compose（docker編排）。本文就跟大家分享下我是如何使用它解決我的痛苦的，歡迎各位感興趣的開發(fā)者閱讀本文。
前置知識
閱讀本文前，你需要先提前安裝好Docker[1]和 docker-compose[2]。如果你已經(jīng)安裝，我們先來了解幾個基礎(chǔ)概念。如果你僅僅只是想學(xué)習(xí)我是如何編排整個web應(yīng)用的，請直接從編排容器[3]章節(jié)開始閱讀。
鏡像
操作系統(tǒng)分為內(nèi)核和用戶空間，對于linux而言，內(nèi)核啟動后，會掛載root文件系統(tǒng)，為其提供用戶空間支持。而Docker鏡像就相當(dāng)于一個root文件系統(tǒng)。比如官方的鏡像ubuntu:20.04就包含了完整的一套ubuntu最小系統(tǒng)的rooot文件系統(tǒng)。
Docker的鏡像是一個比較特殊的文件系統(tǒng)，它除了提供容器運行時所需的東西外，還包含了一些為運行時準(zhǔn)備的一些配置參數(shù)（掛載卷、環(huán)境變量、用戶等）。鏡像不會包含任何的動態(tài)數(shù)據(jù)，因此在構(gòu)建之后，它的內(nèi)容不會被改變。
如果你還是一頭霧水的話，可以將它比作“備份”，在需要的時候把它拿出來即可原封不動的獲得備份時刻的內(nèi)容。
可能有些開發(fā)者會有疑問，即使是最小的root文件系統(tǒng)，它的體積也是龐大的。Docker在設(shè)計時，就充分利用 Union FS[4] 的技術(shù)，將其設(shè)計為分層存儲的架構(gòu)。這種架構(gòu)使得鏡像的復(fù)用、定制變的更為容易，可以用之前構(gòu)建好的鏡像作為基礎(chǔ)層，然后進(jìn)一步添加新的層，以定制自己所需的內(nèi)容，構(gòu)建新的鏡像。
??注意：鏡像構(gòu)建時，會一層層構(gòu)建，前一層是后一層的基礎(chǔ)。每一層構(gòu)建完就不會再發(fā)生改變，后一層上的任何改變只發(fā)生在自己這一層。因此，在編寫鏡像配置文件的時候，每一層盡量只包含該層需要添加的東西，任何額外的東西應(yīng)該在該層構(gòu)建結(jié)束前清理掉（比如你在某一層需要刪除前一層的文件，它只是將文件標(biāo)記為了已刪除，最終容器運行的時候，雖然不會看到這個文件，但是實際上該文件會一直跟隨鏡像）。
容器
鏡像與容器之間的關(guān)系，類似于Java中的類與實例。鏡像是類，容器是實例化出來的實例。容器可以被創(chuàng)建、啟動、停止、刪除、暫停等。
容器的實質(zhì)是進(jìn)程，但與直接在宿主執(zhí)行的進(jìn)程不同，容器進(jìn)程運行于屬于自己的獨立的命名空間。因此容器可以擁有自己的root文件系統(tǒng)、網(wǎng)絡(luò)配置、進(jìn)程空間。容器內(nèi)的進(jìn)程是運行在一個隔離的環(huán)境里，使用起來，就好像是在一個獨立于宿主的系統(tǒng)下操作一樣。
前面我們講過鏡像使用的是分層存儲，容器也是如此。每一個容器運行時，以鏡像為基礎(chǔ)層，在其上創(chuàng)建一個當(dāng)前容器的存儲層，這個為容器運行時讀寫而準(zhǔn)備的存儲層稱之為容器存儲層。
??注意：容器存儲層的生命周期和容器一樣，容器銷毀時，存儲層也隨之銷毀。因此，任何保存于存儲層的信息都會隨著容器的銷毀而丟失。
因此，當(dāng)我們的容器需要進(jìn)行數(shù)據(jù)寫入時，需要 使用volume數(shù)據(jù)卷 或者 掛載宿主機的目錄 來實現(xiàn)數(shù)據(jù)的持久化。
倉庫
當(dāng)我們構(gòu)建好鏡像之后，很容易在當(dāng)前的宿主機上運行，但是，如果需要在其他服務(wù)器上使用這個鏡像，我們就需要一個倉庫來存儲和分發(fā)它們。Docker Registry[5] 就是這樣的服務(wù)。
一個 Docker Registry 中可以包含多個 倉庫（Repository）；每個倉庫可以包含多個 標(biāo)簽（Tag）；每個標(biāo)簽對應(yīng)一個鏡像。
一個倉庫包含同一個軟件不同版本的鏡像，標(biāo)簽就對應(yīng)著軟件的各個版本。我們通過<倉庫名>:<標(biāo)簽>的格式來指定具體是那個版本的鏡像。
我們以ubuntu鏡像為例，ubuntu是倉庫的名字，其內(nèi)包含有不同的版本標(biāo)簽，如：18.04，20.04。我們在編寫配置文件的時候，就可以通過ubuntu:18.04、ubuntu:20.04來指定具體所需版本的鏡像。如果忽略了標(biāo)簽，將視為ubuntu:latest。
公開服務(wù)
Docker Registry 公開服務(wù)是開放給用戶使用，允許用戶管理鏡像的Registry服務(wù)。一般這類公開服務(wù)允許用戶免費上傳、下載公開的鏡像。
最常使用的公開服務(wù)是官方的 Docker Hub[6]，這個也是默認(rèn)的Registry。擁有大量的官方鏡像。除此之外，還有：
- Red Hat 的 Quay.io[7]
- google 的 Google ContAIner Registry[8]
私有部署
當(dāng)用戶制作好一個鏡像后，不方便在公開服務(wù)上發(fā)布時，就需要在內(nèi)部自己搭建Docker Registry。官方提供了 Docker Registry[9] 鏡像，可以直接使用做為私有 Registry 服務(wù)。
開源的 Docker Registry 鏡像只提供了 Docker Registry API[10] 的服務(wù)端實現(xiàn)，足以支持 docker 命令，不影響使用。但不包含圖形界面，以及鏡像維護(hù)、用戶管理、訪問控制等高級功能。
除了官方的 Docker Registry 外，還有第三方軟件實現(xiàn)了 Docker Registry API，提供了用戶界面以及一些高級功能。比如：Harbor[11]
創(chuàng)建鏡像
Docker鏡像的構(gòu)建是通過讀取Dockerfile文件來完成的，它本質(zhì)是一個文本文件，其內(nèi)包含了一條條的指令，每一條指令構(gòu)建一層，因此每一條指令的內(nèi)容，就是描述該層應(yīng)當(dāng)如何構(gòu)建。
編寫配置文件
此處以我的開源項目chat-system的后端服務(wù)為例，在項目的根目錄創(chuàng)建名為chat-system-server-DockerFile的文件，在文件內(nèi)添加下述代碼：
- 通過FROM指令來指定基礎(chǔ)鏡像
- 通過COPY指令來復(fù)制文件到鏡像內(nèi)
- 通過EXPOSE指令來聲明服務(wù)運行時的端口號
FROM tomcat:9.0.41-jdk8-openjdk
COPY ./chat-system-server.war /usr/local/tomcat/webApps/
COPY ./tomcat/conf/server.xml /usr/local/tomcat/conf/server.xml
EXPOSE 8080
圖片
上面的指令：我們用了9.0.41版本的tomcat且jdk版本為1.8的鏡像作為基礎(chǔ)環(huán)境，隨后我們拷貝了項目的war包到tomact的webapps目錄下，拷貝了tomcat的配置文件到了鏡像內(nèi)。聲明了8080為本服務(wù)的訪問端口號。
常用的指令
在DockerFile中，除了前面我們所講的，還有很多內(nèi)置的指令可以用，此處我們挑幾個常用的來做下講解。
- ADD 用于從URL獲取文件并將其放到目標(biāo)路徑下
- RUN 用于執(zhí)行命令行命令，支持兩種格式：
- shell格式，RUN <命令>相當(dāng)于直接在命令行中輸入命令。
- exec格式，RUN ["可執(zhí)行文件","參數(shù)1","參數(shù)2"]
- CMD 用于指定容器在啟動時所需要運行的程序以及參數(shù)，與RUN命令支持的格式相同
- ENV 用于設(shè)置環(huán)境變量
- WORKDIR 用于指定工作目錄，鏡像在構(gòu)建過程中，每一行都代表一層，如果你在上一層做了操作，在當(dāng)前層需要基于上層完成其他事情，就需要指定它的工作目錄
如果你想了解完整的的指令列表，請移步：Dockerfile 指令詳解[12]。
??注意：在編寫配置文件的時候，如果需要執(zhí)行多個類似于RUN的指令時，請用&&來拼接。因為前面我們講過docker是分層存儲機制，每一個指令都會建立一層，如果運行了多個RUN指令，它就會創(chuàng)建多層鏡像，這是完全沒有意義的，而且很多運行時不需要的東西，都被裝進(jìn)了鏡像里，比如編譯環(huán)境、更新的軟件包等等。結(jié)果就是產(chǎn)生非常臃腫、非常多層的鏡像，不僅僅增加了構(gòu)建部署的時間，也很容易出錯。Dockerfile 支持 Shell 類的行尾添加 的命令換行方式，以及行首 # 進(jìn)行注釋的格式。
RUN set -x; buildDeps='gcc libc6-dev make wget' && apt-get update && apt-get install -y $buildDeps && wget -O redis.tar.gz "http://download.redis.io/releases/redis-5.0.3.tar.gz"
構(gòu)建鏡像
打開終端，進(jìn)入Dockerfile文件所在在的目錄，執(zhí)行 docker build -t chat-system-server:1.0.0 -f chat-system-server-DockerFile .命令，即可開始構(gòu)建流程。
- -t 用于指定容器名
- -f 用于指定配置文件
- . 表示當(dāng)前目錄，在終端執(zhí)行build命令時，需要指定構(gòu)建鏡像的上下文路徑。
圖片
image-20231109215729884
??注意：如果你沒有指定配置文件，它默認(rèn)會使用目錄下名為Dockerfile的文件。如果你的配置文件中包含了COPY操作，請務(wù)必指定上下文路徑。
啟動容器
啟動容器有兩種方式，一種是基于鏡像新建一個容器并啟動，另一種是啟動一個處于終止?fàn)顟B(tài)的容器。
新建并啟動
使用docker run 鏡像名即可創(chuàng)建一個容器并啟動它，我們以上個章節(jié)創(chuàng)建的鏡像為例。
docker run chat-system-server:1.0.0
命令執(zhí)行后，你將在控制臺看到相關(guān)的輸出。
圖片
容器啟動之后，通過鏡像中聲明的8080端口訪問，你會發(fā)現(xiàn)訪問不了。這是因為容器啟動后沒有做端口映射，我們需要在啟動命令中添加-p參數(shù)來指定端口。
- -p 后面跟主機訪問地址，:后跟的是容器的訪問端口。
- 容器的訪問端口通常會使用Dockerfile中通過EXPOSE指令所定義的端口號。
docker run -p 127.0.0.1:8080:8080 chat-system-server:1.0.0
啟動已終止容器
使用docker container start 容器名即可啟動一個處于終止?fàn)顟B(tài)的容器。因為我們是新建的容器，沒有給它命名，docker會默認(rèn)一個容器名，我們可以通過docker ps -a命令來拿到容器名，或者通過Webstorm的Docker插件來獲取。
圖片
image-20231113223349254
docker container start crazy_wu
常用的參數(shù)與命令
容器在啟動時，有豐富的參數(shù)可以配置，此處我列舉幾個最常用的參數(shù)。
在后臺運行容器
我們新建并啟動一個容器[13]時，默認(rèn)會在當(dāng)前終端中運行，終端窗口關(guān)閉后，容器也會跟著終止。通過-d參數(shù)即可讓它在后臺運行。
docker run -d -p 127.0.0.1:8080:8080 chat-system-server:1.0.0
為容器命名
我們在新建容器時，可以通過--name參數(shù)來給它命名。
docker run --name local_chat_system_server -d -p 127.0.0.1:8080:8080 chat-system-server:1.0.0
圖片
終止與刪除容器
我們可以通過stop和rm指令來終止和刪除容器。
# 終止容器
docker container stop 容器名
# 刪除容器
docker container rm 容器名
進(jìn)入容器
如果容器處于后臺運行時，我們需要進(jìn)入容器，做一些操作。就需要使用docker exec -it 容器名 bash來實現(xiàn)。
docker exec -it local_chat_system_server bash
執(zhí)行命令后，就能看到熟悉的終端了。
圖片
數(shù)據(jù)掛載
前面我們說過，容器內(nèi)存儲的數(shù)據(jù)會隨著容器的終止而丟失，需要掛載數(shù)據(jù)卷來實現(xiàn)數(shù)據(jù)的持久化存儲。通常有兩種做法：
- 數(shù)據(jù)卷
- 目錄映射
通過數(shù)據(jù)卷來做存儲需要先使用docker volume create 卷名 命令來創(chuàng)建，新建并啟動一個容器[14]的時候通過--mount指令或者-v 數(shù)據(jù)卷:容器目錄地址來掛載。
# 創(chuàng)建一個數(shù)據(jù)卷
docker volume create chat-system-data
# 啟動容器并掛載數(shù)據(jù)卷
docker run -d
--name local_chat_system_server
--mount source=chat-system-data,target=/usr/local/data
chat-system-server:1.0.0
容器啟動后，會將日志寫到我掛載的數(shù)據(jù)卷中。當(dāng)我想在主機上查看寫入的日志數(shù)據(jù)時，發(fā)現(xiàn)怎么找也找不到。查了很多資料，最后發(fā)現(xiàn)他的數(shù)據(jù)卷存儲很復(fù)雜，并沒有集中存儲，而是分布式的。
這種方式顯然不是我想要的，而目錄映射的方式正好滿足我的需求。我們只需要將數(shù)據(jù)卷改為主機的路徑即可，此處我們以-v參數(shù)為例。
docker run -d
--name local_chat_system_server
-v /Users/likai/Documents/chat-system-server-data:/usr/local/data
chat-system-server:1.0.0
??注意：目錄映射的形式會把指定的主機路徑與容器內(nèi)的目標(biāo)路徑做關(guān)聯(lián)，本地主機做的操作會響應(yīng)到容器內(nèi)，反之亦然。
編排容器
現(xiàn)在，我們回到文章開頭所說的那個場景，一開始我打算使用ubuntu:20.04作為基礎(chǔ)鏡像，寫DockerFile安裝我需要的依賴包，設(shè)置環(huán)境變量，打包成鏡像來使用。我在做事情之前，喜歡先請教下這方面玩的比較好的朋友。
他們告訴我說，如果全部打包到一個鏡像里 ，后期維護(hù)與擴展將成為惡夢，后面你要添加新項目，想訪問一些之前項目里提供的服務(wù)，你就得做很大的改動。一般這種場景我們都會使用Docker Compose來實現(xiàn)的。
簡而言之，Docker Compose的作用就是將多個獨立的容器組合起來，讓容器之間可以輕易的互相訪問，最終實現(xiàn)我們的需求。
編寫配置文件
容器的編排是通過編寫docker-compose.yml配置文件來實現(xiàn)的，一般我們會將這個文件創(chuàng)建在項目的根目錄。它的配置文件中包含有很多配置項，此處我們只列舉本文需要用到的。
- version，用于指定 Docker Compose 文件的格式版本，以確保正確解析和處理文件中的配置，截止目前(2023-11-15)比較主流的版本為3
- services，用于定義各種服務(wù)(mysql、redis、nginx等)將它們組合到一起，形成一個web應(yīng)用
定義網(wǎng)絡(luò)
在物理機上部署服務(wù)時，多個服務(wù)之間相互訪問，需要物理機必須處于同一個網(wǎng)關(guān)下（防火墻也要正確的配置），這樣就能實現(xiàn)多個容器之間的互聯(lián)互通。
在docker-compose中流程也是一樣的，因此我們就需要先定義一個網(wǎng)絡(luò)，設(shè)置好網(wǎng)關(guān)。如下所示，我們定義了一個名為kaisir-docker-network的自定義網(wǎng)絡(luò)。
- external: true 表示該網(wǎng)絡(luò)為外部網(wǎng)絡(luò)，其他Docker容器可以連接到這個網(wǎng)絡(luò)
- name 指定了網(wǎng)絡(luò)名稱
- driver: bridge指定網(wǎng)絡(luò)的連接模式為橋接，他還有很多其他模式可供選擇（host、overlay等）具體請自行查閱相關(guān)資料
- ipam用于IP地址的配置
driver: default，用于指定IP地址管理的驅(qū)動程序，此處選擇默認(rèn)即可
config，用于配置IP地址池，在這里我們定義了一個子網(wǎng)為192.168.30.0/24，其中包含了192.168.30.1到192.168.30.254的所有IP地址。gateway指定了網(wǎng)關(guān)地址為 192.168.30.1
networks:
kaisir-docker-network:
external: true
name: kaisir-docker-network
driver: bridge
ipam:
driver: default
config:
- subnet: 192.168.30.0/24
gateway: 192.168.30.1
通過上述配置，我們就可以在服務(wù)中連接這個網(wǎng)絡(luò)了。有些開發(fā)者可能對192.168.30.0/24比較疑惑，這里就稍作下解釋 。這是一個 CIDR（Classless Inter-Domain Routing）表示法，用于表示 IP 地址范圍。CIDR 表示法包括兩部分：IP 地址的網(wǎng)絡(luò)部分和主機部分，通過斜杠后面的數(shù)字表示網(wǎng)絡(luò)的長度。
在 192.168.30.0/24 中：
- 192.168.30.0 是網(wǎng)絡(luò)的基礎(chǔ) IP 地址。
- /24 表示網(wǎng)絡(luò)的前綴長度，即網(wǎng)絡(luò)中有多少個連續(xù)的 IP 地址。在這里，它表示有24位用于網(wǎng)絡(luò)，剩余的 32 - 24 = 8 位用于主機。
具體地，192.168.30.0/24 表示從 192.168.30.0 到 192.168.30.255 的IP地址范圍，其中包括了 192.168.30.1 到 192.168.30.254 的所有IP地址。192.168.30.0 是網(wǎng)絡(luò)地址，192.168.30.255 是廣播地址。
定義服務(wù)
我可以在services指令下定義我們需要的服務(wù)，為他們連接網(wǎng)絡(luò)、掛載數(shù)據(jù)卷、設(shè)置時區(qū)、定義訪問端口等，我們以mysql為例來做講解，如下所示：
- mysql為服務(wù)名稱
- image為鏡像名稱
- container_name為容器名稱
- volumes為我們需要掛載的數(shù)據(jù)卷
- ports為端口映射
- networks為服務(wù)需要接入的網(wǎng)絡(luò)，定義服務(wù)需要分配的ip地址
- environment 設(shè)置容器的環(huán)境變量，此處我們設(shè)置了mysql的root用戶密碼以及時區(qū)
services:
mysql:
image: mysql:5.7.42
container_name: local_mysql
volumes:
- /Users/likai/Documents/mysql_data:/var/lib/mysql
- /Users/likai/Documents/mysql_conf/my.cnf:/etc/my.cnf
ports:
- 3306:3306
networks:
kaisir-docker-network:
ipv4_address: 192.168.30.11
environment:
- MYSQL_ROOT_PASSword=xxxx
- TZ=Asia/Shanghai
通過這幾行配置，我們就擁有了一個mysql服務(wù)。并且其他服務(wù)可以通過192.168.30.11:3306訪問到這個服務(wù)。
我們再來定義Java服務(wù)和nginx服務(wù)，以我的chat-system-server為例，在打包Java服務(wù)時，將數(shù)據(jù)庫的地址指向我們剛才的mysql服務(wù)即可。
圖片
chat-system-server:
image: tomcat:9.0.41-jdk8-openjdk
container_name: chat_system_server
ports:
- 8080:8080
volumes:
- /Users/likai/Documents/docker_tomcat/webapps:/usr/local/tomcat/webapps
- /Users/likai/Documents/chat-system-server-data:/usr/local/data
- /Users/likai/Documents/docker_tomcat/conf/:/usr/local/tomcat/conf
environment:
- TZ=Asia/Shanghai
networks:
kaisir-docker-network:
ipv4_address: 192.168.30.12
nginx-server:
image: nginx:1.18.0
container_name: local_nginx
ports:
- 80:80
- 443:443
volumes:
- /Users/likai/Documents/nginx_config:/etc/nginx
- /Users/likai/Documents/nginx_data:/usr/share/nginx/data
environment:
- TZ=Asia/Shanghai
networks:
- kaisir-docker-network
depends_on:
- redis
- mysql
- chat-system-server
- kodbox
- halo
同樣的，其他的服務(wù)也通過這種格式進(jìn)行定義即可。上面的配置中，我還定義了redis、kodbox、halo這三個服務(wù)。
- kodbox 是我之前搭建的網(wǎng)盤服務(wù)[15]，依賴php環(huán)境
- halo 是我的個人網(wǎng)站[16]，依賴Java15環(huán)境
因為有多個服務(wù)都需要用到數(shù)據(jù)庫，我需要確保數(shù)據(jù)庫先啟動，因此上面的配置中，我還用depends_on指令定義了服務(wù)的啟動順序。
??注意：上面的配置文件中，本地路徑是寫死在配置文件中的，實際在使用的時候一般會通過變量的形式注入一個路徑前綴進(jìn)來，如下所示：
- 如果 MY_VOLUME_PATH 環(huán)境變量存在并且非空，則使用它的值
- 否則，使用默認(rèn)值 /default/path
volumes: - ${MY_VOLUME_PATH:-/default/path}/docker_tomcat/webapps:/usr/local/tomcat/webapps
啟動服務(wù)
最后，我們在終端通過docker-compose up命令即可啟動我們定義好的所有服務(wù)。因為我們映射了本地的8080端口為chat_system_server的服務(wù)，我們在postman內(nèi)通過127.0.0.1:8080即可訪問到這個容器所提供的服務(wù)了。
docker-compose up
圖片
圖片
在nginx的配置文件中我也暴露了80端口出來，指向了halo服務(wù)，在瀏覽器中直接訪問127.0.0.1就能看到服務(wù)所提供的內(nèi)容了。
圖片
image-20231115222119946
??注意：如果你的配置文件中定義了路徑變量則需要在啟動時傳入這個變量，如下所示：
MY_VOLUME_PATH=/path/to/your/volume docker-compose up
踩坑記錄
我在配置mysql服務(wù)時，走了很多彎路，不知道哪步搞錯了，啟動服務(wù)后會報錯find: '/var/lib/mysql/mysql.sock': No such file or directory，導(dǎo)致啟動失敗，我嘗試過刪除容器、刪除鏡像，清空主機映射的目錄文件，都解決不了。
最后，發(fā)現(xiàn)是權(quán)限原因，在 docker-compose.yml文件中，給mysql服務(wù)添加下述配置即可解決。問題解決后，再把這些去掉即可。
command:
- /bin/bash
- -c
- |
chmod +rw /var/lib/mysql
mysqld
參考資料
[1]Docker: https://yeasy.gitbook.io/docker_practice/install
[2]docker-compose: https://yeasy.gitbook.io/docker_practice/compose/install
[3]編排容器: ##編排容器
[4]Union FS: https://en.wikipedia.org/wiki/Union_mount
[5]Docker Registry: https://docs.docker.com/registry/
[6]Docker Hub: https://hub.docker.com/
[7]Quay.io: https://quay.io/repository/
[8]Google Container Registry: https://cloud.google.com/container-registry/
[9]Docker Registry: https://hub.docker.com/_/registry/
[10]Docker Registry API: https://docs.docker.com/registry/spec/api/
[11]Harbor: https://Github.com/goharbor/harbor
[12]Dockerfile 指令詳解: https://yeasy.gitbook.io/docker_practice/image/dockerfile
[13]新建并啟動一個容器: ###新建并啟動
[14]新建并啟動一個容器: ###新建并啟動
[15]搭建的網(wǎng)盤服務(wù): https://www.kaisir.cn/post/112
[16]個人網(wǎng)站: https://www.kaisir.cn/post/140
[17]個人網(wǎng)站: https://www.kaisir.cn/
