现已推出！阅读关于 11 月份的新功能和修复。

调试适配器协议的新家

2018 年 8 月 7 日 André Weinand，@weinand

7 月里程碑的一个目标是将调试适配器协议（它隐藏在一个有点晦涩的 GitHub 项目中）移到一个更显眼的网站（请参阅功能请求 #19636）。

这篇博客提供了一些关于协议、调试适配器协议以及此举背后的动机的背景信息。

为什么需要通过协议进行解耦？

来自另一篇博客

“Visual Studio Code 是适用于任何开发人员的编辑器，无论您使用何种编程语言。”

这个承诺基于（至少）两个支柱

  • 一个可扩展的工具平台和生态系统，每个人都可以轻松贡献。
  • 使为任何编程语言添加出色工具支持变得容易的技术。

从开发工具支持一种编程语言意味着

  • 基于对语言的深入理解的丰富编辑支持（又名“语言智能化”）。
  • 集成到编辑工具中的语言调试支持。

后者可能会让一些人感到惊讶，但我们始终坚信调试是编写源代码的编辑器不可或缺的一部分。调试是开发“内部循环”的重要组成部分。

但是，为新的语言向 IDE 或编辑器添加调试器是一项重要的工作，因为标准调试功能列表不小

  • 源代码、函数、条件、内联断点和日志断点。
  • 在悬停或内联在源代码中显示变量值。
  • 多进程和多线程支持。
  • 浏览复杂的数据结构。
  • 监视表达式。
  • 用于交互式求值和自动完成的调试控制台 (REPL)。

为新的语言实现这些功能不仅是一项重要的工作，而且令人沮丧的是，对于每个开发工具都必须重复这项工作，因为每个工具都使用不同的 API 来实现其用户界面。

这导致大量重复的功能（和实现），如下图中的蓝色框所示

without Debug Adapter Protocol

当我们开始在 Visual Studio Code 上工作时，我们总是设想尽可能地将“前端”UI 与特定于语言的“后端”实现解耦。我们希望为语言智能和调试支持都做到这一点。

今天，我们相信我们已经实现了这个雄心勃勃的目标

我们创建了两个抽象协议，允许将“前端”中的编辑和调试用户界面与“后端”组件提供的特定于语言的智能和调试功能解耦。

“对语言的深入理解”由语言服务器协议 (LSP) 提供，而“调试支持”由调试适配器协议 (DAP) 提供。

调试适配器协议

调试适配器协议背后的理念是标准化一种抽象协议，用于开发工具的调试组件如何与具体的调试器或运行时进行通信。

由于假设现有调试器或运行时很快就会采用此协议是不现实的，因此我们设计了一个中间组件来接管将现有调试器或运行时 API 适配到调试适配器协议的角色。这个中间体变成了调试适配器，这解释了协议的名称：调试适配器协议。

以下是一个示例，说明开发工具如何使用 DAP 与流行的“gdb”调试器的调试适配器进行通信

breakpoint

我们假设用户已经启动了一个调试会话，但当前在程序的入口点停止，并希望设置（并稍后命中）一个断点。

  • 用户通过单击断点槽在特定的源文件中设置一个或多个断点。开发工具向调试适配器发送一个 setBreakpoints 请求，该请求向 gdb 调试器注册断点。
  • 然后，用户按下继续按钮以恢复执行。该工具向调试适配器发送一个 continue 请求，该请求将其转换为相应的 gdb 命令。
  • 一段时间后，命中该断点，并且调试适配器从 gdb 收到一些通知，并将其转换为发送到开发工具的 DAP stopped 事件。
  • 为了响应这个 stopped 事件，开发工具更新其 UI 并显示堆栈跟踪视图。这触发一个 stacktrace 请求，该请求返回为各个堆栈帧显示的所有信息。
  • 如果用户选择一个堆栈帧，开发工具会使用 variables 请求来请求该帧的变量。

由于历史原因，DAP 使用基于 JSON 的线路格式，该格式受（现已过时的）V8 调试协议的启发。请注意，此格式类似于但不兼容 LSP 中使用的 JSON-RPC。

在介绍了 DAP 通信的这个简短示例之后，让我们回顾一下 DAP 方法的特点

with Debug Adapter Protocol

该图显示了 DAP 方法的两个重要好处

  • 调试适配器可以在不同的开发工具之间共享，这有助于分摊其开发成本。
  • 调试适配器协议不绑定到 VS Code，可以作为其他开发工具中通用调试器 UI 的基础。

这些特征类似于 2016 年在其自己的网站上发布的语言服务器协议的特征。

DAP 的新家

现在，我们为调试适配器协议效仿，将 DAP 规范从其旧位置移动到新网站https://microsoft.github.io/debug-adapter-protocol 和相应的存储库 https://github.com/microsoft/debug-adapter-protocol。

此举应强调调试适配器协议并非 Visual Studio Code 所特有。例如，Visual Studio 现在也支持此协议。

在新位置，我们提供

旧位置将继续托管 DAP 的三个 npm 模块的源代码

下一步是什么？

由于调试适配器协议已经存在相当长的时间了，因此迁移到新网站实际上并不是开始，而只是迁移到新家...

我们想邀请所有现有的和未来的 DAP 用户访问我们的新家，并在那里继续合作。例如，您可以提交针对这些 Markdown 文件的 GitHub 拉取请求来帮助保持支持工具和实现的列表最新：调试适配器、工具和SDK。

代表 VS Code 团队：祝您编码愉快！

André Weinand - Twitter 上的 @weinand