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。
- 打开“运行和调试”视图,确认调试器扩展和项目运行时已经就绪。
- 在配置下拉框中分别选择 API Server 和 Web Client,单独按一次 F5。
- 每个配置都能独立进入断点,说明入口、参数和运行时依赖没有问题,再继续组合。
这里最重要的是名称。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 官方文档也提醒,不同调试器支持的字段并不完全相同。

从 Run and Debug 启动组合配置
- 点击左侧活动栏的“运行和调试”,在顶部配置下拉框选择
Full Stack。 - 按 F5 或点击“启动调试”。VS Code 会同时启动
API Server和Web Client对应的配置。 - 在“调用堆栈”区域观察两个顶层调试会话,点击会话名称可以切换当前变量、断点和编辑器上下文。
- 点击调试工具栏的停止按钮结束调试。如果 compound 使用了
stopAll: true,另一个会话也会一并结束。
“同时启动”不等于两个进程共享一个调用栈。每个配置仍然有自己的入口、变量、断点和调试器状态;compound 只提供统一启动入口以及可选的联动停止行为。

把准备动作和停止策略说清楚
preLaunchTask 位于 compound 对象中时,可以在启动组合配置前执行一个任务,例如编译或生成开发资源。它引用的是任务标签,常见写法是 ${defaultBuildTask};如果项目没有默认构建任务,就不要为了“看起来完整”随意填写。
stopAll 解决的是收尾一致性。前后端需要一起停止时设为 true;如果你希望单独重启一个服务、保留另一个会话观察状态,可以不设置它或按团队工作流改为 false。这两个字段都不负责修复单个配置本身的入口错误。
compound 不出现或启动不对时怎么排查
- 先看工作区:必须打开文件夹或工作区,单独打开一个文件时不能管理工作区级的
launch.json。 - 再看文件结构:确认文件位于工作区根目录的
.vscode/launch.json,并且包含数组形式的configurations。 - 核对名称:逐字比较 compound 中的名称与配置对象的
name,大小写、空格和标点都不能靠猜。 - 检查扩展:每个配置的
type必须有对应且已启用的调试扩展;扩展未安装时,配置可能无法启动。 - 定位入口:如果只启动了一个目标,回到该配置单独启动,检查
program、cwd、args、环境变量和preLaunchTask。
按照这个顺序能把“组合入口没出现”和“组合入口出现但某个目标启动失败”分开。前者多半是工作区、文件结构或配置名称问题,后者应回到失败的单个配置处理。
最后记住这张速查表
| 配置项 | 作用 | 检查重点 |
|---|---|---|
configurations | 定义可单独启动的调试会话 | type、request、入口和运行时 |
compounds | 把多个配置组合为一个启动入口 | 引用的是配置 name |
preLaunchTask | 启动前执行准备任务 | 任务标签是否真实存在 |
stopAll | 停止一个会话时联动停止其他会话 | 是否符合团队调试习惯 |
因此,最稳妥的顺序是“单独启动成功 → 按 name 组合 → 选择 compound 启动 → 观察两个独立会话”。不要把 compound 当成新的入口脚本,也不要用它掩盖某个单独配置的错误。
相关问题
- compound 会按顺序启动配置吗?官方文档描述为并行启动,不能把数组顺序当成服务就绪顺序。
- 为什么改了配置名后 compound 失效?因为 compound 保存的是名称引用,改名后必须同步更新。
- 两个会话能共用断点吗?断点是否可用由对应调试器和代码路径决定,compound 本身不合并两个调试器。
- preLaunchTask 是必须的吗?不是。只有确实需要构建或准备动作时才配置。
-
474 收藏
-
381 收藏
-
293 收藏
-
407 收藏
-
164 收藏
-
398 收藏
-
431 收藏
-
152 收藏
-
100 收藏
-
166 收藏
-
文章 · 软件教程 | 31分钟前 | 软件教程 · VS Code Screencast Mode 快捷键提示 Only Keyboard Shortcuts Developer Toggle Screencast Mode188 收藏
-
432 收藏
-
308 收藏
-
201 收藏
-
168 收藏
-
417 收藏
-
374 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 485次学习