Docker Compose 容器化 Node.js 应用：开发环境高效部署指南

~/node_project/.gitignore 只需要一个选项，用中文进行同义转述：“~/node_project/.gitignore 文件”。

...
.env
...

在这一点上，您已成功从项目代码中提取出敏感信息，并采取措施来控制这些信息的复制方式和位置。现在，您可以优化数据库连接代码，以适应容器化工作流程。

第三步 – 修改数据库连接设置

您下一步需要做的是通过添加处理应用程序无法连接到数据库的代码，使您的数据库连接方法更加强健可靠。当使用 Compose 来处理容器时，引入这种弹性水平到您的应用程序代码是一种推荐的做法。

打开 db.js 进行编辑。

1. nano db.js

注意之前添加的代码，以及用于 Mongo 连接 URI 的 URL 常量和 Mongoose 连接方法。

这是文章《使用Docker Compose 将 Node.js 应用程序进行容器化，用于开发》的第3部分（共10部分）。

...
const {
  MONGO_USERNAME,
  MONGO_PASSWORD,
  MONGO_HOSTNAME,
  MONGO_PORT,
  MONGO_DB
} = process.env;

const url = `mongodb://${MONGO_USERNAME}:${MONGO_PASSWORD}@${MONGO_HOSTNAME}:${MONGO_PORT}/${MONGO_DB}?authSource=admin`;

mongoose.connect(url, {useNewUrlParser: true});

目前，您的 connect 方法接受一个选项，告诉 Mongoose 使用 Mongo 的新 URL 解析器。您可以在这个方法中添加选项来定义重新连接尝试的参数。通过创建一个 options 常量来包含相关信息，除了新的 URL 解析器选项。在您的 Mongo 常量下方，添加以下对 options 常量的定义：

请将以下内容以中文进行本地化改写：~/节点项目/数据库.js

...
const {
  MONGO_USERNAME,
  MONGO_PASSWORD,
  MONGO_HOSTNAME,
  MONGO_PORT,
  MONGO_DB
} = process.env;

const options = {
  useNewUrlParser: true,
  reconnectTries: Number.MAX_VALUE,
  reconnectInterval: 500, 
  connectTimeoutMS: 10000,
};
...

reconnectTries 选项告诉 Mongoose 无限期地继续尝试连接，而 reconnectInterval 以毫秒为单位定义连接尝试之间的时间间隔。connectTimeoutMS 将使 Mongo 驱动程序在连接尝试失败之前等待 10 秒钟。

现在您可以在 Mongoose 的 connect 方法中使用新的 options 常量来微调您的 Mongoose 连接设置。您还需要添加一个 Promise 来处理可能的连接错误。

目前，Mongoose 的连接方法如下所示：

~/节点项目/数据库.js

...
mongoose.connect(url, {useNewUrlParser: true});

删除现有的连接方法，并用包含 options 常量和 Promise 的以下代码替换。

请将以下路径更改为本地文件路径：~/node_project/db.js

...
mongoose.connect(url, options).then( function() {
  console.log('MongoDB is connected');
})
  .catch( function(err) {
  console.log(err);
});

在成功连接的情况下，您的函数将记录一条适当的消息；否则，它将捕获并记录错误，以便您进行故障排除。

完成的文件将如下所示：

~/节点项目/数据库.js

const mongoose = require('mongoose');

const {
  MONGO_USERNAME,
  MONGO_PASSWORD,
  MONGO_HOSTNAME,
  MONGO_PORT,
  MONGO_DB
} = process.env;

const options = {
  useNewUrlParser: true,
  reconnectTries: Number.MAX_VALUE,
  reconnectInterval: 500,
  connectTimeoutMS: 10000,
};

const url = `mongodb://${MONGO_USERNAME}:${MONGO_PASSWORD}@${MONGO_HOSTNAME}:${MONGO_PORT}/${MONGO_DB}?authSource=admin`;

mongoose.connect(url, options).then( function() {
  console.log('MongoDB 已连接');
})
  .catch( function(err) {
  console.log(err);
});

在编辑完成后，保存并关闭文件。

您现在已经为应用程序代码添加了弹性，以处理应用程序无法连接到数据库的情况。有了这段代码，您可以继续使用 Compose 定义您的服务。

第四步 – 使用 Docker Compose 定义服务

这是文章《使用Docker Compose 将 Node.js 应用程序进行容器化，用于开发》的第5部分（共10部分）。

在你重构了代码之后，你可以开始编写docker-compose.yml文件来定义你的服务。在Docker Compose中，服务是运行中的容器实例，而服务定义——即你在docker-compose.yml文件中配置的信息——包含了每个容器镜像如何运行的详细说明。Compose工具允许你定义多个服务，从而构建复杂的多容器应用程序。

在定义你的服务之前，你将向你的项目添加一个名为“wait-for”的工具。这个工具的目的是确保你的应用程序仅在数据库启动任务完全完成后才尝试连接数据库。这个包装脚本利用netcat来轮询特定的主机和端口，以确认它们是否接受TCP连接。通过测试数据库是否已准备好接受连接，它能有效控制应用程序连接数据库的时机。

尽管Compose允许你使用depends_on选项来指定服务之间的依赖关系，但这种顺序仅基于容器是否正在运行，而非其“就绪状态”。对于你的设置而言，depends_on并不是最佳选择，因为你希望应用程序仅在数据库启动任务（包括向管理员身份验证数据库添加用户和密码）完全完成后才进行连接。有关使用wait-for及其他工具控制启动顺序的更多信息，请参阅Compose文档中的相关建议。

打开一个名为wait-for.sh的文件。

nano wait-for.sh

输入以下代码到文件中以创建轮询函数：

~/node_project/app/wait-for.sh 的中文翻译为：~/node_project/app/等待.sh。

#!/bin/sh

# original script: https://github.com/eficode/wait-for/blob/master/wait-for

TIMEOUT=15
QUIET=0

echoerr() {
  if [ "$QUIET" -ne 1 ]; then printf "%s\n" "$*" 1>&2; fi
}

usage() {
  exitcode="$1"
  cat << USAGE >&2
Usage:
  $cmdname host:port [-t timeout] [-- command args]
  -q | --quiet                        Do not output any status messages
  -t TIMEOUT | --timeout=timeout      Timeout in seconds, zero for no timeout
  -- COMMAND ARGS                     Execute command with args after the test finishes
USAGE
  exit "$exitcode"
}

wait_for() {
  for i in `seq $TIMEOUT` ; do
    nc -z "$HOST" "$PORT" > /dev/null 2>&1
    
    result=$?
    if [ $result -eq 0 ] ; then
      if [ $# -gt 0 ] ; then
        exec "$@"
      fi
      exit 0
    fi
    sleep 1
  done
  echo "Operation timed out" >&2
  exit 1
}

while [ $# -gt 0 ]
do
  case "$1" in
    *:* )
    HOST=$(printf "%s\n" "$1"| cut -d : -f 1)
    PORT=$(printf "%s\n" "$1"| cut -d : -f 2)
    shift 1
    ;;
    -q | --quiet)
    QUIET=1
    shift 1
    ;;
    -t)
    TIMEOUT="$2"
    if [ "$TIMEOUT" = "" ]; then break; fi
    shift 2
    ;;
    --timeout=*)
    TIMEOUT="${1#*=}"
    shift 1
    ;;
    --)
    shift
    break
    ;;
    --help)
    usage 0
    ;;
    *)
    echoerr "Unknown argument: $1"
    usage 1
    ;;
  esac
done

if [ "$HOST" = "" -o "$PORT" = "" ]; then
  echoerr "Error: you need to provide a host and port to test."
  usage 2
fi

wait_for "$@"

当你完成添加代码后，请保存并关闭文件。

将脚本设为可执行。

chmod +x wait-for.sh

接下来，打开docker-compose.yml文件。

nano docker-compose.yml

首先，通过将以下代码添加到文件中来定义Node.js应用程序服务:

~/node_project/docker-compose.yml 的中文本地表达如下：

version: '3'

services:
  nodejs:
    build:
      context: .
      dockerfile: Dockerfile
    image: nodejs
    container_name: nodejs
    restart: unless-stopped
    env_file: .env
    environment:
      - MONGO_USERNAME=$MONGO_USERNAME
      - MONGO_PASSWORD=$MONGO_PASSWORD
      - MONGO_HOSTNAME=db
      - MONGO_PORT=$MONGO_PORT
      - MONGO_DB=$MONGO_DB 
    ports:
      - "80:8080"
    volumes:
      - .:/home/node/app
      - node_modules:/home/node/app/node_modules
    networks:
      - app-network
    command: ./wait-for.sh db:27017 -- /home/node/app/node_modules/.bin/nodemon app.js

Node.js 服务定义包括以下选项：

• build（构建）: 此选项定义了当 Compose 构建应用程序镜像时将应用的配置选项，包括上下文（context）和 Dockerfile。如果您想使用来自 Docker Hub 等注册表的现有镜像，则可以使用 image 指令，并提供您的用户名、仓库和镜像标签信息。
• context（上下文）: 此选项定义了镜像构建的构建上下文——在本例中，即当前项目目录。
• dockerfile: 此选项指定了当前项目目录中的 Dockerfile 作为 Compose 用于构建应用程序镜像的文件。有关此文件的更多信息，请参阅“如何使用 Docker 构建 Node.js 应用程序”。
• image（镜像）, container_name（容器名称）: 这些选项用于为镜像和容器命名。
• restart（重启策略）: 此选项定义了重启策略。默认值为 no（不重启），但您已将容器设置为除非停止（unless-stopped）才重启。
• env_file（环境变量文件）: 此选项告诉 Compose 您希望从构建上下文中的名为 .env 的文件中添加环境变量。
• environment（环境变量）: 使用此选项可以添加您在 .env 文件中定义的 Mongo 连接设置。请注意，您没有将 NODE_ENV 设置为 development，因为如果未设置 NODE_ENV，这是 Express 的默认行为。当部署到生产环境时，您可以将其设置为 production 以启用视图缓存和更简洁的错误消息。另请注意，您已将 db 数据库容器指定为宿主，如第2步所述。
• ports（端口映射）: 此选项将宿主机的 80 端口映射到容器的 8080 端口。
• volumes（卷）: 您在此处包含了两种类型的挂载：
  1. 第一种是绑定挂载（bind mount），它将宿主机上的应用程序代码挂载到容器上的 /home/node/app 目录。这将促进快速开发，因为您对宿主机代码所做的任何更改都会立即同步到容器中。
  2. 第二种是命名卷（named volume），名为 node_modules。当 Docker 运行应用程序 Dockerfile 中列出的 npm install 指令时，npm 将在容器上创建一个新的 node_modules 目录，其中包含运行应用程序所需的包。然而，您刚刚创建的绑定挂载将隐藏这个新创建的 node_modules 目录。由于宿主机上的 node_modules 是空的，绑定挂载会将一个空目录映射到容器，从而覆盖新的 node_modules 目录并阻止您的应用程序启动。命名卷 node_modules 通过持久化 /home/node/app/node_modules 目录的内容并将其挂载到容器来解决此问题，从而避免了绑定挂载的影响。

...
  db:
    image: mongo:4.1.8-xenial
    container_name: db
    restart: unless-stopped
    env_file: .env
    environment:
      - MONGO_INITDB_ROOT_USERNAME=$MONGO_USERNAME
      - MONGO_INITDB_ROOT_PASSWORD=$MONGO_PASSWORD
    volumes:  
      - dbdata:/data/db   
    networks:
      - app-network  

...
networks:
  app-network:
    driver: bridge

volumes:
  dbdata:
  node_modules:  

用户定义的桥接网络 app-network 允许在同一 Docker 守护进程主机上的容器之间进行通信。这简化了应用程序内部的流量和通信，因为它在相同的桥接网络上为容器间通信开放了所有端口，同时不向外部暴露任何端口。因此，您的数据库容器和 Node.js 容器可以相互通信，您只需要暴露 80 端口以便前端访问应用程序。

您的顶级卷键定义了 dbdata 和 node_modules 两个卷。当 Docker 创建卷时，卷的内容存储在由 Docker 管理的主机文件系统的一部分，即 /var/lib/docker/volumes/ 中。每个卷的内容都存储在 /var/lib/docker/volumes/ 下的一个目录中，并被挂载到使用该卷的任何容器中。通过这种方式，即使您删除并重新创建数据库容器，您的用户创建的鲨鱼信息数据也将持久保存在 dbdata 卷中。

最终的 docker-compose.yml 文件将如下所示：

version: '3'

services:
  nodejs:
    build:
      context: .
      dockerfile: Dockerfile
    image: nodejs
    container_name: nodejs
    restart: unless-stopped
    env_file: .env
    environment:
      - MONGO_USERNAME=$MONGO_USERNAME
      - MONGO_PASSWORD=$MONGO_PASSWORD
      - MONGO_HOSTNAME=db
      - MONGO_PORT=$MONGO_PORT
      - MONGO_DB=$MONGO_DB
    ports:
      - "80:8080"
    volumes:
      - .:/home/node/app
      - node_modules:/home/node/app/node_modules
    networks:
      - app-network
    command: ./wait-for.sh db:27017 -- /home/node/app/node_modules/.bin/nodemon app.js 

  db:
    image: mongo:4.1.8-xenial
    container_name: db
    restart: unless-stopped
    env_file: .env
    environment:
      - MONGO_INITDB_ROOT_USERNAME=$MONGO_USERNAME
      - MONGO_INITDB_ROOT_PASSWORD=$MONGO_PASSWORD
    volumes:     
      - dbdata:/data/db
    networks:
      - app-network  

networks:
  app-network:
    driver: bridge

volumes:
  dbdata:
  node_modules:  

在您完成编辑后保存并关闭文件。

在您已经设置了服务定义之后，您就可以开始应用程序了。

第五步 – 测试应用程序

当您的 docker-compose.yml 文件就位后，您可以使用 docker-compose up 命令创建您的服务。您还可以通过使用 docker-compose down 命令停止和删除容器来测试您的数据是否会持久保存。

首先，通过运行带有 -d 标志的 docker-compose up 命令，构建容器镜像并创建服务，然后将在后台运行 nodejs 和 db 容器。

1. docker-compose up -d

输出确认您的服务已经创建。

这是文章《使用Docker Compose 将 Node.js 应用程序进行容器化，用于开发》的第10部分（共10部分）。

… Creating db … done

Creating nodejs … done

您还可以通过显示服务的日志输出来获取关于启动过程的更详细信息。

1. docker-compose logs

如果一切启动正确，以下是输出结果。

您也可以使用docker-compose ps命令来检查您的容器状态。

1. docker-compose ps

输出表明您的容器正在运行。

启动您的服务后，您可以在浏览器中访问http://your_server_ip。

点击“获取鲨鱼信息”按钮，进入一个包含输入表单的页面，您可以在页面上提交鲨鱼名称和鲨鱼一般特征描述。

在表格中，添加您选择的一种鲨鱼。为了进行演示，请将“巨牙鲨”添加到鲨鱼名称栏，并在鲨鱼特征栏中添加“古老”。

点击提交按钮，会将包含这些鲨鱼信息的页面显示给您。

作为最后一步，测试一下您刚刚输入的数据是否会在删除数据库容器后继续存在。

回到您的终端，输入以下命令来停止和删除您的容器和网络：

1. docker-compose down

请注意，您没有包括“–volumes”选项，因此您的“dbdata”卷不会被删除。

以下输出确认您的容器和网络已被移除。

重新创建容器

1. docker-compose up -d

现在返回到鲨鱼信息表：

选择一种新的鲨鱼输入。本例将使用“座头鲸鲨”和“大型”：

一旦您点击提交按钮，您会注意到新的鲨鱼已经添加到您的数据库的鲨鱼收藏中，而且您之前输入的数据没有丢失。

您的应用程序现在正在运行在启用了数据持久化和代码同步的Docker容器上。

结论

通过遵循本教程，您已经使用 Docker 容器为您的 Node 应用程序建立了开发环境。通过提取敏感信息并将应用程序状态与应用程序代码解耦，您使得您的项目更加模块化和易于携带。您还配置了一个模板化的 docker-compose.yml 文件，可以根据您的开发需求和要求进行修改。

随着您的发展，您可能对学习如何设计容器化和云原生工作流的应用程序更感兴趣。请参阅有关 Kubernetes 应用架构和 Kubernetes 应用现代化的更多信息。

请查看《如何使用Docker构建Node.js应用程序》和《如何将MongoDB集成到您的Node应用程序中》以了解本教程中使用的代码。如果想了解使用容器在Nginx反向代理上部署Node应用程序的信息，请查看《如何使用Nginx、Let’s Encrypt和Docker Compose保护容器化的Node.js应用程序》。