调试器扩展
Visual Studio Code 的调试架构允许扩展作者轻松地将现有的调试器集成到 VS Code 中，同时拥有一个通用的用户界面。
VS Code 附带一个内置的调试器扩展，即 Node.js 调试器扩展，它很好地展示了 VS Code 支持的许多调试器功能。
此屏幕截图显示了以下调试功能
- 调试配置管理。
- 用于启动/停止和单步执行的调试操作。
- 源、函数、条件、内联断点和日志点。
- 调用堆栈，包括多线程和多进程支持。
- 在视图和悬停中浏览复杂的数据结构。
- 变量值显示在悬停提示中或内联在源代码中。
- 管理监视表达式。
- 用于交互式评估和自动完成的调试控制台。
本文档将帮助您创建调试器扩展，使任何调试器都能在 VS Code 中工作。
VS Code 的调试架构
VS Code 基于我们引入的抽象协议实现了一个通用的（与语言无关）调试器 UI，以便与调试器后端通信。因为调试器通常不实现此协议，所以需要一些中介来“适配”调试器以使其符合协议。此中介通常是一个与调试器通信的独立进程。
我们将此中介称为调试适配器（简称为 DA），并且在 DA 和 VS Code 之间使用的抽象协议是调试适配器协议（简称为 DAP）。由于调试适配器协议独立于 VS Code，因此它有自己的网站，您可以在其中找到介绍和概述、详细的规范和一些包含已知实现和支持工具的列表。DAP 的历史和动机在这篇博客文章中进行了解释。
由于调试适配器独立于 VS Code 并且可以在其他开发工具中使用，因此它们与基于扩展和贡献点的 VS Code 可扩展性架构不匹配。
因此，VS Code 提供了一个贡献点 `debuggers`，可以在特定的调试类型（例如，Node.js 调试器的 `node`）下贡献调试适配器。每当用户启动该类型的调试会话时，VS Code 都会启动注册的 DA。
因此，在最简单的形式下，调试器扩展只是调试适配器实现的声明性贡献，并且扩展基本上是调试适配器的打包容器，没有任何附加代码。
更真实的调试器扩展会向 VS Code 贡献以下许多或全部声明性项
- 调试器支持的语言列表。VS Code 启用 UI 为这些语言设置断点。
- 调试器引入的调试配置属性的 JSON 架构。VS Code 使用此架构来验证 launch.json 编辑器中的配置并提供 IntelliSense。请注意，不支持 JSON 架构构造 `$ref` 和 `definition`。
- VS Code 创建的初始 launch.json 的默认调试配置。
- 用户可以添加到 launch.json 文件的调试配置代码片段。
- 可以在调试配置中使用的变量声明。
您可以在 `contributes.breakpoints` 和 `contributes.debuggers` 参考中找到更多信息。
除了上述纯声明性的贡献之外，调试扩展 API 还支持以下基于代码的功能
- 为 VS Code 创建的初始 launch.json 动态生成默认调试配置。
- 动态确定要使用的调试适配器。
- 在将调试配置传递给调试适配器之前，验证或修改调试配置。
- 与调试适配器通信。
- 向调试控制台发送消息。
在本文档的其余部分，我们将展示如何开发调试器扩展。
Mock 调试扩展
由于从头开始创建调试适配器对于本教程来说有点繁琐，因此我们将从一个简单的 DA 开始，我们已将其创建为教育性的“调试适配器入门工具包”。它被称为 *Mock Debug*，因为它不与真实的调试器通信，而是模拟一个调试器。Mock Debug 模拟调试器并支持单步执行、继续、断点、异常和变量访问，但它未连接到任何真实的调试器。
在深入研究 mock-debug 的开发设置之前，我们先从 VS Code Marketplace 安装一个预构建版本并试用一下
- 切换到“扩展”视图，然后键入“mock”以搜索 Mock Debug 扩展。
- “安装”并“重新加载”扩展。
尝试 Mock Debug：
- 创建一个新的空文件夹 `mock test` 并在 VS Code 中打开它。
- 创建一个文件 `readme.md` 并输入几行任意文本。
- 切换到“运行和调试”视图（⇧⌘D（Windows，Linux Ctrl+Shift+D）），然后选择 创建 launch.json 文件链接。
- VS Code 将让您选择一个“调试器”以创建默认的启动配置。选择“Mock Debug”。
- 按绿色的 启动 按钮，然后按 Enter 确认建议的文件 `readme.md`。
调试会话启动，您可以“单步执行”readme 文件，设置和命中断点，并遇到异常（如果某行中出现单词 `exception`）。
在将 Mock Debug 用作您自己开发的起点之前，我们建议首先卸载预构建的版本
- 切换到“扩展”视图，然后单击 Mock Debug 扩展的齿轮图标。
- 运行“卸载”操作，然后“重新加载”窗口。
Mock 调试的开发设置
现在，让我们获取 Mock Debug 的源代码并在 VS Code 中开始开发
git clone https://github.com/microsoft/vscode-mock-debug.git
cd vscode-mock-debug
yarn
在 VS Code 中打开项目文件夹 `vscode-mock-debug`。
软件包中有什么？
- `package.json` 是 mock-debug 扩展的清单
- 它列出了 mock-debug 扩展的贡献。
- `compile` 和 `watch` 脚本用于将 TypeScript 源代码转换为 `out` 文件夹，并监视后续的源代码修改。
- 依赖项 `vscode-debugprotocol`、`vscode-debugadapter` 和 `vscode-debugadapter-testsupport` 是简化基于节点的调试适配器开发的 NPM 模块。
- `src/mockRuntime.ts` 是一个具有简单调试 API 的 *mock* 运行时。
- 将运行时 *适配* 到调试适配器协议的代码位于 `src/mockDebug.ts` 中。在这里，您可以找到 DAP 的各种请求的处理程序。
- 由于调试器扩展的实现位于调试适配器中，因此根本不需要扩展代码（即，在扩展主机进程中运行的代码）。但是，Mock Debug 有一个小的 `src/extension.ts`，因为它说明了可以在调试器扩展的扩展代码中执行的操作。
现在，通过选择 扩展 启动配置并按 `F5` 来构建和启动 Mock Debug 扩展。最初，这将把 TypeScript 源代码完全转换为 `out` 文件夹。完全构建后，将启动一个 *监视器任务*，该任务将转换您所做的任何更改。
转换源代码后，会出现一个标记为“[扩展开发主机]”的新 VS Code 窗口，其中 Mock Debug 扩展现在以调试模式运行。在该窗口中，打开您的 `mock test` 项目（其中包含 `readme.md` 文件），使用“F5”启动调试会话，然后单步执行它
由于您正在以调试模式运行扩展，因此您现在可以在 `src/extension.ts` 中设置和命中断点，但正如我上面提到的，扩展中没有太多有趣的代码在执行。有趣的代码在调试适配器（一个单独的进程）中运行。
为了调试调试适配器本身，我们必须以调试模式运行它。最容易实现此目的的方法是以 *服务器模式* 运行调试适配器，并将 VS Code 配置为连接到它。在您的 VS Code vscode-mock-debug 项目中，从下拉菜单中选择启动配置 服务器，然后按绿色的启动按钮。
由于我们已经有一个活动扩展的调试会话，因此 VS Code 调试器 UI 现在进入 *多会话* 模式，这通过在“调用堆栈”视图中显示两个调试会话的名称 扩展 和 服务器 来表示
现在，我们可以同时调试扩展和 DA。一种更快的方法是使用 扩展 + 服务器 启动配置，该配置会自动启动两个会话。
有关调试扩展和 DA 的另一种更简单的方法，请参见下文。
在文件 src/mockDebug.ts 的 launchRequest(...) 方法的开头设置一个断点，最后一步，通过在你的模拟测试启动配置中添加一个端口为 4711 的 debugServer 属性，来配置模拟调试器连接到 DA 服务器。
{
"version": "0.2.0",
"configurations": [
{
"type": "mock",
"request": "launch",
"name": "mock test",
"program": "${workspaceFolder}/readme.md",
"stopOnEntry": true,
"debugServer": 4711
}
]
}
如果你现在启动这个调试配置，VS Code 不会启动模拟调试适配器作为一个单独的进程，而是直接连接到已经运行的服务器的本地端口 4711，你应该会在 launchRequest 中命中该断点。
通过这种设置，你现在可以轻松地编辑、转译和调试模拟调试器。
但现在真正的工作开始了：你必须将 src/mockDebug.ts 和 src/mockRuntime.ts 中调试适配器的模拟实现替换为一些与“真实”调试器或运行时通信的代码。这涉及到理解和实现调试适配器协议。更多详细信息可以在这里找到。
调试器扩展的 package.json 剖析
除了提供调试器特定的调试适配器实现外，调试器扩展还需要一个 package.json 文件，该文件会向各种与调试相关的贡献点进行贡献。
现在让我们仔细看看模拟调试器的 package.json 文件。
与每个 VS Code 扩展一样，package.json 声明了扩展的基本属性，名称、发布者和版本。使用 categories 字段可以使该扩展更容易在 VS Code 扩展市场中找到。
{
"name": "mock-debug",
"displayName": "Mock Debug",
"version": "0.24.0",
"publisher": "...",
"description": "Starter extension for developing debug adapters for VS Code.",
"author": {
"name": "...",
"email": "..."
},
"engines": {
"vscode": "^1.17.0",
"node": "^7.9.0"
},
"icon": "images/mock-debug-icon.png",
"categories": ["Debuggers"],
"contributes": {
"breakpoints": [{ "language": "markdown" }],
"debuggers": [
{
"type": "mock",
"label": "Mock Debug",
"program": "./out/mockDebug.js",
"runtime": "node",
"configurationAttributes": {
"launch": {
"required": ["program"],
"properties": {
"program": {
"type": "string",
"description": "Absolute path to a text file.",
"default": "${workspaceFolder}/${command:AskForProgramName}"
},
"stopOnEntry": {
"type": "boolean",
"description": "Automatically stop after launch.",
"default": true
}
}
}
},
"initialConfigurations": [
{
"type": "mock",
"request": "launch",
"name": "Ask for file name",
"program": "${workspaceFolder}/${command:AskForProgramName}",
"stopOnEntry": true
}
],
"configurationSnippets": [
{
"label": "Mock Debug: Launch",
"description": "A new configuration for launching a mock debug program",
"body": {
"type": "mock",
"request": "launch",
"name": "${2:Launch Program}",
"program": "^\"\\${workspaceFolder}/${1:Program}\""
}
}
],
"variables": {
"AskForProgramName": "extension.mock-debug.getProgramName"
}
}
]
},
"activationEvents": ["onDebug", "onCommand:extension.mock-debug.getProgramName"]
}
现在看看 contributes 部分，其中包含调试扩展特有的贡献。
首先，我们使用 breakpoints 贡献点来列出将启用设置断点的语言。没有这个，将无法在 Markdown 文件中设置断点。
接下来是 debuggers 部分。在这里，在调试 type mock 下引入了一个调试器。用户可以在启动配置中引用此类型。可选属性 label 可用于在 UI 中显示调试类型时为其提供一个友好的名称。
由于调试扩展使用调试适配器，因此会给出其代码的相对路径作为 program 属性。为了使扩展自包含，应用程序必须位于扩展文件夹内。按照惯例，我们将此应用程序保留在名为 out 或 bin 的文件夹中，但你可以自由使用不同的名称。
由于 VS Code 在不同的平台上运行，我们必须确保 DA 程序也支持不同的平台。为此，我们有以下选项
-
如果程序以平台无关的方式实现，例如作为在所有受支持平台上都可用的运行时上运行的程序，则可以通过 runtime 属性指定此运行时。截至今天，VS Code 支持
node和mono运行时。我们上面的模拟调试适配器使用了这种方法。 -
如果你的 DA 实现需要在不同的平台上有不同的可执行文件，则可以为特定的平台限定 program 属性，如下所示
"debuggers": [{ "type": "gdb", "windows": { "program": "./bin/gdbDebug.exe", }, "osx": { "program": "./bin/gdbDebug.sh", }, "linux": { "program": "./bin/gdbDebug.sh", } }] -
也可以组合使用这两种方法。以下示例来自 Mono DA，它作为需要在 macOS 和 Linux 上运行时的 mono 应用程序实现，但在 Windows 上不需要
"debuggers": [{ "type": "mono", "program": "./bin/monoDebug.exe", "osx": { "runtime": "mono" }, "linux": { "runtime": "mono" } }]
configurationAttributes 声明了此调试器可用的 launch.json 属性的模式。此模式用于验证 launch.json，并在编辑启动配置时支持 IntelliSense 和悬停帮助。
initialConfigurations 定义了此调试器的默认 launch.json 的初始内容。当项目没有 launch.json 且用户启动调试会话或在“运行和调试”视图中选择“创建 launch.json 文件”链接时，会使用此信息。在这种情况下，VS Code 让用户选择一个调试环境，然后创建相应的 launch.json
除了在 package.json 中静态定义 launch.json 的初始内容外，还可以通过实现 DebugConfigurationProvider 来动态计算初始配置（有关详细信息，请参阅下面的 使用 DebugConfigurationProvider 部分）。
configurationSnippets 定义了在编辑 launch.json 时在 IntelliSense 中显示的启动配置代码段。按照惯例，代码段的 label 属性应以调试环境名称为前缀，以便在许多代码段建议列表中显示时可以清楚地识别它。
variables 贡献将“变量”绑定到“命令”。这些变量可以使用 ${command:xyz} 语法在启动配置中使用，并且在启动调试会话时，这些变量将被绑定命令返回的值替换。
命令的实现在扩展中，它可以从没有 UI 的简单表达式，到基于扩展 API 中可用的 UI 功能的复杂功能。模拟调试将变量 AskForProgramName 绑定到命令 extension.mock-debug.getProgramName。此命令在 src/extension.ts 中的实现使用了 showInputBox 来让用户输入程序名称。
vscode.commands.registerCommand('extension.mock-debug.getProgramName', config => {
return vscode.window.showInputBox({
placeHolder: 'Please enter the name of a markdown file in the workspace folder',
value: 'readme.md'
});
});
现在可以在启动配置的任何字符串类型的值中将该变量用作 ${command:AskForProgramName}。
使用 DebugConfigurationProvider
如果 package.json 中调试贡献的静态性质不足，则可以使用 DebugConfigurationProvider 来动态控制调试扩展的以下方面
- 可以动态生成新创建的 launch.json 的初始调试配置，例如基于工作区中可用的某些上下文信息。
- 可以在使用启动配置启动新的调试会话之前解析（或修改）启动配置。这允许基于工作区中可用的信息填充默认值。存在两种 resolve 方法：
resolveDebugConfiguration在启动配置中替换变量之前调用，resolveDebugConfigurationWithSubstitutedVariables在所有变量都被替换后调用。如果验证逻辑在调试配置中插入了其他变量，则必须使用前者。如果验证逻辑需要访问所有调试配置属性的最终值，则必须使用后者。
src/extension.ts 中的 MockConfigurationProvider 实现了 resolveDebugConfiguration 来检测在不存在 launch.json 但活动编辑器中打开了 Markdown 文件时启动调试会话的情况。这是一个典型的场景，用户在编辑器中打开了一个文件，并且只是想调试它而无需创建 launch.json。
调试配置提供程序通过 vscode.debug.registerDebugConfigurationProvider 为特定调试类型注册，通常在扩展的 activate 函数中注册。为了确保尽早注册 DebugConfigurationProvider，必须在首次使用调试功能时激活扩展。可以通过在 package.json 中为 onDebug 事件配置扩展激活来轻松实现这一点。
"activationEvents": [
"onDebug",
// ...
],
只要使用任何调试功能，就会触发这个包罗万象的 onDebug。只要扩展的启动成本不高（即不会在其启动序列中花费大量时间），就可以正常工作。如果调试扩展的启动成本很高（例如，因为启动了语言服务器），则 onDebug 激活事件可能会对其他调试扩展产生负面影响，因为它触发得比较早，并且没有考虑特定的调试类型。
对于启动成本高的调试扩展，更好的方法是使用更细粒度的激活事件
onDebugInitialConfigurations在调用DebugConfigurationProvider的provideDebugConfigurations方法之前触发。onDebugResolve:type在调用指定类型的DebugConfigurationProvider的resolveDebugConfiguration或resolveDebugConfigurationWithSubstitutedVariables方法之前触发。
经验法则：如果调试扩展的激活成本很低，则使用 onDebug。如果成本很高，则使用 onDebugInitialConfigurations 和/或 onDebugResolve，具体取决于 DebugConfigurationProvider 是否实现了相应的方法 provideDebugConfigurations 和/或 resolveDebugConfiguration。
发布您的调试器扩展
创建调试器扩展后，你可以将其发布到市场。
- 更新
package.json中的属性以反映调试器扩展的命名和用途。 - 按照发布扩展中的描述上传到市场。
开发调试器扩展的替代方法
正如我们所看到的，开发调试器扩展通常涉及在两个并行会话中调试扩展和调试适配器。如上所述，VS Code 对此提供了良好的支持，但是如果扩展和调试适配器都是可以在一个调试会话中调试的程序，则开发可能会更容易。
只要你的调试适配器是用 TypeScript/JavaScript 实现的，这种方法实际上很容易实现。基本思想是在扩展内部直接运行调试适配器，并使 VS Code 连接到它，而不是为每个会话启动新的外部调试适配器。
为此，VS Code 提供了扩展 API 来控制调试适配器的创建和运行方式。当调试会话启动并且需要调试适配器时，DebugAdapterDescriptorFactory 具有一个 createDebugAdapterDescriptor 方法，该方法由 VS Code 调用。此方法必须返回一个描述调试适配器如何运行的描述符对象 (DebugAdapterDescriptor)。
目前，VS Code 支持三种不同的方式来运行调试适配器，因此提供了三种不同的描述符类型
DebugAdapterExecutable：此对象将调试适配器描述为具有路径和可选参数和运行时的外部可执行文件。可执行文件必须实现调试适配器协议，并通过 stdin/stdout 进行通信。这是 VS Code 的默认操作模式，如果没有显式注册DebugAdapterDescriptorFactory，则 VS Code 会自动使用来自 package.json 的相应值来使用此描述符。DebugAdapterServer：此对象将调试适配器描述为作为服务器运行，该服务器通过特定的本地或远程端口进行通信。基于vscode-debugadapternpm 模块的调试适配器实现会自动支持此服务器模式。DebugAdapterInlineImplementation：此对象将调试适配器描述为实现vscode.DebugAdapter接口的 JavaScript 或 Typescript 对象。基于vscode-debugadapternpm 模块 1.38-pre.4 或更高版本的调试适配器实现会自动实现此接口。
模拟调试展示了 三种类型的 DebugAdapterDescriptorFactories 的示例，以及它们如何为“mock”调试类型注册。要使用的运行模式可以通过将全局变量 runMode 设置为 external、server 或 inline 的可能值之一来选择。
对于开发，inline 和 server 模式特别有用，因为它们允许在单个进程中调试扩展和调试适配器。