尝试以扩展 VS Code 中的代理模式！

Debug Adapter Protocol 的新家

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

七月里程碑的一个目标是将Debug Adapter Protocol——它一直“藏身”于一个有些隐蔽的GitHub 项目中——迁移到一个更显眼的网站（参见功能请求#19636）。

这篇博客提供了有关协议、Debug Adapter Protocol 以及此次迁移背后动机的一些背景信息。

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

摘自另一篇博客

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

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

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

开发工具对编程语言的支持意味着

  • 基于对语言的深刻理解（也称为“语言智能”）的丰富编辑支持。
  • 集成到编辑工具中的语言调试支持。

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

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

  • 源、函数、条件、行内断点和日志点。
  • 悬停显示或行内显示变量值。
  • 多进程和多线程支持。
  • 遍历复杂数据结构。
  • 监视表达式。
  • 带自动补全功能的交互式评估调试控制台 (REPL)。

为新语言实现这些功能不仅需要付出巨大的努力，而且令人沮丧的是，由于每个开发工具都使用不同的 API 来实现其用户界面，这项工作必须针对每个工具重复进行。

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

without Debug Adapter Protocol

当我们开始开发 Visual Studio Code 时，我们一直设想尽可能地将“前端”UI 与特定语言的“后端”实现解耦。我们希望对语言智能和调试支持都这样做。

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

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

“对语言的深刻理解”由Language Server Protocol (LSP) 体现，“调试支持”则由 Debug Adapter Protocol (DAP) 体现。

Debug Adapter Protocol

Debug Adapter Protocol 背后的理念是，为开发工具的调试组件如何与具体的调试器或运行时通信，标准化一个抽象协议。

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

以下是开发工具如何使用 DAP 与流行“gdb”调试器的 Debug Adapter 进行通信的示例

breakpoint

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

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

由于历史原因，DAP 使用基于 JSON 的有线格式，灵感来自（现已过时）的V8 调试协议。请注意，此格式与 LSP 中使用的 JSON-RPC 相似但不兼容。

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

with Debug Adapter Protocol

图片显示了 DAP 方法的两个重要优点

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

这些特性与 2016 年在其独立网站上发布的 Language Server Protocol 的特性类似。

DAP 的新家

现在我们为 Debug Adapter Protocol 效仿，将其规范从旧位置迁移到一个新网站https://msdocs.cn/debug-adapter-protocol 以及相应的仓库https://github.com/microsoft/debug-adapter-protocol。

此次迁移应强调 Debug Adapter Protocol 并非 Visual Studio Code 所特有。例如，Visual Studio 现在也支持此协议。

在新位置我们提供了

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

接下来是什么？

由于 Debug Adapter Protocol 已经面世一段时间了，所以迁移到新网站并非真正的起始，而仅仅是搬家到新家……

我们邀请所有现有和未来的 DAP 用户访问我们的新家，并在那里继续协作。例如，您可以通过在 GitHub 上对这些 Markdown 文件提交拉取请求来帮助保持支持工具和实现列表的最新状态：Debug Adapters、Tools 和 SDKs。

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

André Weinand -  @weinand (Twitter)