在 VS Code 中进行浏览器调试
Visual Studio Code 内置了 Edge 和 Chrome 的调试器。有几种方法可以开始使用它。
- 使用“打开链接”命令调试 URL。
- 单击 JavaScript 调试终端中的链接。
- 使用启动配置启动带有您的应用的浏览器。
我们还有更详细的 React、Angular 和 Vue 入门教程,以及其他调试秘诀。
打开链接命令
调试网页最简单的方法是通过命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 中的“调试: 打开链接”命令。当您运行此命令时,系统将提示您输入要打开的 URL,并且调试器将附加。
如果您的默认浏览器是 Edge,VS Code 将使用它来打开页面。否则,它将尝试在您的系统上查找 Chrome 的安装。
启动配置
启动配置是在 VS Code 中设置调试的传统方式,并且为您运行复杂的应用程序提供了最大的灵活性。
在本节中,我们将更详细地介绍配置和功能,以用于更高级的调试场景。Node.js 跳过外部代码的说明也适用于基于浏览器的调试。
注意:如果您刚开始使用 VS Code,您可以在调试主题中了解有关常规调试功能和创建
launch.json
配置文件的信息。
启动浏览器
在大多数情况下,您需要启动一个新的浏览器实例来调试您的网页或文件。为此,您可以创建一个名为 .vscode/launch.json
的文件,如下所示
{
"version": "0.2.0",
"configurations": [
{
"type": "msedge",
"request": "launch",
"name": "Launch my cool app",
"url": "https://127.0.0.1:8000"
}
]
}
当您按下 F5 键或“运行和调试”视图中的“启动”按钮时,https://127.0.0.1:8000
将在调试模式下打开。如果您想使用 Chrome 而不是 Edge,请将 msedge
替换为 chrome
。
您也可以调试单个文件而无需运行服务器,例如
{
"version": "0.2.0",
"configurations": [
{
"type": "msedge",
"request": "launch",
"name": "Launch hello.html",
"file": "${workspaceFolder}/hello.html"
}
]
}
附加到浏览器
要附加到正在运行的浏览器,需要以特殊的调试模式启动它。您可以使用以下命令执行此操作,将 edge.exe
替换为您的 Edge 或 Chrome 二进制文件的路径
edge.exe --remote-debugging-port=9222 --user-data-dir=remote-debug-profile
设置 --remote-debugging-port
会告诉浏览器监听该端口以进行调试连接。设置单独的 --user-data-dir
会强制打开一个新的浏览器实例;如果未提供此标志,则该命令将打开任何正在运行的浏览器的新窗口,而不会进入调试模式。
接下来,在 vscode/launch.json
文件中添加一个新的部分,如下所示
{
"version": "0.2.0",
"configurations": [
{
"type": "msedge",
"request": "attach",
"name": "Attach to browser",
"port": 9222
}
]
}
现在,您可以按 F5 键或“运行和调试”视图中的“启动”按钮以附加到正在运行的浏览器。您甚至可以添加一个 address
属性来调试在不同计算机上运行的浏览器。
启动配置属性
调试配置存储在工作区的 .vscode
文件夹中的 launch.json
文件中。有关创建和使用调试配置文件的介绍,请参阅常规调试文章。您可以“启动”带有您的应用程序的浏览器,或者“附加”到您在调试模式下启动的现有浏览器。
以下是特定于浏览器调试的常用 launch.json
属性的参考。您可以在 vscode-js-debug 选项文档中查看完整的选项集。
webRoot
- 源代码的根目录。通常,默认情况下,webRoot
是您的工作区文件夹。此选项用于 sourcemap 解析。outFiles
- 用于定位生成的 JavaScript 文件的 glob 模式数组。请参阅“Source Maps”部分。smartStep
- 尝试自动跳过未映射到源文件的源代码。请参阅“Smart stepping”部分。skipFiles
- 自动跳过这些 glob 模式涵盖的文件。请参阅“跳过不重要的代码”部分。trace
- 启用诊断输出。
这些属性仅适用于请求类型为 launch
的启动配置
url
- 浏览器启动时自动打开的 URL。runtimeExecutable
- 要使用的浏览器可执行文件的绝对路径,或要使用的浏览器版本。有效版本包括stable
(默认)、canary
、beta
和dev
。runtimeArgs
- 启动浏览器时传递的可选参数。
这些属性仅适用于请求类型为 attach
的启动配置
url
- 如果提供,VS Code 将附加到具有此 URL 的选项卡。如果未提供,它将附加到所有浏览器选项卡。port
- 用于远程调试浏览器的端口,与启动浏览器时使用的--remote-debugging-port
匹配。请参阅“附加到浏览器”部分。address
- 调试浏览器正在侦听的 IP 地址或主机名。请参阅“附加到浏览器”部分。
WebAssembly 调试
浏览器中的 WebAssembly 调试与 Node.js 相同,请在此处阅读有关 WebAssembly 调试的更多信息。
Source Maps
VS Code 中的 JavaScript 调试器支持 source map,这允许调试转换后的代码。例如,TypeScript 代码被编译为 JavaScript,许多 Web 应用程序将所有 JavaScript 文件捆绑在一起。Source map 帮助调试器弄清楚如何在您的原始代码和在浏览器中运行的代码之间进行映射。
大多数用于构建 Web 应用程序的现代工具都可以开箱即用。如果不是,我们在 Node.js 中的 sourcemap 部分包含也适用于浏览器调试的指南。
加载 Source Maps
每个 JavaScript 文件都可以通过 URL 或相对路径引用 source map。在处理 Web 应用程序时,您需要确保 VS Code 中运行的调试器可以访问该 URL。如果无法访问,您将在“调试控制台”中看到错误,解释哪些 source map 加载失败以及原因。
如果无法直接访问,VS Code 将尝试使用浏览器的网络堆栈来请求 source map。这为浏览器中的任何身份验证状态或网络设置应用于请求提供了机会。例如,如果您的 source map 位于受 cookie 身份验证保护的位置,则仅当浏览器会话具有必要的 cookie 时,VS Code 才能加载它们。