WebStorm 2025.2 Help

使用 Vagrant 的 Node.js

使用 Vagrant ,您可以快速引导您的 Node.js 应用程序在 WebStorm 中运行、调试和分析。

开始之前

  1. 请确保已在 设置 | 插件 页面、 已安装 选项卡中启用所需插件 VagrantJavaScript DebuggerNode.jsNode.js Remote Interpreter。 详细信息请参阅 管理插件

  2. 请确保在您的计算机上下载、安装并配置了 VagrantOracle 的 VirtualBox。 详细信息请参阅 Vagrant:使用可复现的开发环境进行开发

  3. 请确保以下可执行文件的父文件夹已添加至系统 PATH 变量中:

    • 来自 Vagrant 安装中的 vagrant.bat vagrant 。 这应由 Vagrant 安装程序自动完成。

    • 来自 Oracle VirtualBox 安装的 VBoxManage.exe VBoxManage

  4. 若需要在 Vagrant 环境中使用 Node.js 可执行文件,您可以从一个已就绪的 Vagrant box 开始,例如 jandir/nodejs

    打开内嵌 终端Alt+F12 ),然后运行以下命令:

    vagrant init jandir/nodejs vagrant up

在 Vagrant 环境中配置 Node.js 解释器

Vagrant 环境中的 Node.js 解释器在 配置Node.js 远程解释器 对话框中进行配置。 您可以通过 Node.js 页面中的 设置 对话框打开此对话框,或在稍后 创建或编辑 Node.js 运行/调试配置 时进行,用于在 Vagrant 上运行或调试应用程序。

推荐方式是在 设置 对话框中配置远程 Node.js 解释器。 在这种情况下,您可以将解释器及相关包管理器设置为项目默认值。

直接在 Node.js 运行/调试配置中配置的远程 Node.js 解释器,仅可与该运行/调试配置联用。

  1. 打开 设置 对话框(Ctrl+Alt+S ),然后转到 语言和框架 | Node.js

  2. 点击 浏览按钮 按钮,位于 Node 解释器(I) 字段旁边。

    添加解释器 - 浏览按钮
  3. 在包含所有已配置解释器列表的 Node.js 解释器 对话框中,点击工具栏上的 添加按钮 ,并在上下文菜单中选择 添加远程

    配置 Vagrant 环境中的远程 Node.js 解释器:添加远程
  4. 在打开的 配置 Node.js 远程解释器对话框 中,选择 Vagrant

  5. 指定指向所要使用的环境的 Vagrant 实例文件夹

    从技术角度来看,这是所需环境中 VagrantFile 配置文件所在的文件夹。 基于此设置,WebStorm 将检测 Vagrant 主机 ,并通过链接形式显示在 Vagrant 主机 URL 只读字段中。

    默认情况下,该字段显示当前项目文件夹。

  6. Node.js 解释器路径 字段中,指定 Node.js 可执行文件的位置。

    配置 Vagrant 环境中的远程 Node.js 解释器:指定实例文件夹及 Node 可执行文件位置

    若要定位 Node.js 可执行文件,请打开内嵌 终端Alt+F12 ),并输入:

    vagrant ssh whereis node exit
    在 Vagrant 环境中定位 Node.js 可执行文件
  7. 点击 确定 返回到 Node.js 解释器 对话框,此时新解释器已添加至列表中。

  8. 若要将新配置的解释器设置为项目默认值,请在列表中选择该解释器,然后点击 确定 返回到 Node.js 对话框。

    远程解释器对话框:已在 Vagrant 环境中添加新 Node.js 解释器至列表

    每次从 Project 列表中选择 Node 解释器 别名时,例如创建运行/调试配置时,WebStorm 会自动使用此解释器。

  9. 指定所用包管理器的路径。

    配置远程 Node.js 解释器:已指定包管理器

    要定位包管理器,请打开内置 终端Alt+F12 ),然后键入:

    vagrant ssh whereis <package manager> exit
    在 Vagrant 环境中定位包管理器

创建 Node.js 运行/调试配置

  1. 转到 运行 | 编辑配置。 在打开的 编辑配置 对话框中,点击工具栏上的 添加新配置按钮 ,然后在上下文菜单中选择 Node.js。 将打开 运行/调试配置:Node.js 对话框。

    文件 字段中,指定启动应用程序的文件路径。

    Node.js 运行/调试配置:已指定 JavaScript 文件
  2. 如有需要,按照 运行和调试 Node.js 应用程序 中的说明指定一些可选设置。

  3. Node 解释器(I) 列表中选择 Vagrant 环境中的相关远程 Node.js 解释器。

    使用 Vagrant 的 Node.js:运行/调试配置,选择解释器

    或者,点击位于 Node 解释器(I) 字段旁的 浏览按钮。 将打开 Node.js Interpreters 对话框。

    点击工具栏上的 添加按钮 ,然后在上下文菜单中选择 添加远程

    远程解释器对话框

    按照 上述说明在 Vagrant 环境中配置远程 Node.js 解释器。

  4. 点击 确定 以保存运行/调试配置。

在 Vagrant 环境中运行 Node.js 应用程序

  • 在工具栏的 运行/调试配置 小部件列表中,选择新建的 Node.js 配置,然后点击其旁的 运行按钮

    在 Vagrant 环境中运行应用程序
  • 或者,创建一个包含 Vagrant 环境中 Node.js 解释器的 Node.js 运行/调试配置, 如上述说明所示 ,或修改现有配置,然后在对话框中点击 运行

检查应用程序输出

为确保应用程序按预期运行,您可以通过 WebStorm 的 内置 HTTP 客户端 运行一个 HTTP 请求。

使用 Vagrant 的 Node.js:通过 HTTP 请求连接到正在运行的应用
  1. 创建一个 HTTP 请求文件。

  2. 编写如下请求:

    GET http://<host IP>:<application port>/

    默认情况下,主机 IP 为 192.168.33.10。 例如:

    GET http://192.168.33.10:3000/
  3. 点击边栏的 运行 HTTP 请求按钮 ,然后点击 运行 HTTP 请求按钮 ,其位于 运行 http://<host IP>:<application port>/ 旁边。

    启动 HTTP 请求

    应用程序输出显示在 运行 工具窗口的单独选项卡中。

在 Vagrant 环境中调试 Node.js 应用程序

  1. 根据需要在代码中设置断点。

  2. 创建一个包含 Vagrant 环境中 Node.js 解释器的 Node.js 运行/调试配置, 如上述说明所示

  3. 在工具栏的 运行 小部件列表中,选择新建的 Node.js 配置,然后点击其旁的 调试按钮

  4. 在打开的 调试工具窗口 中继续调试会话 ——单步调试断点 、在帧间切换、动态更改值、 检查暂停程序计算表达式 以及 设置监视

    在 Vagrant 环境中调试 Node.js 应用
最后修改日期: 2025年 9月 26日