现已可用！阅读关于 11 月的新功能和修复的说明。

运行和调试 Java

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

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

  • 启动/附加
  • 断点
  • 异常
  • 暂停和继续
  • 单步跳入/跳出/跳过
  • 变量
  • 调用堆栈
  • 线程
  • 调试控制台
  • 求值
  • 热代码替换

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

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

安装

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

安装 Java 扩展包

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

配置

默认情况下，调试器通过自动查找主类并在内存中生成默认启动配置来启动应用程序，从而实现开箱即用。

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

Debug Menu

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

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

运行和调试

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

从 CodeLens 运行

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

CodeLens

从编辑器菜单运行

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

EditorMenu

按 F5 运行

按下 F5，调试器会自动找到项目的入口点并开始调试。你也可以从 VS Code 侧栏中的 运行和调试 视图启动调试会话。有关详细信息，请参阅 VS Code 中的调试。

调试单个文件

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

调试会话输入

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

断点

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

断点 - 条件断点

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

断点 - 数据断点

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

Data Breakpoint

断点 - 日志点

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

断点 - 触发的断点

触发的断点是指在命中另一个断点后自动启用的断点。在诊断仅在满足某些前提条件后才会发生的代码中的故障情况时，它们非常有用。

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

表达式求值

调试器还允许你在 监视 窗口以及调试控制台中求值表达式。

热代码替换

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

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

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

步骤筛选

扩展支持步骤筛选，以筛选出你在调试时不想查看或单步执行的类型。借助此功能，你可以配置要在 launch.json 中筛选的包，以便在单步执行时可以跳过它们。

配置选项

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

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

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

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

启动 (Launch)

  • 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 - 步进时跳过构造函数方法。

附加 (Attach)

  • 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 语言支持扩展的 java.autobuild.enabled。有关用法和限制的更多信息，请参阅 热代码替换 Wiki 页面。
    • manual - 单击工具栏以应用更改。
    • auto - 编译后自动应用更改。
    • never - 从不应用更改。
  • java.debug.settings.enableHotCodeReplace: 为 Java 代码启用热代码替换。确保未禁用 VS Code Java 的自动构建。有关用法和限制的更多信息，请参阅 热代码替换 Wiki 页面。
  • java.debug.settings.enableRunDebugCodeLens: 启用主入口点上的运行和调试按钮的 CodeLens 提供程序，默认为 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 语言支持扩展启动失败。
  • 构建失败，是否要继续？
  • *.java 不在类路径上。只会报告语法错误。
  • 程序错误：无法找到或加载主类 X。
  • 程序抛出 ClassNotFoundException 异常。
  • 热代码替换失败。
  • 请在 launch.json 中指定远程调试程序的 host 名称和端口。
  • 求值失败。原因：线程已恢复，无法求值。
  • 找不到包含 main 方法的类。
  • 启动调试器时，没有 vscode.java.startDebugSession 的委托命令处理程序。
  • 无法解析类路径。
  • 不支持请求类型 "X"。仅支持 "launch" 和 "attach"。

反馈和问题

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

后续步骤

继续阅读以了解

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

以及针对 Java

  • Java 测试 - 使用 Java 测试运行器扩展在 VS Code 中测试 Java。
  • Java 扩展 - 了解更多有用的 VS Code Java 扩展。
12/9/2021