调试适配器协议的新家

Name: Visual Studio Code
Author: Microsoft

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

七月里程碑的一个目标是将调试适配器协议——它一直“隐藏”在一个有点模糊的GitHub项目中——迁移到一个更醒目的网站（参见功能请求#19636）。

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

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

摘自另一篇博客

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

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

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

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

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

为新的语言实现这些功能不仅是一项重大工作，而且令人沮丧的是，这项工作必须针对每个开发工具重复进行，因为每个工具都使用不同的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方法的两个重要优势：

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

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

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

在新位置，我们提供：

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

由于调试适配器协议已经存在了一段时间，所以迁移到新网站并不是真正意义上的创建，而只是搬到了一个新家……

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

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