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

VS Code Debug 怎样用 compound 同时启动多个配置

来源:17golang原创

时间:2026-11-19 12:06:06 294浏览 收藏

如果一个项目需要同时调试 API 服务和前端客户端,分别按 F5 启动两个配置很快就会变成重复操作。VS Code 的 compound 不是新的调试器,而是把已经存在的多个 launch 配置按名称组合成一个入口。

官方地址:https://code.visualstudio.com/docs/debugtest/debugging-configuration

做法是先让每个配置都能单独启动,再在同一个 launch.json 的 compounds 数组里填写这些配置的 name。启动 compound 后,VS Code 会并行启动被列出的配置;把 stopAll 设为 true,手动停止其中一个会话时,其余会话也会一起停止。

先把两个独立配置准备好

compound 只能组合已经存在的调试配置,不能替代调试扩展提供的 type、request、program 等字段。先打开项目文件夹,再从菜单进入“运行 → 添加配置”,或者在“运行和调试”视图中选择创建 launch.json。文件应放在工作区根目录的 .vscode/launch.json。

  1. 打开“运行和调试”视图,确认调试器扩展和项目运行时已经就绪。
  2. 在配置下拉框中分别选择 API Server 和 Web Client,单独按一次 F5。
  3. 每个配置都能独立进入断点,说明入口、参数和运行时依赖没有问题,再继续组合。

这里最重要的是名称。compounds.configurations 引用的是配置对象的 name,不是文件名、数组下标或显示顺序。名称改了,compound 中的引用也要同步改。

在 launch.json 中增加 compounds

在 configurations 数组旁边增加 compounds 数组。下面是一个只展示组合关系的 JSONC 示例,两个被调试目标仍然由各自的调试器扩展解释。

{
  "version": "0.2.0",
  "configurations": [
    {
      // 独立配置负责启动 API 服务,名称会被 compound 引用。
      "type": "node",
      "request": "launch",
      "name": "API Server",
      "program": "${workspaceFolder}/server.js"
    },
    {
      // 客户端也保持独立,便于先单独排查入口和参数。
      "type": "node",
      "request": "launch",
      "name": "Web Client",
      "program": "${workspaceFolder}/client.js"
    }
  ],
  "compounds": [
    {
      // 这里引用的是上面两个 name,不是配置数组下标。
      "name": "Full Stack",
      "configurations": ["API Server", "Web Client"],
      // 有默认构建任务时,先完成准备动作再启动调试会话。
      "preLaunchTask": "${defaultBuildTask}",
      // 手动停止一个会话时,同时结束 compound 中的其他会话。
      "stopAll": true
    }
  ]
}

保存文件后,配置下拉框应出现 Full Stack。如果编辑器标出红色波浪线,先悬停查看具体属性是否由当前调试器支持;VS Code 官方文档也提醒,不同调试器支持的字段并不完全相同。

原创界面说明图展示 launch.json 中 configurations 与 compounds 的组合关系
图1:launch.json 中两个独立配置通过名称进入 Full Stack compound;这是原创界面说明图,不是实际软件截图。

从 Run and Debug 启动组合配置

  1. 点击左侧活动栏的“运行和调试”,在顶部配置下拉框选择 Full Stack。
  2. 按 F5 或点击“启动调试”。VS Code 会同时启动 API Server 和 Web Client 对应的配置。
  3. 在“调用堆栈”区域观察两个顶层调试会话,点击会话名称可以切换当前变量、断点和编辑器上下文。
  4. 点击调试工具栏的停止按钮结束调试。如果 compound 使用了 stopAll: true,另一个会话也会一并结束。

“同时启动”不等于两个进程共享一个调用栈。每个配置仍然有自己的入口、变量、断点和调试器状态;compound 只提供统一启动入口以及可选的联动停止行为。

原创界面说明图展示 Run and Debug 中 Full Stack 及 API Server、Web Client 两个会话
图2:选择 Full Stack 后,在 Run and Debug 中分别看到 API Server 与 Web Client 会话;这是状态说明图,不代表某次真实运行结果。

把准备动作和停止策略说清楚

preLaunchTask 位于 compound 对象中时,可以在启动组合配置前执行一个任务,例如编译或生成开发资源。它引用的是任务标签,常见写法是 ${defaultBuildTask};如果项目没有默认构建任务,就不要为了“看起来完整”随意填写。

stopAll 解决的是收尾一致性。前后端需要一起停止时设为 true;如果你希望单独重启一个服务、保留另一个会话观察状态,可以不设置它或按团队工作流改为 false。这两个字段都不负责修复单个配置本身的入口错误。

compound 不出现或启动不对时怎么排查

  1. 先看工作区:必须打开文件夹或工作区,单独打开一个文件时不能管理工作区级的 launch.json。
  2. 再看文件结构:确认文件位于工作区根目录的 .vscode/launch.json,并且包含数组形式的 configurations。
  3. 核对名称:逐字比较 compound 中的名称与配置对象的 name,大小写、空格和标点都不能靠猜。
  4. 检查扩展:每个配置的 type 必须有对应且已启用的调试扩展;扩展未安装时,配置可能无法启动。
  5. 定位入口:如果只启动了一个目标,回到该配置单独启动,检查 program、cwd、args、环境变量和 preLaunchTask。

按照这个顺序能把“组合入口没出现”和“组合入口出现但某个目标启动失败”分开。前者多半是工作区、文件结构或配置名称问题,后者应回到失败的单个配置处理。

最后记住这张速查表

配置项作用检查重点
configurations定义可单独启动的调试会话type、request、入口和运行时
compounds把多个配置组合为一个启动入口引用的是配置 name
preLaunchTask启动前执行准备任务任务标签是否真实存在
stopAll停止一个会话时联动停止其他会话是否符合团队调试习惯

因此,最稳妥的顺序是“单独启动成功 → 按 name 组合 → 选择 compound 启动 → 观察两个独立会话”。不要把 compound 当成新的入口脚本,也不要用它掩盖某个单独配置的错误。

相关问题

  • compound 会按顺序启动配置吗?官方文档描述为并行启动,不能把数组顺序当成服务就绪顺序。
  • 为什么改了配置名后 compound 失效?因为 compound 保存的是名称引用,改名后必须同步更新。
  • 两个会话能共用断点吗?断点是否可用由对应调试器和代码路径决定,compound 本身不合并两个调试器。
  • preLaunchTask 是必须的吗?不是。只有确实需要构建或准备动作时才配置。
声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>