Logpoints 和自动附加功能简介
2018 年 7 月 12 日 Kenneth Auchenberg，@auchenberg
在过去的几个月中，我们一直致力于改进 Visual Studio Code 中的调试体验。在这篇文章中，我将介绍我们如何看待调试，展示我们从用户那里听到的反馈，并解释我们正在采取哪些步骤来使 VS Code 中的调试更加轻松和简单。
自从 VS Code 诞生之初，我们就推出了集成的调试体验，因为我们认为调试应该是您编写和编辑源代码的地方——您的编辑器的组成部分。
VS Code 调试体验由通用的调试器 UI 提供支持，该 UI 通过调试适配器协议 (Debug Adapter Protocol, DAP) 与特定类型的 VS Code 扩展（我们称之为调试适配器 (Debug Adapter, DA)）进行通信。DA 与实际的调试器对话，并在 DAP 和调试器的运行时特定调试协议或 API 之间进行转换。
这意味着 VS Code 的核心与特定调试器完全解耦，并且这种架构允许 VS Code 调试任何内容，只要有可用的调试适配器，如此处所示
观察和痛点
如今，有大量的满意开发人员 регулярно 使用 VS Code 进行调试，但是，作为我们使命的一部分，我们希望使调试更轻松，并为更多开发人员所用。
为此，我们开始对话，以更好地了解 VS Code 中调试的痛点，并了解为什么有些开发人员根本不使用我们的调试器。
以下是我们的观察结果
调试配置很难正确设置
VS Code 是一个通用的编辑器，具有通用的调试器，并非专门针对特定的堆栈或运行时。因此，我们无法提供适用于所有人的有主见的默认调试配置。
这意味着 VS Code 要求您配置调试器的设置，并指定您希望如何使用正确的参数等启动运行时。
我们认识到这可能很难正确设置，但是我们看不到完全消除所有人的调试配置的方法。但是，我们确实认为可以简化调试配置，并且根据上下文，可以将其减少到最低限度。
稍后我会回到这一点。
启动和附加配置之间的混淆
在 VS Code 中，我们有两个核心调试概念：启动 (Launch) 和 附加 (Attach)，它们处理两种不同的工作流程和开发人员群体。根据您的工作流程，可能很难知道哪种类型的配置适合您的项目。
如果您来自浏览器 DevTools 背景，则不习惯“从您的工具启动”的概念，因为您的浏览器实例已经打开。当您打开 DevTools 时，您只是将 DevTools 附加到您打开的浏览器选项卡。另一方面，如果您来自 Java 背景，则您的编辑器为您启动 Java 进程是很正常的，并且您的编辑器会自动将其调试器附加到新启动的进程。
解释 启动 和 附加 之间差异的最佳方法是将 启动配置 视为一个配方，说明如何在 VS Code 附加到您的应用程序之前，以调试模式启动您的应用程序；而 附加配置 是一个配方，说明如何将 VS Code 的调试器连接到已经运行的应用程序或进程。
启动配置 的价值在于，它们为您提供了一种方法，通过创建可重复且可与您的项目和团队共享的配置，来减轻使用正确的调试参数启动应用程序的一些认知负担。
但是，当我们与开发人员讨论他们如何启动应用程序时，我们看到了一个模式，并得出了一个重要的观察结果
观察结果：许多使用 VS Code 的开发人员非常喜欢集成终端 (Integrated Terminal)，并依赖命令行工具来启动他们的应用程序。对于许多人来说，在终端中运行命令，然后从编辑器附加调试器，是一种更自然的工作流程。这类似于在浏览器启动后打开 DevTools。
这个观察结果是关键，我们意识到许多用户不希望在他们的编辑器中获得完整的“神奇”启动体验。他们希望将编辑器作为编辑和调试源代码的地方，并使用终端来启动应用程序、运行构建脚本等。这就是我们在 VS Code 中提供集成终端体验的原因之一，因为我们认为一个好的功能性 UI 应该与终端共存并良好集成。
许多开发人员不使用断点，因为他们正在检查状态更改
在研究开发人员如何调试他们的应用程序时，我们还看到了另一个有趣的模式：使用日志记录而不是断点。
日志记录用于调试并不是一个新概念，但这个观察结果很重要
观察结果：传统的调试工作流程最关注减慢执行速度以检查程序逻辑，而日志记录工作流程通常涉及检查程序状态及其在应用程序正常执行期间如何更改。这里的基本观察结果是，这两种技术用于不同的调试目的。
此观察结果对于 JavaScript 开发人员尤为重要，他们主要处理管理状态的复杂性，这可能解释了为什么 大多数 JavaScript 开发人员仍然更喜欢在他们的源代码中添加 console.log，而不是使用脚本调试器。
自动附加到 Node 进程
当反思一些开发人员如何使用集成终端来启动他们的调试会话时，我们看到了一个独特的机遇出现。通过利用我们从您的编辑器和集成终端在 VS Code 中获得的上下文信息，我们可以检测您的上下文并推断您调试的意图，这可以为 Node.js 开发人员提供更简单的调试体验。
因此，在 VS Code 的 三月份迭代 中，我们发布了一项名为 Node 自动附加 (Auto Attach for Node) 的新功能，该功能使 Node 调试器能够自动附加到从 VS Code 的集成终端以调试模式启动的 Node.js 进程。
您可以通过从命令面板 (Command Palette) 运行 调试：切换自动附加 (Debug: Toggle Auto Attach) 命令来启用自动附加，并且一旦激活，您也可以从状态栏 (Status Bar) 切换自动附加。
此功能完全消除了任何调试配置，因为我们将任何使用 node --inspect 启动的 Node.js 进程都解释为调试意图。当与集成终端结合使用时，这是一种更简单的调试体验，它允许开发人员以自己的方式启动他们的应用程序，同时消除调试配置！🎉
NPM 脚本和调试
许多 Node.js 开发人员依赖 npm 脚本 来启动应用程序或启动调试会话，并且我们在这方面也有一些好消息：自动附加也适用于 npm 脚本。如果您运行 npm run debug 并且 "debug" 脚本是 "node --inspect" 或任何其他包含 --inspect 的命令，则自动附加将检测到这一点并附加调试器 🎉
我们还认识到，一些开发人员想要一种更直观的方式来查找和运行他们的 npm 脚本，因此在 我们的 2018 年 4 月迭代 中，我们添加了一个新的 NPM 脚本资源管理器 (NPM scripts explorer)，允许您直接从 UI 浏览和运行您的 NPM 脚本。作为我们简化调试配置工作的一部分，我们还使直接从资源管理器启动 Node.js 调试成为可能，而无需创建调试配置。
如果您的 npm 脚本包含诸如 --inspect 之类的调试参数，我们将自动检测到这一点，并提供一个启动调试器的调试操作，如此处所示
Logpoints 简介
基于日志记录是一种重要的调试技术的认识，我们看到了将状态检查添加到我们现有调试体验中的机会。在 VS Code 的 三月份迭代 中，我们发布了我们称为 Logpoints 的调试功能的第一个实现。
Logpoint 是一种断点变体，它不会“中断”到调试器中，而是将消息记录到控制台。
Logpoints 的概念并不新鲜，在过去的几年中，我们在 Visual Studio、Edge DevTools 和 GDB 等工具中看到了此概念的不同变体，名称包括 Tracepoints 和 Logpoints。
为什么以及何时使用 Logpoints？
Logpoints 基于这样的观察：在许多情况下，您不希望在应用程序的特定部分停止执行，而是希望检查状态如何在应用程序的整个生命周期中发生变化。
Logpoints 允许您将按需日志记录语句“注入”到您的应用程序逻辑中，就像您在启动应用程序之前已将日志记录语句添加到您的应用程序中一样。Logpoints 在执行时注入，而不是持久保存在源代码中，因此您不必提前计划，而可以在需要时注入 Logpoints。另一个好处是，您不必担心在完成调试后清理您的源代码。
对于 JavaScript 开发人员而言，这意味着您不必再担心留下 console.log 了——只需使用 Logpoints！更好的是，您可以结合使用 console.log 和 Logpoints。如果您将 Logpoint 插入到已经有 console.log 的源代码块中，您将在调试控制台 (Debug Console) 中看到两种类型的日志记录语句。
云环境中的 Logpoints
Logpoints 在云环境（或任何远程环境）中尤其有用，因为它们使您能够在无需重新部署应用程序的情况下将日志记录注入到远程环境中。同样重要的是，您不会使用 Logpoints 停止脚本执行，因此您的用户不会受到影响，这与在常规断点上停止运行应用程序不同。
您可以阅读更多关于如何 在 Azure 上为 Node.js 使用 Logpoints 的信息。
支持的语言
自从 VS Code 中首次发布 Logpoints 以来，我们看到 VS Code 调试适配器越来越多地采用 Logpoints，如今，以下语言支持 Logpoints
- Node.js 调试器
- Chrome 调试器
- Firefox 调试器
- Microsoft Edge 调试器
- React Native 调试器
- Python 调试器
- Dart 调试器
- Lua 调试器
- Java 调试器
- 大型机调试器
VS Code 中的 Logpoints
如果您有兴趣在您的 VS Code 调试适配器中添加 Logpoint 支持，请查看协议中的 这些更改。您还可以查看上面的调试适配器，以了解每个运行时如何选择实现 Logpoints。
后续步骤
目前就这些，但我们还没有完成。在我们的 七月份迭代 中，我们正在改进自动附加，以帮助发现性 (#53640)，基于用户反馈。
我们希望 Logpoints、自动附加和 NPM 脚本资源器的引入将使 VS Code 的调试更加容易。与往常一样，我们渴望听到您的反馈，因此请通过 GitHub 或 Twitter 上的 @code 与我们联系。
谨代表 VS Code 团队：编码愉快！
/Kenneth Auchenberg - Twitter 上的 @auchenberg