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