登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  文章 >  软件教程

VS Code launch.json 怎样给多环境复用调试配置

来源:17golang原创

时间:2026-11-16 19:49:35 211浏览 收藏

VS Code 的多环境调试可以把公共路径写成 ${workspaceFolder},用 inputs 选择环境,再让 envFile 指向对应文件,少量差异放在 env 中覆盖。compounds 用于同时启动多个配置,不提供配置继承。下面以本地 Node.js 调试为例,不涉及远程生产环境。

官方地址:https://code.visualstudio.com/

调试配置文档:https://code.visualstudio.com/docs/debugtest/debugging-configuration

步骤一:打开项目并创建 launch.json

先准备已安装 Node.js 的本机环境。通过菜单 文件 → 打开文件夹 打开专用示例目录;在资源管理器中新建 server.cjs,粘贴下面的原创示例并保存。

// 此文件只展示环境值,便于比较两个调试会话
const environment = process.env.APP_ENV ?? 'unset';
const role = process.env.APP_ROLE ?? 'unset';
// 无网络监听或业务数据写入,继续运行后打印并退出
console.log({ environment, role });

点击活动栏的运行和调试图标,在侧栏点击创建 launch.json 文件,按提示选择 Node.js。若已有配置,使用菜单运行 → 打开配置打开现有文件。完成后,资源管理器应出现 .vscode/launch.json,编辑区显示配置内容,说明入口已就绪。

运行和调试侧栏及创建 launch.json 入口说明图
图1:原创界面说明图。侧栏展示创建配置入口,资源管理器展示项目中的 server.cjs 与 .vscode 目录,不是真实软件截图。

步骤二:填写可选择环境的 Node.js 配置

在 launch.json 编辑区,将示例内容替换为下面的完整 JSON。已有项目应合并数组条目,保留自己的配置。

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "name": "应用:选择环境",
      "program": "${workspaceFolder}/server.cjs",
      "cwd": "${workspaceFolder}",
      "envFile": "${workspaceFolder}/.env.${input:targetEnv}",
      "env": {
        "APP_ROLE": "debug-preview"
      },
      "console": "internalConsole",
      "stopOnEntry": true
    }
  ],
  "inputs": [
    {
      "id": "targetEnv",
      "type": "pickString",
      "description": "选择调试环境",
      "options": [
        "dev",
        "test"
      ],
      "default": "dev"
    }
  ]
}

program 指向同一个入口,cwd 固定项目目录;targetEnv 提供 dev 和 test 两个可选值;envFile 随选择指向 .env.dev 或 .env.test。Node.js 调试器的 env 会覆盖环境文件中的同名变量,因此这里明确将 APP_ROLE 设为 debug-preview。JSON 不支持注释,字段含义在此单独解释。

在资源管理器点击新建文件,分别建立以下两个根目录文件。不要把真实凭据填进这个示例。

.env.dev:

# 开发环境演示值,APP_ROLE 会被 launch.json 覆盖
APP_ENV=dev
APP_ROLE=file-default

.env.test:

# 测试环境使用独立文件,字段保持相同
APP_ENV=test
APP_ROLE=file-default

通过文件 → 全部保存保存。回到运行和调试侧栏,顶部配置下拉框应能选到“应用:选择环境”;资源管理器中两个环境文件与 server.cjs 均位于打开的根目录。这个状态意味着配置名已被识别,实际环境是否传入将在下一步观察。

launch.json 环境文件和选择调试环境下拉框说明图
图2:原创操作说明图。展示配置下拉框、dev/test 环境选择和两个环境文件的对应关系;短标签用于定位,不替代正文完整 JSON。

变量参考:https://code.visualstudio.com/docs/reference/variables-reference

Node.js 调试参考:https://code.visualstudio.com/docs/nodejs/nodejs-debugging

步骤三:运行并观察环境,按需组合会话

在运行和调试 → 配置下拉框选“应用:选择环境”,点击旁边绿色开始调试按钮,或使用菜单运行 → 启动调试。在“选择调试环境”列表中选 dev。因为配置启用了 stopOnEntry,程序应先暂停在入口,编辑器出现暂停位置,调试工具栏可见。

点击调试工具栏的继续,通过菜单视图 → 调试控制台查看示例对象:environment 应为 dev,role 应为 debug-preview。再次启动并选 test,environment 应改为 test。示例没有持续服务,打印后退出是预期行为。这里描述的是读者操作后的预期,不是本机执行记录。

Node.js 调试会话暂停位置及调试控制台环境字段说明图
图3:原创结果说明图。暂停位置、继续按钮与示例环境字段帮助读者定位观察点,图中状态不作为真实运行证据。

若要同时对照两个会话,可将 launch.json 改为下面的独立完整示例。它使用固定 env 值,便于区分会话;与前面的交互选择方案二选一即可。

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "name": "应用:开发",
      "program": "${workspaceFolder}/server.cjs",
      "env": {
        "APP_ENV": "dev",
        "APP_ROLE": "preview"
      },
      "stopOnEntry": true
    },
    {
      "type": "node",
      "request": "launch",
      "name": "应用:测试",
      "program": "${workspaceFolder}/server.cjs",
      "env": {
        "APP_ENV": "test",
        "APP_ROLE": "preview"
      },
      "stopOnEntry": true
    }
  ],
  "compounds": [
    {
      "name": "开发与测试对照",
      "configurations": [
        "应用:开发",
        "应用:测试"
      ],
      "stopAll": true
    }
  ]
}

这里两条配置分别命名为“应用:开发”和“应用:测试”,compound 通过这些名称引用它们。保存后在同一配置下拉框选择“开发与测试对照”,再点击开始调试。运行和调试侧栏的调用堆栈区域应能看到两个会话;选择不同会话观察各自变量。stopAll 让手动停止其中一个时一并停止该组合中的会话。

compound 的公共能力是组合启动,不会把父对象字段自动合并进各配置,也不保证一个服务先就绪另一个才启动。真正的多服务项目还需给实例安排独立端口;本例只打印环境,避免端口竞争干扰配置说明。

配置选择表与常见问题

需求建议方式需要记住
同一入口只运行一种环境inputs + envFile启动时选择环境
少量调试专用覆盖值env同名值覆盖环境文件
同时启动多个会话compounds引用配置名,不是继承
项目目录会变化workspaceFolder避免个人绝对路径

为什么换了 env 文件,运行值没有变化?

先看 env 中是否存在同名覆盖,再确认修改的是所选环境文件。已经运行的进程不会因文件保存自动获得新的进程环境,需停止后重新启动。

Python 或 Go 能直接照搬吗?

变量和组合的组织思路可以参考,但调试类型及环境字段支持由对应调试器决定。本文的 type、envFile 和运行观察以 Node.js 为范围。

能从另一条配置继承公共字段吗?

不要把 compounds 当作继承语法。少量配置可以接受显式重复;希望减少环境差异时,优先将差异集中到输入选择和环境文件。

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>