VS Code 中的 Java 构建工具
本文档概述了如何在 Visual Studio Code 中使用 Java 构建工具。它涵盖了 Maven for Java 和 Gradle for Java 扩展以及其他工具。
如果您在使用以下功能时遇到任何问题,可以通过提交问题联系我们。
Maven
Maven 是一款帮助你管理 Java 项目并自动执行应用程序构建的软件工具。适用于 Visual Studio Code 的 Maven for Java 扩展提供了完全集成的 Maven 支持,允许你浏览 Maven 项目、执行 Maven 命令,以及执行构建生命周期和插件的目标(goals)。我们建议安装 Extension Pack for Java,它包含了 Maven 支持及其他重要的 Java 开发功能。
浏览 Maven 项目
一旦加载了 Maven 项目,该扩展就会被激活,它会自动扫描工作区中的 pom.xml 文件,并在侧边栏中显示所有 Maven 项目及其模块。

解析未知类型
Maven 扩展还支持搜索 Maven Central 以解析源代码中的未知类型。你可以通过选择悬停时显示的“解析未知类型 (Resolve unknown type)”链接来实现。
使用 POM.xml
该扩展提供了代码片段和自动补全功能,用于根据本地 Maven 仓库添加 Maven 依赖项。查看这些便捷功能如何轻松地为你的 pom.xml 添加新依赖项。
该扩展还允许你生成有效的 POM。
你还可以使用命令 Maven: Add a Dependency (或 maven.project.addDependency) 来帮助向 pom.xml 添加新依赖项。该过程是交互式的。
你也可以通过项目视图添加依赖项,该视图会调用相同的 Maven 命令。
此外,VS Code 还支持以树状视图显示依赖项,这使你可以在一个地方检查项目中的所有依赖项并查看潜在问题。
执行 Maven 命令和目标
通过右键单击资源管理器中的每个 Maven 项目,你可以方便地运行 Maven 目标。
该扩展还保留了每个项目的目标历史记录,因此你可以快速重新运行之前的命令,这在运行长自定义目标时非常有用。
有两种重新运行目标的方法
- 在命令面板中,运行 Maven: History,然后选择一个项目及其历史记录中的命令。
- 右键单击一个项目并选择 History。然后你可以从历史记录中选择一个之前的命令。
你还可以在设置中指定你喜爱的命令以便日后执行。
对于你在项目中使用的每个插件,该扩展还提供了一种访问每个插件内目标的简便方法。
要调试 Maven 目标,请右键单击目标并开始调试。Maven 扩展将使用正确的参数调用 Java 调试器。这是一个非常方便且节省时间的功能。
从 Maven Archetype 生成项目
该扩展提供的另一个便捷功能是从 Archetype(原型)生成 Maven 项目。该扩展会加载本地/远程目录中列出的原型。选择后,扩展会将 mvn archetype:generate -D... 发送到终端。
创建 Maven 项目有几种方法
-
在 Maven 资源管理器中,选择 + Create Maven Project 按钮。

-
打开 命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)),搜索 Create Java Project 命令。
-
右键单击目标文件夹并选择 Create Maven Project。
Gradle
VS Code 通过 Gradle for Java 扩展支持 Gradle Java 项目(Android 除外)。此扩展提供多个组件来增强你的 Gradle Java 项目体验:
- Gradle 构建服务器 (Gradle Build Server): Gradle Build Server 用于导入 Gradle 项目并将构建任务委托给 Gradle 守护进程 (daemon),确保项目输出与从命令行运行 Gradle 任务时一致。
- 可视化界面: 允许你查看和管理 Gradle 任务和项目依赖项,并直接在 VS Code 内运行 Gradle 任务。
- Gradle 语言服务器 (Gradle Language Server): 为 Gradle 构建文件提供改进的编写体验,包括语法高亮、错误报告和自动补全。
Gradle 构建服务器
默认情况下,如果你安装了 Gradle for Java 扩展,Gradle 构建服务器将用于导入 Gradle 项目。你可以通过设置 java.gradle.buildServer.enabled 来开启或关闭 Gradle 构建服务器。
你可以在“Build Server for Gradle (Build)”输出通道中查看 Gradle 构建输出,并在“Build Server for Gradle (Log)”输出通道中追踪 VS Code 与 Gradle 构建服务器之间的交互。
将测试委托给 Gradle
该扩展支持将测试执行委托给 Gradle。你可以在测试资源管理器 (Testing Explorer) 中配置你想要使用的测试配置文件。
注意:请确保已安装 Test Runner for Java 扩展以使用此功能。
使用 Gradle 任务
当你在 VS Code 中打开 Gradle 项目时,你可以通过点击 Gradle 侧边栏项找到一些有用的 Gradle 视图。Gradle Projects 视图列出了工作区中找到的所有 Gradle 项目。你可以在这里查看、运行或调试 Gradle 任务。
当工作区中有许多 Gradle 任务时,可能很难找到特定任务。该扩展提供了 Pinned Tasks(固定任务)视图,帮助你固定喜爱的任务,以便在单独的视图中轻松找到它们。你也可以在 Recent Tasks(最近任务)视图中查看最近执行的任务。
查看 Gradle 依赖项
在 Gradle Projects 视图中,你可以在每个 Gradle 项目条目下找到一个 Dependencies(依赖项)项。它包含了指定配置中的所有依赖项,你可以轻松检查项目的依赖项状态。

管理 Gradle 守护进程
Gradle Daemons 视图显示当前工作区的守护进程状态。它列出了所有与工作区版本相同的正在运行的 Gradle 守护进程。你可以选择在此视图中停止特定的一个或所有守护进程。
编写构建文件
该扩展在 Gradle 构建文件上提供了一些有用的编写功能。
打开 Groovy Gradle 文件时,扩展会分析 Gradle 文件并提供语义标记信息,从而提供更精确的高亮结果。

在 Outline(大纲)视图中,扩展提供了已打开 Gradle 文件的文档符号,这可以帮助你轻松导航到文件的任何部分。

如果打开的 Gradle 文件中有任何语法错误(缺失字符、找不到类型等),你可以在 Problems(问题)视图中找到它们。

该扩展支持 Gradle 文件的基本自动补全。当你尝试在 Gradle 脚本中输入 Gradle 闭包或属性时,扩展会为你建议可用的闭包或属性。
当你尝试声明新依赖项时,该扩展将为你提供候选依赖项列表。
其他资源
访问 Maven 扩展的 GitHub 仓库 以获取更多配置和故障排除指南。
除了 Maven 之外,如果你使用 Bazel 构建和测试项目,还有一个 Bazel 扩展。
后续步骤
继续阅读以了解更多信息: