调试适配器协议的新家
2018 年 8 月 7 日 André Weinand，@weinand
七月里程碑的一个目标是将一直“隐藏”在一个鲜为人知的 GitHub 项目中的 调试适配器协议 (Debug Adapter Protocol) 迁移到一个更醒目的网站（请参阅功能请求 #19636）。
这篇博客将介绍一些关于协议、调试适配器协议的背景信息，以及此次迁移的动机。
为什么需要协议实现解耦？
来自另一篇博客
“Visual Studio Code 是面向任何开发人员的编辑器，无论您使用何种编程语言。”
这一承诺基于（至少）两大支柱
- 一个可扩展的工具平台和生态系统，每个人都可以轻松做出贡献。
- 一种易于为任何编程语言添加出色工具支持的技术。
从开发工具层面支持一种编程语言意味着：
- 基于对语言的深入理解（又称“语言智能”）提供丰富的编辑支持。
- 将语言的调试支持集成到编辑工具中。
后者可能会让一些人感到惊讶，但我们始终坚信调试是编写源代码的地方——编辑器——不可或缺的一部分。调试是开发“内部循环”的重要组成部分。
但是，将新语言的调试器添加到 IDE 或编辑器是一项艰巨的任务，因为标准调试功能的列表不小：
- 源文件、函数、条件、行内断点和日志点。
- 在悬停提示或源代码中内联显示的变量值。
- 多进程和多线程支持。
- 遍历复杂数据结构。
- 监视表达式。
- 带自动完成功能的交互式求值调试控制台 (REPL)。
为新语言实现这些功能不仅需要付出巨大的努力，而且令人沮丧的是，由于每个工具都使用不同的 API 来实现其用户界面，因此这项工作必须为每个开发工具重复进行。
这导致了大量的重复功能（和实现），如下图蓝色方框所示：
当我们开始开发 Visual Studio Code 时，我们始终设想尽可能将“前端”UI 与特定于语言的“后端”实现解耦。我们希望在语言智能和调试支持方面都实现这一点。
今天，我们相信我们已经实现了这个雄心勃勃的目标：
我们创建了两个抽象协议，可以将“前端”中的编辑和调试用户界面与“后端”组件提供的特定于语言的智能和调试功能解耦。
“对语言的深入理解”通过 语言服务器协议 (Language Server Protocol, LSP) 体现，而“调试支持”则通过调试适配器协议 (DAP) 体现。
调试适配器协议
调试适配器协议背后的理念是标准化一个抽象协议，用于开发工具的调试组件如何与具体的调试器或运行时进行通信。
由于假设现有调试器或运行时会很快采用此协议是不现实的，因此我们设计了一个中间组件来承担将现有调试器或运行时 API 适配到调试适配器协议的角色。这个中间组件就成为了调试适配器，这解释了协议的名称：调试适配器协议。
下面是一个开发工具如何使用 DAP 与流行的“gdb”调试器的调试适配器进行通信的示例：
我们假设用户已经启动了一个调试会话，但目前停在程序的入口点，并希望设置（并稍后命中）一个断点。
- 用户通过点击断点槽位在特定源文件中设置一个或多个断点。开发工具向调试适配器发送一个
setBreakpoints请求，调试适配器将断点注册到 gdb 调试器中。 - 然后用户按下 继续 按钮以恢复执行。该工具向调试适配器发送一个
continue请求，调试适配器将其转换为相应的 gdb 命令。 - 过了一段时间，断点被命中，调试适配器从 gdb 收到一些通知，并将其转换为 DAP
stopped事件，该事件被发送到开发工具。 - 为了响应这个
stopped事件，开发工具更新其 UI 并显示堆栈跟踪视图。这会触发一个stacktrace请求，该请求返回为单个堆栈帧显示的所有信息。 - 如果用户选择一个堆栈帧，开发工具会使用
variables请求获取该帧的变量。
由于历史原因，DAP 使用基于 JSON 的有线格式，灵感来自（现已废弃的）V8 调试协议。请注意，这种格式与 LSP 中使用的 JSON-RPC 相似但不兼容。
在简要介绍了 DAP 通信示例之后，让我们回顾一下 DAP 方法的特点：
这张图显示了 DAP 方法的两个重要优点：
- 调试适配器可以在不同的开发工具之间共享，这有助于分摊其开发成本。
- 调试适配器协议不限于 VS Code，可以作为其他开发工具中通用调试器 UI 的基础。
这些特点与 2016 年在其自己的网站上发布的语言服务器协议的特点相似。
DAP 的新家
现在，我们已经效仿语言服务器协议，将 DAP 规范从其旧位置迁移到一个新的网站 https://msdocs.cn/debug-adapter-protocol 和相应的仓库 https://github.com/microsoft/debug-adapter-protocol。
此次迁移应该强调调试适配器协议并非 Visual Studio Code 所特有。例如，Visual Studio 现在也支持此协议。
在新位置，我们提供：
- 协议的概述和介绍。
- 作为机器可处理的 JSON 模式的协议规范。
- 从协议规范自动生成的详细文档。
- 实现该协议的调试适配器。
- 托管该协议的开发工具。
- 支持该协议的SDK。
- bug、功能请求和拉取请求可以在新仓库的问题部分创建。
旧位置将继续托管 DAP 的三个 npm 模块的源代码：
下一步是什么？
由于调试适配器协议已经存在了一段时间，所以迁移到新网站并非真正意义上的开始，而只是搬到一个新家……
我们邀请 DAP 的所有现有和未来用户访问我们的新家，并继续在那进行协作。例如，您可以通过在 GitHub 上针对这些 Markdown 文件提交拉取请求来帮助保持支持工具和实现的列表最新：调试适配器、工具和SDK。
代表 VS Code 团队：祝您编码愉快！
André Weinand - Twitter 上的 @weinand