PhpStorm 2025.3 Help

使用 Vagrant 的 Node.js

使用 Vagrant ,您可以快速引导您的 Node.js 应用程序来运行、调试和分析它的性能,从 PhpStorm 开始。

开始之前

  1. 确保在 设置 | 插件 页面,选项卡 已安装 上启用了所需的插件: JavaScript 和 TypeScriptJavaScript DebuggerNode.jsNode.js Remote Interpreter。 如需更多信息,请参阅 管理插件

  2. 按照 从 JetBrains Marketplace 安装插件 中的描述,在 设置 | 插件 页面,选项卡 Marketplace 上安装并启用 Vagrant 插件。

  3. 请确保已在您的计算机上下载、安装并配置好 VagrantOracle's VirtualBox。 更多信息,请参见 Vagrant

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

    • vagrant.bat vagrant 从 您的 Vagrant 安装。 这应该由 Vagrant 安装程序自动完成。

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

  5. 为了在 Vagrant 环境中使用 Node.js 可执行文件,您可以从一个现成的 Vagrant box 开始,例如 jandir/nodejs

    打开嵌入式 终端Alt+F12 )并运行以下命令:

    vagrant init jandir/nodejs vagrant up

在 Vagrant 环境中配置 Node.js 运行时

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

建议的方式是在 设置 对话框中配置远程 Node.js 运行时。 在这种情况下,您可以将该运行时及其关联的包管理器设置为项目默认。

直接在 Node.js 运行/调试配置中配置的远程 Node.js 运行时只能与该运行/调试配置一起使用。

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

  2. 点击 “浏览”按钮 字段旁的 Node.js 运行时

    添加运行时 - 浏览按钮
  3. 在包含所有当前已配置运行时列表的 Node.js 运行时 对话框中,单击工具栏中的 "添加"按钮 ,然后在上下文菜单中选择 添加远程.

    在 Vagrant 实例中配置 Node.js 远程运行时:添加远程
  4. 在打开的 配置 Node.js 远程运行时对话框 中,选择 Vagrant

  5. 请指定 Vagrant 实例文件夹 ,该变量指向您将要使用的环境。

    从技术上讲,这是用于所需环境的 VagrantFile 配置文件所在的文件夹。 基于此设置,PhpStorm 检测到 Vagrant host 并将其作为链接显示在 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. 要将新配置的运行时设为项目默认,请在列表中选择它并单击 确定 返回到 JavaScript 运行时 对话框。

    远程运行时对话框:已将在 Vagrant 环境中的新 Node.js 运行时添加到列表中

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

  9. 指定要使用的软件包管理器路径。

    配置远程 Node.js 运行时:已指定包管理器

    要定位包管理器,请打开嵌入的 终端Alt+F12 )并输入:

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

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

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

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

    Node.js 运行/调试配置:指定的 JavaScript 文件
  2. 如有必要,请按照 运行和调试 Node.js 应用程序中描述的方式指定一些可选设置。

  3. Node.js 运行时 列表中,选择 Vagrant 环境中的相应远程 Node.js 运行时。

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

    或者,单击 “浏览”按钮 ,位于 Node.js 运行时 字段旁边。 将打开 Node.js 运行时 对话框。

    点击 "添加"按钮 工具栏中的按钮,并从上下文菜单中选择 添加远程

    远程运行时对话框

    在 Vagrant 环境中配置远程 Node.js 运行时, 如上所述

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

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

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

    在 Vagrant 环境中运行应用程序
  • 或者,创建一个 Node.js 运行/调试配置,使用 Vagrant 环境中的 Node.js 运行时 如上所述 ,或修改现有配置并在对话框中点击 运行

检查应用程序输出

为了确保应用程序按预期工作,您可以从 PhpStorm 内置 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. 创建一个 Node.js 运行/调试配置,使用 Vagrant 环境中的 Node.js 运行时 如上所述

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

  4. 在打开的 调试工具窗口 中,继续调试会话——逐步执行断点 、在帧之间切换、动态更改值、 检查挂起的程序评估表达式 ,并 设置监视

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