在 VS Code 中调试浏览器
Visual Studio Code 包含一个内置的 Edge 和 Chrome 调试器。有几种方法可以开始使用它。
- 使用打开链接命令来调试 URL。
- 在JavaScript 调试终端中点击链接。
- 使用启动配置通过你的应用启动浏览器。
我们还有更详细的演练,帮助你开始使用 React、Angular 和 Vue,以及其他调试秘籍。
打开链接命令
调试网页最简单的方法是通过命令面板中找到的 Debug: Open Link 命令(⇧⌘P(Windows、Linux Ctrl+Shift+P))。当你运行此命令时,会提示你输入要打开的 URL,然后调试器将附加到该 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": "http://localhost:8000"
}
]
}
当你按下F5或点击运行和调试视图中的启动按钮时,http://localhost: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
是你的工作区文件夹。此选项用于源映射解析。outFiles
- 用于定位生成的 JavaScript 文件的全局模式数组。请参阅有关源映射的部分。smartStep
- 尝试自动跳过未映射到源文件的源代码。请参阅有关智能单步执行的部分。skipFiles
- 自动跳过这些全局模式覆盖的文件。请参阅有关跳过不感兴趣的代码的部分。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 调试的更多信息。
源映射
VS Code 中的 JavaScript 调试器支持源映射,允许调试转换后的代码。例如,TypeScript 代码被编译成 JavaScript,许多 Web 应用程序将所有 JavaScript 文件捆绑在一起。源映射有助于调试器弄清楚如何在你的原始代码和浏览器中运行的代码之间进行映射。
大多数用于构建 Web 应用程序的现代工具都将开箱即用。如果不是,我们关于Node.js 中的源映射的部分也包含适用于浏览器调试的指南。
加载源映射
每个 JavaScript 文件都可以通过 URL 或相对路径引用一个源映射。在处理 Web 应用程序时,你需要确保 VS Code 中运行的调试器可以访问该 URL。如果无法访问,你会在调试控制台中看到错误,解释哪些源映射加载失败以及原因。
如果无法直接访问,VS Code 将尝试使用浏览器的网络堆栈来请求源映射。这为将浏览器中的任何身份验证状态或网络设置应用于请求提供了机会。例如,如果你的源映射位于受 Cookie 身份验证保护的位置,则 VS Code 只有在浏览器会话具有必要的 Cookie 时才能加载它们。