让我们一下玩转 Docker 部署

时间：2022-09-04 08:02:51

让我们一下玩转 Docker 部署

前言

相信很多人都很头疼 Docker 的部署，我自己也是。

最近发现一个很有意思的现象：一个人想学某样技术的时候，当学会了之后，但是这时出现了一个问题需要学习另一门技术时，无论这个人前面学得多么刻苦，用功，到这一步有 99% 的概率都会放弃。我愿称这种现象为 “学习窗口”。

写一个网站、学会 Vue.js 是很多人的“学习窗口”，只要离开了这个“学习窗口”，他们就不想学了：我都学这么多了，草，怎么最后还要学部署啊。

所以，这篇文章就跟大家分享一下关于 Docker 部署的那些事。

需求

按照国际惯例，先从一个非常简单的需求入手，这个需求只完成几件事：

显示待办事项列表 + 添加一个待办事项

记录网站的访问量

上面就是一个经典到不能再经典的 Todo List 应用。

让我们一下玩转 Docker 部署

分析一下需求：待办事项列表需要用到 数据库 完成，记录网站访问量则要用到高速读取的 缓存 来完成。

技术选型

目前我前端技术栈是 React.js，所以前端用 React.js。

由于 Express 有自己的脚手架，所以，后端采用 Express。

数据库方面，因为我自己用的是 M1 的 Mac，所以 mysql 镜像无法拉取，暂时用 mariadb 来代替。

缓存大家都很熟悉了，直接用 redis 搞定。

前端实现

关于前端的实现非常简单，发请求使用 axios。

  1. interface Todo { 
  2.   id: number; 
  3.   title: string; 
  4.   status: 'todo' | 'done'; 
  5. } 
  6.  
  7. const http = axios.create({ 
  8.   baseURL: 'http://localhost:4200', 
  9. }) 
  10.  
  11. const App = () => { 
  12.   const [newTodoTitle, setNewTodoTitle] = useState<string>(''); 
  13.   const [count, setCount] = useState(0); 
  14.   const [todoList, setTodoList] = useState<Todo[]>([]); 
  15.  
  16.   // 添加 todo 
  17.   const addTodo = async () => { 
  18.     await http.post('/todo', { 
  19.       title: newTodoTitle, 
  20.       status: 'todo', 
  21.     }) 
  22.     await fetchTodoList(); 
  23.   } 
  24.  
  25.   // 获取访问量，并添加一个访问量 
  26.   const fetchCount = async () => { 
  27.     await http.post('/count'); 
  28.     const { data } = await http.get('/count'); 
  29.     setCount(data.myCount); 
  30.   } 
  31.  
  32.   // 获取 todo 列表 
  33.   const fetchTodoList = async () => { 
  34.     const { data } = await http.get('/todo'); 
  35.     setTodoList(data.todoList); 
  36.   } 
  37.  
  38.   useEffect(() => { 
  39.     fetchCount().then(); 
  40.     fetchTodoList().then(); 
  41.   }, []); 
  42.  
  43.   return ( 
  44.     <div className="App"> 
  45.       <header>网站访问量：{count}</header> 
  46.  
  47.       <ul> 
  48.         {todoList.map(todo => ( 
  49.           <li key={todo.id}>{todo.title} - {todo.status}</li> 
  50.         ))} 
  51.       </ul> 
  52.  
  53.       <div> 
  54.         <input value={newTodoTitle} onChange={e => setNewTodoTitle(e.target.value)} type="text"/> 
  55.         <button onClick={addTodo}>提交</button> 
  56.       </div> 
  57.     </div> 
  58.   ); 
  59. } 

后端实现

后端稍微麻烦了一点，要解决的问题有：

  • 跨域
  • 数据库连接
  • Redis 连接

先在 main.ts 里配置好路由：

  1. var cors = require('cors') 
  2.  
  3. var indexRouter = require('./routes/index'); 
  4. var usersRouter = require('./routes/count'); 
  5. var todosRouter = require('./routes/todo'); 
  6.  
  7. var app = express(); 
  8.  
  9. // 解决跨域 
  10. app.use(cors()); 
  11.  
  12. // 业务路由 
  13. app.use('/', indexRouter); 
  14. app.use('/count', usersRouter); 
  15. app.use('/todo', todosRouter); 
  16.  
  17. ... 
  18.  
  19. module.exports = app; 

访问量路由需要用到 redis 来实现高速读写：

  1. const express = require('express'); 
  2. const Redis = require("ioredis"); 
  3.  
  4. const router = express.Router(); 
  5.  
  6. // 连接 redis 
  7. const redis = new Redis({ 
  8.   port: 6379, 
  9.   host: "127.0.0.1", 
  10. }); 
  11.  
  12. router.get('/', async (req, res, next) => { 
  13.   const count = Number(await redis.get('myCount')) || 0; 
  14.  
  15.   res.json({ myCount: count }) 
  16. }); 
  17.  
  18. router.post('/', async (req, res) => { 
  19.   const count = Number(await redis.get('myCount')); 
  20.   await redis.set('myCount', count + 1); 
  21.   res.json({ myCount: count + 1 }) 
  22. }) 
  23.  
  24. module.exports = router; 

todo 路由里使用 sequelize 这个库来实现数据库连接和初始化：

  1. const { Sequelize, DataTypes} = require('sequelize'); 
  2. const express = require("express"); 
  3.  
  4. const router = express.Router(); 
  5.  
  6. // 连接数据库 
  7. const sequelize = new Sequelize({ 
  8.   host: 'localhost', 
  9.   database: 'docker_todo', 
  10.   username: 'root', 
  11.   password: '123456', 
  12.   dialect: 'mariadb', 
  13. }); 
  14.  
  15. // 定义 todo model 
  16. const Todo = sequelize.define('Todo', { 
  17.   id: { 
  18.     type: Sequelize.INTEGER, 
  19.     autoIncrement: true, 
  20.     primaryKey: true 
  21.   }, 
  22.   title: { type: DataTypes.STRING }, 
  23.   status: { type: DataTypes.STRING } 
  24. }, {}); 
  25.  
  26. // 同步数据库结构 
  27. sequelize.sync({ force: true }).then(() => { 
  28.   console.log('已同步'); 
  29. }); 
  30.  
  31. router.get('/', async (req, res) => { 
  32.   // 获取 todo list 
  33.   const todoList = await Todo.findAll(); 
  34.   res.json({ todoList }); 
  35. }) 
  36.  
  37. router.post('/', async (req, res, next) => { 
  38.   const { title, status } = req.body; 
  39.  
  40.   // 创建一个 todo 
  41.   const newTodo = await Todo.create({ 
  42.     title, 
  43.     status: status || 'todo', 
  44.   }); 
  45.  
  46.   res.json({ todo: newTodo }) 
  47. }); 
  48.  
  49. module.exports = router; 

本地运行

本来使用以下命令就可以跑本地应用了：

  1. # 前端 
  2. cd client && npm run start 
  3.  
  4. # 后端 
  5. cd server && npm run start 

然而，我们本地并没有 mariadb 和 redis，这就有点难受了。

启动容器

如果是在以前，我一般会在 Mac 上用下面的命令安装一个 mariadb 和 redis：

  1. brew install mariadb 
  2.  
  3. brew install redis 

然后在 自己电脑 里一通配置(username, password...)，最后才能在本地跑项目，非常麻烦。而且一旦配置错了，草，又要重装。。。

而 Docker 其中一个作用就是将上面 mariadb 和 redis 都打成不同 image(镜像)，使用 DockerHub 统一管理，使用 Docker 就可以快速配置一个服务。

以前只能一个电脑装一个 MySQL，现在我能同时跑 8 个 MySQL 容器(不同端口)，想删谁删谁，想装谁装谁。遇事不决，先把容器重启，重启不行，再用镜像构建一个容器，构建不行，再拉一个 latest 的镜像，再构建一次，非常的带劲。

废话不多说，先来把 redis 启动：

  1. docker run --name docker-todo-redis -p 6379:6379 -d redis 

然后再把 mariadb 启动：

  1. 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 表示后台运行。

再次运行：

  1. # 前端 
  2. cd client && npm run start 
  3.  
  4. # 后端 
  5. cd server && npm run start 

可以在 http://localhost:3000 看到页面：

让我们一下玩转 Docker 部署

貌似一切都很 OK 的样子~

docker-compose

试想一下，如果现在给你一个机器，请问你要怎么部署?你要先跑上面两条 docker 命令，再跑下面两条 npm 的命令，麻烦。

能不能一键拉起 mariadb, redis 2 个容器呢?这就是 docker-compose.yml 的由来。创建一个 dev-docker-compose.yml 文件：

  1. version: '3' 
  2. services: 
  3.   mariadb: 
  4.     image: mariadb 
  5.     container_name: 'docker-todo-mariadb' 
  6.     environment: 
  7.       MARIADB_ROOT_PASSWORD: '123456' 
  8.       MARIADB_DATABASE: 'docker_todo' 
  9.     ports: 
  10.       - '3306:3306' 
  11.     restart: always 
  12.   redis: 
  13.     image: redis 
  14.     container_name: 'docker-todo-redis' 
  15.     ports: 
  16.       - '6379:6379' 
  17.     restart: always 

这个 yml 文件描述的内容其实就等同于上面两条 docker 命令。好处有两个：

  • 不用写一串长长长长长长长长长长长长长长得让人受不了的命令
  • 把部署命令记到小本本 docker-compose.yml 文件里。问：怎么部署?答：自己看 docker-compose.yml
  • 一键拉起相关服务

以后，一键跑本地服务的时候就可以一键启动 mariadb 和 redis 了：

  1. 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 整了：

  1. # 使用 node 镜像 
  2. FROM node 
  3.  
  4. # 准备工作目录 
  5. RUN mkdir -p /app/client 
  6. WORKDIR /app/client 
  7.  
  8. # 复制 package.json 
  9. COPY package*.json /app/client/ 
  10.  
  11. # 安装目录 
  12. RUN npm install 
  13.  
  14. # 复制文件 
  15. COPY . /app/client/ 
  16.  
  17. # 开启 Dev 
  18. CMD ["npm", "run", "start"] 

非常的简单，需要注意的是容器也可以看成一个电脑里的电脑，所以把自己电脑的文件复制到 “容器电脑” 里是非常必要的一步。

Express App 的 Dockerfile 和上面的几乎一毛一样：

  1. # 使用 node 镜像 
  2. FROM node 
  3.  
  4. # 初始化工作目录 
  5. RUN mkdir -p /app/server 
  6. WORKDIR /app/server 
  7.  
  8. # 复制 package.json 
  9. COPY package*.json /app/server/ 
  10.  
  11. # 安装依赖 
  12. RUN npm install 
  13.  
  14. # 复制文件 
  15. COPY . /app/server/ 
  16.  
  17. # 开启 Dev 
  18. CMD ["npm", "run", "start"] 

那么现在再来改造一个 prod-docker-compose.yml 文件：

  1. version: '3' 
  2. services: 
  3.   client: 
  4.     build: 
  5.       context: ./client 
  6.       dockerfile: Dockerfile 
  7.     container_name: 'docker-todo-client' 
  8.     # 暴露端口 
  9.     expose: 
  10.       - 3000 
  11.     # 暴露端口 
  12.     ports: 
  13.       - '3000:3000' 
  14.     depends_on: 
  15.       - server 
  16.     restart: always 
  17.   server: 
  18.     # 构建目录 
  19.     build: 
  20.       context: ./server 
  21.       dockerfile: Dockerfile 
  22.     # 容器名 
  23.     container_name: 'docker-todo-server' 
  24.     # 暴露端口 
  25.     expose: 
  26.       - 4200 
  27.     # 端口映射 
  28.     ports: 
  29.       - '4200:4200' 
  30.     restart: always 
  31.     depends_on: 
  32.       - mariadb 
  33.       - redis 
  34.   mariadb: 
  35.     image: mariadb 
  36.     container_name: 'docker-todo-mariadb' 
  37.     environment: 
  38.       MARIADB_ROOT_PASSWORD: '123456' 
  39.       MARIADB_DATABASE: 'docker_todo' 
  40.     ports: 
  41.       - '3306:3306' 
  42.     restart: always 
  43.   redis: 
  44.     image: redis 
  45.     container_name: 'docker-todo-redis' 
  46.     ports: 
  47.       - '6379:6379' 
  48.     restart: always 

上面的配置应该都不难理解，不过，还是有一些细节需要注意：

  • 端口都要暴露出来，也要做映射，不然本地也访问不了 3000 和 4200 端口
  • depends_on 的作用是等 maraidb 和 redis 两个容器起来了再启动当前容器

然后运行下面命令，一键启动：

  1. docker-compose -f prod-docker-compose.yml up -d --build 

后面 --build 是指每次跑时都构建一次镜像。

然而，Boom：

让我们一下玩转 Docker 部署

  1. ConnectionRefusedError: connect ECONNREFUSED 127.0.0.1:3306 
  2. ... 

怎么连不上了?

解决连不上的问题

连不上的原因是我们这里用了 localhost 和 127.0.0.1。

虽然每个容器都在我们主机 127.0.0.1 网络里，但是容器之间是需要通过对方的 IP 地址来交流和访问的，按照官网的介绍 通过 Container Name 就可得知对方容器的 IP。

让我们一下玩转 Docker 部署

因此，Express App 里的 host 不能写 127.0.0.1，而要填 docker-todo-redis 和 docker-todo-mariadb。下面用环境变量 NODE_ENV 来区分是否以 Docker 启动 App。

修改 mariadb 的连接：

  1. // 连接数据库 
  2. const sequelize = new Sequelize({ 
  3.   host: process.env.NODE_ENV === 'docker' ? 'docker-todo-mariadb' : "127.0.0.1" , 
  4.   database: 'docker_todo', 
  5.   username: 'root', 
  6.   password: '123456', 
  7.   dialect: 'mariadb', 
  8. }); 

再修改 redis 的连接：

  1. const redis = new Redis({ 
  2.   port: 6379, 
  3.   host: process.env.NODE_ENV === 'docker' ? 'docker-todo-redis' : "127.0.0.1" , 
  4. }); 

然后在 /server/Dockerfile 里添加 NODE_ENV=docker：

  1. # 使用 node 镜像 
  2. FROM node 
  3.  
  4. # 初始化工作目录 
  5. RUN mkdir -p /app/server 
  6. WORKDIR /app/server 
  7.  
  8. # 复制 package.json 
  9. COPY package*.json /app/server/ 
  10.  
  11. ENV NODE_ENV=docker 
  12.  
  13. # 安装依赖 
  14. RUN npm install 
  15.  
  16. # 复制文件 
  17. COPY . /app/server/ 
  18.  
  19. # 开启 Dev 
  20. CMD ["npm", "run", "start"] 

现在继续运行我们的 “一键启动” 命令，就能启动我们的生产环境了：

  1. docker-compose -f prod-docker-compose.yml up -d --build 

总结

一句话总结，Dockerfile 是用于构建 Docker 镜像的，跟我们平常接触的 CICD 或者流水线有点类似。而 docker-compose 的作用则是 “一键拉起” N 个容器。

上面整个例子放在 Github 这里了，可以 Clone 下来自己捣鼓玩玩。

原文链接：https://mp.weixin.qq.com/s/r2MKkA2TGzjD16e_ykcsfQ

标签：

相关文章