相信很多人都很頭疼 Docker 的部署,我自己也是。
最近發現一個很有意思的現象:一個人想學某樣技術的時候,當學會了之後,但是這時出現了一個問題需要學習另一門技術時,無論這個人前面學得多麼刻苦,用功,到這一步有 99% 的概率都會放棄。我願稱這種現象為 「學習窗口」。
寫一個網站、學會 Vue.js 是很多人的「學習窗口」,只要離開了這個「學習窗口」,他們就不想學了:我都學這麼多了,草,怎麼最後還要學部署啊。
所以,這篇文章就跟大家分享一下關於 Docker 部署的那些事。
需求按照國際慣例,先從一個非常簡單的需求入手,這個需求只完成幾件事:
上面就是一個經典到不能再經典的 Todo List 應用。
分析一下需求:待辦事項列表需要用到 資料庫 完成,記錄網站訪問量則要用到高速讀取的 緩存 來完成。
技術選型目前我前端技術棧是 React.js,所以前端用 React.js。
由於 Express 有自己的腳手架,所以,後端採用 Express。
資料庫方面,因為我自己用的是 M1 的 Mac,所以 mysql 鏡像無法拉取,暫時用 mariadb 來代替。
緩存大家都很熟悉了,直接用 redis 搞定。
前端實現關於前端的實現非常簡單,發請求使用 axios。
interface Todo {
id: number;
title: string;
status: 'todo' | 'done';
}
const http = axios.create({
baseURL: 'http://localhost:4200',
})
const App = () => {
const [newTodoTitle, setNewTodoTitle] = useState<string>('');
const [count, setCount] = useState(0);
const [todoList, setTodoList] = useState<Todo[]>([]);
// 添加 todo
const addTodo = async () => {
await http.post('/todo', {
title: newTodoTitle,
status: 'todo',
})
await fetchTodoList();
}
// 獲取訪問量,並添加一個訪問量
const fetchCount = async () => {
await http.post('/count');
const { data } = await http.get('/count');
setCount(data.myCount);
}
// 獲取 todo 列表
const fetchTodoList = async () => {
const { data } = await http.get('/todo');
setTodoList(data.todoList);
}
useEffect(() => {
fetchCount().then();
fetchTodoList().then();
}, []);
return (
<div className="App">
<header>網站訪問量:{count}</header>
<ul>
{todoList.map(todo => (
<li key={todo.id}>{todo.title} - {todo.status}</li>
))}
</ul>
<div>
<input value={newTodoTitle} onChange={e => setNewTodoTitle(e.target.value)} type="text"/>
<button onClick={addTodo}>提交</button>
</div>
</div>
);
}
後端實現後端稍微麻煩了一點,要解決的問題有:
先在 main.ts 裡配置好路由:
var cors = require('cors')
var indexRouter = require('./routes/index');
var usersRouter = require('./routes/count');
var todosRouter = require('./routes/todo');
var app = express();
// 解決跨域
app.use(cors());
// 業務路由
app.use('/', indexRouter);
app.use('/count', usersRouter);
app.use('/todo', todosRouter);
...
module.exports = app;訪問量路由需要用到 redis 來實現高速讀寫:
const express = require('express');
const Redis = require("ioredis");
const router = express.Router();
// 連接 redis
const redis = new Redis({
port: 6379,
host: "127.0.0.1",
});
router.get('/', async (req, res, next) => {
const count = Number(await redis.get('myCount')) || 0;
res.json({ myCount: count })
});
router.post('/', async (req, res) => {
const count = Number(await redis.get('myCount'));
await redis.set('myCount', count + 1);
res.json({ myCount: count + 1 })
})
module.exports = router;todo 路由裡使用 sequelize 這個庫來實現資料庫連接和初始化:
const { Sequelize, DataTypes} = require('sequelize');
const express = require("express");
const router = express.Router();
// 連接資料庫
const sequelize = new Sequelize({
host: 'localhost',
database: 'docker_todo',
username: 'root',
password: '123456',
dialect: 'mariadb',
});
// 定義 todo model
const Todo = sequelize.define('Todo', {
id: {
type: Sequelize.INTEGER,
autoIncrement: true,
primaryKey: true
},
title: { type: DataTypes.STRING },
status: { type: DataTypes.STRING }
}, {});
// 同步資料庫結構
sequelize.sync({ force: true }).then(() => {
console.log('已同步');
});
router.get('/', async (req, res) => {
// 獲取 todo list
const todoList = await Todo.findAll();
res.json({ todoList });
})
router.post('/', async (req, res, next) => {
const { title, status } = req.body;
// 創建一個 todo
const newTodo = await Todo.create({
title,
status: status || 'todo',
});
res.json({ todo: newTodo })
});
module.exports = router;
本地運行本來使用以下命令就可以跑本地應用了:
# 前端
cd client && npm run start
# 後端
cd server && npm run start然而,我們本地並沒有 mariadb 和 redis,這就有點難受了。
啟動容器如果是在以前,我一般會在 Mac 上用下面的命令安裝一個 mariadb 和 redis:
brew install mariadb
brew install redis然後在 自己電腦 裡一通配置(username, password...),最後才能在本地跑項目,非常麻煩。而且一旦配置錯了,草,又要重裝。。。
而 Docker 其中一個作用就是將上面 mariadb 和 redis 都打成不同 image(鏡像),使用 DockerHub 統一管理,使用 Docker 就可以快速配置一個服務。
以前只能一個電腦裝一個 MySQL,現在我能同時跑 8 個 MySQL 容器(不同埠),想刪誰刪誰,想裝誰裝誰。遇事不決,先把容器重啟,重啟不行,再用鏡像構建一個容器,構建不行,再拉一個 latest 的鏡像,再構建一次,非常的帶勁。
廢話不多說,先來把 redis 啟動:
docker run --name docker-todo-redis -p 6379:6379 -d redis然後再把 mariadb 啟動:
docker run -p 127.0.0.1:3306:3306 --name docker-todo-mariadb -e MARIADB_ROOT_PASSWORD=123456 MARIADB_DATABASE=docker_todo -d mariadb解釋一下參數 -p 是埠映射:本機:容器,-e 指定環境變量,-d 表示後臺運行。
再次運行:
# 前端
cd client && npm run start
# 後端
cd server && npm run start可以在 http://localhost:3000 看到頁面:
貌似一切都很 OK 的樣子~
docker-compose試想一下,如果現在給你一個機器,請問你要怎麼部署?你要先跑上面兩條 docker 命令,再跑下面兩條 npm 的命令,麻煩。
能不能一鍵拉起 mariadb, redis 2 個容器呢?這就是 docker-compose.yml 的由來。創建一個 dev-docker-compose.yml 文件:
version: '3'
services:
mariadb:
image: mariadb
container_name: 'docker-todo-mariadb'
environment:
MARIADB_ROOT_PASSWORD: '123456'
MARIADB_DATABASE: 'docker_todo'
ports:
- '3306:3306'
restart: always
redis:
image: redis
container_name: 'docker-todo-redis'
ports:
- '6379:6379'
restart: always這個 yml 文件描述的內容其實就等同於上面兩條 docker 命令。好處有兩個:
不用寫一串長長長長長長長長長長長長長長得讓人受不了的命令把部署命令記到小本本 docker-compose.yml 文件裡。問:怎麼部署?答:自己看 docker-compose.yml以後,一鍵跑本地服務的時候就可以一鍵啟動 mariadb 和 redis 了:
docker-compose -f dev-docker-compose.yml up -d
Dockerfile不過,在生產環境時每次都要跑 npm 這兩條命令還是很煩,能不能把這兩行也整全到 docker-compose 裡呢?
注意:生產環境應該要用 npm run build 構建應用,然後再跑構建出來的 JS 才是正常開發流程,這裡為了簡化流程,就以 npm run start 來做例子說明。
既然 docker-compose 是通過 image 創建容器的,那麼我們的 React App 和 Express App 也打成兩個 image,然後用 docker-compose 分別創建容器不就 OK 了麼?
構建容器說白了就是我們常說的 「CICD 或者構建流水線」,只不過這個 「流水線」 關鍵的只有一條 npm run start。描述 「流水線」 的叫 Dockerfile (注意這裡不是駝峰寫法)。
注意:正常的鏡像構建和啟動應該是整個項目 CICD 其中的一環,這裡只是打個比方。項目的 CICD 除了跑命令,構建應用,還會有代碼檢查、脫敏檢查、發布消息推送等步驟,是更為繁雜的一套流程。
先把 React 的 Dockerfile 整了:
# 使用 node 鏡像
FROM node
# 準備工作目錄
RUN mkdir -p /app/client
WORKDIR /app/client
# 複製 package.json
COPY package*.json /app/client/
# 安裝目錄
RUN npm install
# 複製文件
COPY . /app/client/
# 開啟 Dev
CMD ["npm", "run", "start"]非常的簡單,需要注意的是容器也可以看成一個電腦裡的電腦,所以把自己電腦的文件複製到 「容器電腦」 裡是非常必要的一步。
Express App 的 Dockerfile 和上面的幾乎一毛一樣:
# 使用 node 鏡像
FROM node
# 初始化工作目錄
RUN mkdir -p /app/server
WORKDIR /app/server
# 複製 package.json
COPY package*.json /app/server/
# 安裝依賴
RUN npm install
# 複製文件
COPY . /app/server/
# 開啟 Dev
CMD ["npm", "run", "start"]那麼現在再來改造一個 prod-docker-compose.yml 文件:
version: '3'
services:
client:
build:
context: ./client
dockerfile: Dockerfile
container_name: 'docker-todo-client'
# 暴露埠
expose:
- 3000
# 暴露埠
ports:
- '3000:3000'
depends_on:
- server
restart: always
server:
# 構建目錄
build:
context: ./server
dockerfile: Dockerfile
# 容器名
container_name: 'docker-todo-server'
# 暴露埠
expose:
- 4200
# 埠映射
ports:
- '4200:4200'
restart: always
depends_on:
- mariadb
- redis
mariadb:
image: mariadb
container_name: 'docker-todo-mariadb'
environment:
MARIADB_ROOT_PASSWORD: '123456'
MARIADB_DATABASE: 'docker_todo'
ports:
- '3306:3306'
restart: always
redis:
image: redis
container_name: 'docker-todo-redis'
ports:
- '6379:6379'
restart: always上面的配置應該都不難理解,不過,還是有一些細節需要注意:
埠都要暴露出來,也要做映射,不然本地也訪問不了 3000 和 4200 埠depends_on 的作用是等 maraidb 和 redis 兩個容器起來了再啟動當前容器然後運行下面命令,一鍵啟動:
docker-compose -f prod-docker-compose.yml up -d --build後面 --build 是指每次跑時都構建一次鏡像。
然而,Boom:
ConnectionRefusedError: connect ECONNREFUSED 127.0.0.1:3306
...怎麼連不上了?
解決連不上的問題連不上的原因是我們這裡用了 localhost 和 127.0.0.1。
雖然每個容器都在我們主機 127.0.0.1 網絡裡,但是容器之間是需要通過對方的 IP 地址來交流和訪問的,按照官網的介紹 通過 Container Name 就可得知對方容器的 IP。
因此,Express App 裡的 host 不能寫 127.0.0.1,而要填 docker-todo-redis 和 docker-todo-mariadb。下面用環境變量 NODE_ENV 來區分是否以 Docker 啟動 App。
修改 mariadb 的連接:
// 連接資料庫
const sequelize = new Sequelize({
host: process.env.NODE_ENV === 'docker' ? 'docker-todo-mariadb' : "127.0.0.1" ,
database: 'docker_todo',
username: 'root',
password: '123456',
dialect: 'mariadb',
});再修改 redis 的連接:
const redis = new Redis({
port: 6379,
host: process.env.NODE_ENV === 'docker' ? 'docker-todo-redis' : "127.0.0.1" ,
});然後在 /server/Dockerfile 裡添加 NODE_ENV=docker:
# 使用 node 鏡像
FROM node
# 初始化工作目錄
RUN mkdir -p /app/server
WORKDIR /app/server
# 複製 package.json
COPY package*.json /app/server/
ENV NODE_ENV=docker
# 安裝依賴
RUN npm install
# 複製文件
COPY . /app/server/
# 開啟 Dev
CMD ["npm", "run", "start"]現在繼續運行我們的 「一鍵啟動」 命令,就能啟動我們的生產環境了:
docker-compose -f prod-docker-compose.yml up -d --build
總結一句話總結,Dockerfile 是用於構建 Docker 鏡像的,跟我們平常接觸的 CICD 或者流水線有點類似。而 docker-compose 的作用則是 「一鍵拉起」 N 個容器。
上面整個例子放在 Github 這裡了,可以 Clone 下來自己搗鼓玩玩。