在 VS Code 中试用

在容器中运行 Node.js

在本指南中,你将学习如何

  • Express Node.js 服务容器创建 Dockerfile 文件
  • 构建、运行和验证服务的功能
  • 调试在容器内运行的服务

前提条件

  • 必须按照概述中的说明安装 Docker 和 VS Code Docker 扩展
  • Node.js 10 或更高版本

创建 Express Node.js 应用程序

  1. 为项目创建一个文件夹。

  2. 在项目文件夹中打开开发命令提示符并创建项目

    npx express-generator
    npm install
    

向项目添加 Docker 文件

  1. 在 VS Code 中打开项目文件夹。

  2. 打开命令面板(⇧⌘P (Windows, Linux Ctrl+Shift+P)),然后使用 Docker: Add Docker Files to Workspace... 命令

    Add Dockerfile to a Node.js project

  3. 当提示选择应用程序平台时,选择 Node.js

  4. 选择默认的 package.json 文件。

  5. 当提示输入应用程序端口时,输入 3000

  6. 当提示是否包含 Docker Compose 文件时,选择 YesNo。Compose 通常用于同时运行多个容器的场景。

该扩展会创建 Dockerfile.dockerignore 文件。如果你选择包含 Docker Compose 文件,还会生成 docker-compose.ymldocker-compose.debug.yml。最后,该扩展会在 .vscode/tasks.json 中创建一组 VS Code 任务,用于构建和运行容器(包括调试和发布配置),并在 .vscode/launch.json 中创建一个启动调试配置,用于在容器内调试服务。

向镜像添加环境变量

Docker 扩展通过使用 智能感知 来提供自动补全和上下文帮助,从而帮助你编写 Dockerfile。要查看此功能的作用,请按照以下步骤向服务镜像添加环境变量

  1. 打开 Dockerfile 文件。

  2. 使用 ENV 指令向服务容器镜像添加环境变量。

    Add an environment variable to Docker image

    请注意 Docker 扩展如何列出所有可用的 Dockerfile 指令并描述语法。

    Docker 扩展使用 Dockerfilebase 阶段为你的服务创建容器镜像的调试版本。将环境变量定义放在 base 阶段,以便该变量在容器镜像的调试和发布版本中都可用。

  3. 保存 Dockerfile 文件。

在本地运行服务

  1. 打开终端(⌃` (Windows, Linux Ctrl+`))。

  2. 输入 npm run start 启动应用程序

    > express-app@0.0.0 start /Users/user/code/scratch/express-app
    > node ./bin/www
    
  3. 打开 Web 浏览器并导航到 http://localhost:3000。你应该会看到类似以下的页面

    Application page in browser

  4. 测试完成后,在终端中输入 Ctrl+C

构建服务镜像

  1. 打开命令面板(⇧⌘P (Windows, Linux Ctrl+Shift+P)),然后选择 Docker Images: Build Image... 命令。

  2. 打开 Docker 资源管理器,并验证新镜像在镜像树中可见

    Verify Docker image exists

运行服务容器

  1. 右键单击上一节中构建的镜像,然后选择 RunRun Interactive。容器应启动,并且你可以在 Docker 容器树中看到它

    Running service container

  2. 打开 Web 浏览器并导航到 http://localhost:3000。你应该会看到类似以下的页面

    Application page in browser

  3. 测试完成后,右键单击容器树中的容器并选择 Stop

在服务容器中调试

当 Docker 扩展向应用程序添加文件时,它也会在 .vscode/launch.json 中添加一个 VS Code 调试器配置,用于调试在容器内运行的服务。该扩展会检测服务使用的协议和端口,并将浏览器指向该服务。

  1. routes/index.js'/' 路由的 get() 处理程序中设置一个断点。

  2. 确保已选择 Docker Node.js Launch 调试器配置。

    Selected Docker debug configuration

  3. 开始调试(使用 F5 键)。

    • 服务的 Docker 镜像正在构建。
    • 服务的 Docker 容器正在运行。
    • 浏览器打开映射到服务容器的(随机)端口。
    • 调试器在 index.js 中的断点处停止。

    请注意,由于调试器在应用程序启动之后附加,第一次尝试时可能会错过断点;你可能需要刷新浏览器才能在第二次尝试时看到调试器中断。

    你可以通过在 tasks.json 文件中 node 对象下的 docker-run: debug 任务中将 inspectMode 属性设置为 break,从而配置应用程序等待调试器附加后再开始执行。

查看应用程序日志

你可以通过对容器使用 View Logs 命令在 VS Code 中查看日志

  1. 导航到 Docker 资源管理器。

  2. 容器选项卡中,右键单击你的容器并选择 View Logs

    Screenshot of logs in the terminal

  3. 输出将显示在终端中。

后续步骤

你已完成!现在容器已准备就绪,你可能想要