运行和调试 Java

Visual Studio Code 允许您通过 Java 调试器扩展来调试 Java 应用程序。它是一个轻量级的 Java 调试器，基于 Java Debug Server，扩展了 Red Hat 的 Java™ 语言支持。

以下是支持的调试功能列表

启动/附加
Breakpoints
异常
暂停 & 继续
步入/步出/步过
变量
调用堆栈
线程
调试控制台
评估
热代码替换

Java 调试器是一个开源项目，欢迎贡献者通过 GitHub 仓库进行协作

如果您在使用以下功能时遇到任何问题，可以通过提交问题联系我们。

安装

要获得 Visual Studio Code 中完整的 Java 语言支持，您可以安装 Java 扩展包，其中包含 Java 调试器扩展。

安装 Extension Pack for Java

有关如何开始使用扩展包的详细信息，您可以查看 Java 入门教程。

配置

默认情况下，调试器将通过自动查找主类并在内存中生成默认启动配置来启动您的应用程序。

如果您想自定义和持久化您的启动配置，您可以选择 创建 launch.json 文件 链接在 VS Code 侧边栏的 运行和调试 视图中。

launch.json 文件位于工作区（项目根文件夹）中的 .vscode 文件夹中。

有关如何创建 launch.json 的更多详细信息，请阅读启动配置；有关 Java 的配置选项的更多详细信息，请阅读配置选项。

运行和调试

调试器扩展提供了多种运行和调试 Java 应用程序的方式。

从 CodeLens 运行

您将在 main() 函数的 CodeLens 上找到 运行|调试。

CodeLens

另一种启动调试的方式是从顶部编辑器标题栏中选择 运行 Java 或 调试 Java 菜单。

通过按 F5 运行

按下 F5，调试器将自动找到项目的入口点并开始调试。您还可以从 VS Code 侧边栏的 运行和调试 视图开始调试会话。有关更多信息，请参阅 VS Code 中的调试。

调试单个文件

除了支持调试由构建工具管理的 Java 项目外，VS Code 还支持调试不带任何项目的单个 Java 文件。

调试会话输入

VS Code 中的默认调试控制台不支持输入。如果您的程序需要来自终端的输入，您可以使用 VS Code 中的集成终端 (⌃` (Windows, Linux Ctrl+`)) 或外部终端来启动它。您还可以使用用户设置 java.debug.settings.console 来为所有 Java 调试会话配置全局控制台。

Breakpoints

Java 调试器支持各种断点，例如行断点、条件断点、数据断点和日志点。

断点 - 条件断点

借助表达式求值，调试器还支持条件断点。您可以将断点设置为在表达式求值为 true 时中断。

断点 - 数据断点

当变量更改其值时，您可以让调试器中断。请注意，数据断点只能在调试会话中设置。这意味着您需要先启动应用程序并在常规断点处中断。然后，您可以选择变量视图中的字段并设置数据断点。

Data Breakpoint

断点 - 日志点

日志点也受 Java 调试器的支持。日志点允许您将输出发送到调试控制台，而无需编辑代码。它们与断点不同，因为它们不会停止应用程序的执行流程。

断点 - 触发断点

触发断点是一种在另一个断点命中后自动启用的断点。当代码中出现仅在特定先决条件发生后才出现的故障情况时，它们非常有用。

可以通过右键单击字形边距，选择 添加触发断点，然后选择哪个其他断点启用此断点来设置触发断点。

Expression evaluation

调试器还允许您在监视窗口以及调试控制台中评估表达式。

热代码替换

调试器支持的另一个高级功能是“热代码”替换。热代码替换 (HCR) 是一种调试技术，通过调试通道将类更改传输到另一个 Java 虚拟机 (JVM)。HCR 促进了实验性开发并促进了迭代的试错编码。有了这个新功能，您可以启动一个调试会话并在开发环境中更改一个 Java 文件，调试器将在正在运行的 JVM 中替换代码。无需重新启动，这就是它被称为“热”的原因。以下说明了如何在 VS Code 中使用 Java 调试器的 HCR。

您可以使用调试设置 java.debug.settings.hotCodeReplace 来控制如何触发热代码替换。可能的设置值是

manual - 单击工具栏以应用更改（默认）。
auto - 在编译后自动应用更改。
never - 禁用热代码替换。

步进过滤

步进过滤受扩展支持，以过滤掉您不想在调试时看到或步进的类型。使用此功能，您可以配置在 launch.json 中过滤的包，以便在步进时跳过它们。

配置选项

有许多选项和设置可用于配置调试器。例如，配置 JVM 参数和环境变量可以通过启动选项轻松完成。

请参阅 Red Hat 的 Java™ 语言支持扩展的文档，以获取有关设置项目的帮助。

对于许多常用设置，VS Code Java 调试器配置中提供了示例。该文档解释了 Java 调试器如何自动为您生成配置，以及如果需要修改它们，如何使用主类、不同的参数、环境、附加到其他 Java 进程以及使用更高级的功能来执行此操作。

以下是 启动 和 附加 可用的所有配置。有关如何编写 launch.json 文件的更多信息，请参阅调试。

启动

mainClass (必需) - 完全限定的类名（例如 [java 模块名称/]com.xyz.MainApp）或程序的 java 文件路径。
args - 传递给程序的命令行参数。使用 "${command:SpecifyProgramArgs}" 提示程序参数。它接受一个字符串或一个字符串数组。
sourcePaths - 程序的额外源代码目录。调试器默认情况下从项目设置中查找源代码。此选项允许调试器在额外的目录中查找源代码。
modulePaths - 启动 JVM 的模块路径。如果未指定，调试器将自动从当前项目解析。
- $Auto - 自动解析当前项目的模块路径。
- $Runtime - 当前项目“runtime”范围内的模块路径。
- $Test - 当前项目“test”范围内的模块路径。
- !/path/to/exclude - 从模块路径中排除指定的路径。
- /path/to/append - 将指定的路径附加到模块路径。
classPaths - 启动 JVM 的类路径。如果未指定，调试器将自动从当前项目解析。
- $Auto - 自动解析当前项目的类路径。
- $Runtime - 当前项目“runtime”范围内的类路径。
- $Test - 当前项目“test”范围内的类路径。
- !/path/to/exclude - 从类路径中排除指定的路径。
- /path/to/append - 将指定的路径附加到类路径。
encoding - JVM 的 file.encoding 设置。如果未指定，将使用“UTF-8”。可以在支持的编码中找到可能的值。
vmArgs - JVM 的额外选项和系统属性（例如 -Xms<size> -Xmx<size> -D<name>=<value>），它接受一个字符串或一个字符串数组。
projectName - 调试器搜索类的首选项目。不同项目中可能存在重复的类名。当调试器查找指定的类名时，此设置也有效。当工作区有多个 Java 项目时，它是必需的，否则表达式求值和条件断点可能无法工作。
cwd - 程序的当前工作目录。默认为 ${workspaceFolder}。
env - 程序的额外环境变量。
envFile - 包含环境变量定义的文件的绝对路径。
stopOnEntry - 启动后自动暂停程序。
console - 启动程序的指定控制台。如果未指定，请使用用户设置 java.debug.settings.console 中指定的控制台。
- internalConsole - VS Code 调试控制台（不支持输入流）。
- integratedTerminal - VS Code 集成终端。
- externalTerminal - 可以在用户设置中配置的外部终端。
shortenCommandLine - 当项目具有很长的类路径或很大的 VM 参数时，启动程序的命令行可能超过操作系统允许的最大命令行字符串限制。此配置项提供了多种缩短命令行的方法。默认为 auto。
- none - 使用标准命令行“java {options} classname {args}”启动程序。
- jarmanifest - 将类路径参数生成到临时 classpath.jar 文件，并使用命令行“java -cp classpath.jar classname {args}”启动程序。
- argfile - 将类路径参数生成到临时参数文件，并使用命令行“java @argfile {args}”启动程序。此值仅适用于 Java 9 及更高版本。
- auto - 自动检测命令行长度并确定是否通过适当的方法缩短命令行。
stepFilters - 在步进时跳过指定的类或方法。
- classNameFilters - [已弃用 - 替换为 skipClasses] 在步进时跳过指定的类。类名应完全限定。支持通配符。
- skipClasses - 在步进时跳过指定的类。您可以使用内置变量，例如“$JDK”和“$Libraries”来跳过一组类，或者添加特定的类名表达式，例如 java.*、*.Foo。
- skipSynthetics - 在步进时跳过合成方法。
- skipStaticInitializers - 在步进时跳过静态初始化器方法。
- skipConstructors - 在步进时跳过构造函数方法。

附加

hostName (必需) - 远程调试器的主机名或 IP 地址。
port (必需) - 远程调试器的调试端口。
processId - 使用进程选择器选择要附加的进程，或将进程 ID 作为整数。
- ${command:PickJavaProcess} - 使用进程选择器选择要附加的进程。
- 一个整数 PID - 附加到指定的本地进程。
timeout - 在重新连接之前的时间限制值，以毫秒为单位（默认为 30000 毫秒）。
sourcePaths - 程序的额外源代码目录。调试器默认情况下从项目设置中查找源代码。此选项允许调试器在额外的目录中查找源代码。
projectName - 调试器搜索类时首选的项目。不同项目中可能存在重复的类名。当工作区包含多个 Java 项目时，此项是必需的，否则表达式求值和条件断点可能无法正常工作。
stepFilters - 在步进时跳过指定的类或方法。
- classNameFilters - [已弃用 - 替换为 skipClasses] 在步进时跳过指定的类。类名应完全限定。支持通配符。
- skipClasses - 在步进时跳过指定的类。您可以使用内置变量，例如“$JDK”和“$Libraries”来跳过一组类，或者添加特定的类名表达式，例如 java.*、*.Foo。
- skipSynthetics - 在步进时跳过合成方法。
- skipStaticInitializers - 在步进时跳过静态初始化器方法。
- skipConstructors - 在步进时跳过构造函数方法。

用户设置

java.debug.logLevel: 调试器日志的最低级别，发送到 VS Code，默认为 warn。
java.debug.settings.showHex: 在变量中以十六进制格式显示数字，默认为 false。
java.debug.settings.showStaticVariables: 在变量中显示静态变量，默认为 false。
java.debug.settings.showQualifiedNames: 在变量中显示完全限定的类名，默认为 false。
java.debug.settings.showLogicalStructure: 在变量中显示 Collection 和 Map 类的逻辑结构，默认为 true。
java.debug.settings.showToString: 在变量中显示重写了 'toString' 方法的所有类的 'toString()' 值，默认为 true。
java.debug.settings.maxStringLength: 在变量或 调试控制台 中显示的字符串的最大长度。超过此限制的字符串将被截断。默认值为 0，表示不执行截断。
java.debug.settings.hotCodeReplace: 在调试期间重新加载更改的 Java 类，默认为 manual。请确保 Java Language Support 扩展的 java.autobuild.enabled 未被禁用。有关用法和限制的更多信息，请参阅热代码替换 wiki 页面。
- manual - 单击工具栏以应用更改。
- auto - 在编译后自动应用更改。
- never - 从不应用更改。
java.debug.settings.enableHotCodeReplace: 启用 Java 代码的热代码替换。请确保 VS Code Java 的自动构建未被禁用。有关用法和限制的更多信息，请参阅热代码替换 wiki 页面。
java.debug.settings.enableRunDebugCodeLens: 启用主入口点上运行和调试按钮的代码透视提供程序，默认为 true。
java.debug.settings.forceBuildBeforeLaunch: 在启动 Java 程序之前强制构建工作区，默认为 true。
java.debug.settings.console: 启动 Java 程序时使用的控制台，默认为 integratedTerminal。如果您想自定义特定调试会话的控制台，请修改 launch.json 中的 console 配置。
- internalConsole - VS Code 调试控制台（不支持输入流）。
- integratedTerminal - VS Code 集成终端。
- externalTerminal - 可以在用户设置中配置的外部终端。
java.debug.settings.exceptionBreakpoint.skipClasses: 在捕获异常时跳过指定的类。您可以使用内置变量，例如 '$JDK' 和 '$Libraries' 来跳过一组类，或者添加特定的类名表达式，例如 java.*, *.Foo。
java.debug.settings.stepping.skipClasses: 在单步执行时跳过指定的类。您可以使用内置变量，例如 '$JDK' 和 '$Libraries' 来跳过一组类，或者添加特定的类名表达式，例如 java.*, *.Foo。
java.debug.settings.stepping.skipSynthetics: 在单步执行时跳过合成方法。
java.debug.settings.stepping.skipStaticInitializers: 在单步执行时跳过静态初始化器方法。
java.debug.settings.stepping.skipConstructors: 在单步执行时跳过构造函数方法。
java.debug.settings.jdwp.limitOfVariablesPerJdwpRequest: 单个 JDWP 请求可以请求的最大变量或字段数。值越高，在展开变量视图时调试器请求的频率越低。过大的数字也可能导致 JDWP 请求超时。默认为 100。
java.debug.settings.jdwp.requestTimeout: 调试器与目标 JVM 通信时的 JDWP 请求超时时间（毫秒）。默认为 3000。
java.debug.settings.vmArgs: 启动 Java 程序的默认 VM 参数。例如，使用 '-Xmx1G -ea' 将堆大小增加到 1 GB 并启用断言。如果您想自定义特定调试会话的 VM 参数，可以修改 launch.json 中的 'vmArgs' 配置。
java.silentNotification: 控制是否可以使用通知来报告进度。如果为 true，则使用状态栏报告进度。默认为 false。

故障排除

如果您在使用调试器时遇到问题，可以在 vscode-java-debug GitHub 仓库中找到详细的故障排除指南。

解释的常见问题包括

Java Language Support 扩展无法启动。
构建失败，您想继续吗？
*.java 不在类路径上。只会报告语法错误。
程序错误：找不到或无法加载主类 X。
程序抛出 ClassNotFoundException。
热代码替换失败。
请在 launch.json 中指定远程调试器的主机名和端口。
评估失败。原因：无法评估，因为线程已恢复。
找不到包含 main 方法的类。
启动调试器时，没有 vscode.java.startDebugSession 的 delegateCommandHandler。
无法解析类路径。
不支持请求类型 "X"。仅支持 "launch" 和 "attach"。

反馈和问题

您可以在 vscode-java-debug 仓库中找到完整的 issue 列表。您可以提交 bug 或功能建议，并参与社区驱动的 vscode-java-debug Gitter 频道。

后续步骤

继续阅读以了解：

Debugging - 了解如何在 VS Code 中使用调试器进行任何语言的项目。

以及对于 Java

Java testing - 使用 Java Test Runner 扩展在 VS Code 中测试 Java。
Java 扩展 - 了解更多适用于 VS Code 的有用 Java 扩展。

12/9/2021