在 VS Code 中尝试

VS Code 中的 Java 构建工具

本文档概述了如何在 Visual Studio Code 中使用 Java 构建工具。它涵盖了 适用于 Java 的 Maven适用于 Java 的 Gradle 扩展以及其他工具。

如果在下方功能的使用过程中遇到任何问题,可以通过提出问题与我们联系。

Maven

Maven 是一个软件工具,可帮助你管理 Java 项目并自动执行应用程序构建。适用于 Visual Studio Code 的 适用于 Java 的 Maven 扩展提供了完全集成的 Maven 支持,允许你探索 Maven 项目、执行 Maven 命令以及执行构建生命周期和插件的目标。我们建议安装 Java 扩展包,其中包含 Maven 支持和其他重要的 Java 开发功能。

安装 Java 扩展包

探索 Maven 项目

加载 Maven 项目后,扩展将激活并自动扫描工作区中的 pom.xml 文件,并在侧边栏中显示所有 Maven 项目及其模块。

Maven Explorer

解决未知类型

Maven 扩展还支持搜索 Maven Central 以解决源代码中的未知类型。你可以通过选择悬停时显示的解决未知类型链接来执行此操作。

使用 POM.xml

该扩展提供了用于添加基于本地 Maven 仓库的 Maven 依赖项的代码片段和自动补全功能。看看使用这些便捷功能向 pom.xml 添加新依赖项有多么容易。

该扩展还使你能够生成有效的 POM。

你还可以使用命令 Maven: 添加依赖项 (或 maven.project.addDependency) 来帮助向 pom.xml 添加新的依赖项。此过程是交互式的。

你还可以通过项目视图添加依赖项,这会调用相同的 Maven 命令。

此外,VS Code 还支持在树视图中显示依赖项,这允许你在一处检查项目中的所有依赖项并检查潜在问题。

执行 Maven 命令和目标

通过在资源管理器中右键单击每个 Maven 项目,你可以方便地运行 Maven 目标。

该扩展还保留了每个项目的目标历史记录,因此你可以快速重新运行上一个命令,这在你运行长时间的自定义目标时非常有用。

重新运行目标有两种方法

  1. 在命令面板中,运行 Maven: 历史记录,然后从其历史记录中选择一个项目和命令。
  2. 右键单击项目并选择历史记录。然后,你可以从历史记录中选择上一个命令。

你还可以在设置中指定你喜欢的命令,以便将来执行。

对于你项目中使用的每个插件,该扩展还为你提供了一种轻松访问每个插件中目标的方法。

要调试 Maven 目标,请右键单击一个目标并开始调试。Maven 扩展将使用正确的参数调用 Java 调试器。这是一个方便且省时的功能。

从 Maven 原型生成项目

此扩展提供的另一个便捷功能是从原型生成 Maven 项目。该扩展加载本地/远程目录中列出的原型。选择后,该扩展会将 mvn archetype:generate -D... 发送到终端。

创建 Maven 项目有几种方法

  1. 在 Maven 资源管理器中,选择 + 创建 Maven 项目按钮。

    Create Maven Project

  2. 打开命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)),搜索创建 Java 项目命令。

  3. 右键单击目标文件夹并选择创建 Maven 项目

Gradle

VS Code 通过 适用于 Java 的 Gradle 扩展支持 Gradle Java 项目(不包括 Android)。此扩展提供了多个组件来增强你的 Gradle Java 项目体验

  • Gradle 构建服务器: Gradle 构建服务器用于导入 Gradle 项目并将构建任务委托给 Gradle 守护进程,确保与从命令行运行 Gradle 任务时一致的项目输出。
  • 可视化界面: 允许你查看和管理 Gradle 任务和项目依赖项,并直接在 VS Code 中运行 Gradle 任务。
  • Gradle 语言服务器: 为 Gradle 构建文件提供改进的创作体验,包括语法高亮、错误报告和自动补全。

Gradle 构建服务器

默认情况下,如果你安装了适用于 Java 的 Gradle 扩展,则会使用 Gradle 构建服务器导入 Gradle 项目。你可以通过设置 java.gradle.buildServer.enabled 来启用或禁用 Gradle 构建服务器。

你可以在适用于 Gradle 的构建服务器 (Build) 输出通道中查看 Gradle 构建输出,并在适用于 Gradle 的构建服务器 (Log) 输出通道中跟踪 VS Code 与 Gradle 构建服务器之间的交互。

将测试委托给 Gradle

该扩展支持将测试执行委托给 Gradle。你可以在测试资源管理器中配置要使用的测试配置文件。

注意:请确保你已安装 适用于 Java 的测试运行器 扩展才能使用此功能。

使用 Gradle 任务

在 VS Code 中打开 Gradle 项目时,可以通过单击 Gradle 侧边栏项找到一些有用的 Gradle 视图。Gradle 项目视图列出了工作区中找到的所有 Gradle 项目。你可以在此处查看、运行或调试 Gradle 任务。

当工作区中有许多 Gradle 任务时,可能很难找到特定任务。该扩展提供了一个固定任务视图,可帮助你固定你喜欢的任务,以便你可以在单独的视图中轻松找到它们。你还可以在最近任务视图中查看最近执行的任务。

查看 Gradle 依赖项

Gradle 项目视图中,你可以在每个 Gradle 项目项下找到一个依赖项项。它包含你指定配置中的所有依赖项,你可以轻松检查项目的依赖项状态。

Gradle Dependencies

管理 Gradle 守护进程

Gradle 守护进程视图显示当前工作区的守护进程状态。它列出了与工作区版本相同的所有正在运行的 Gradle 守护进程。你可以在此视图中选择停止特定的守护进程或所有守护进程。

创作构建文件

该扩展为 Gradle 构建文件提供了一些有用的创作功能。

打开 Groovy Gradle 文件时,该扩展将分析 Gradle 文件并提供语义令牌信息,从而提供更精确的高亮显示结果。

Gradle Highlighting

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

Gradle Outline

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

Gradle Problems

该扩展支持 Gradle 文件的基本自动补全功能,当你在 Gradle 脚本中尝试键入 Gradle 闭包或属性时,该扩展将为你建议可用的闭包或属性。

当你尝试声明新的依赖项时,该扩展将为你提供一个依赖项候选列表。

其他资源

访问 Maven 扩展的 GitHub 仓库以获取更多配置故障排除指南

除了 Maven,如果你使用 Bazel 构建和测试项目,还有一个 Bazel 扩展

后续步骤

继续阅读以了解更多信息:

  • Java 编辑 - 探索 VS Code 中 Java 的编辑功能。
  • Java 调试 - 了解如何使用 VS Code 调试 Java 项目。
  • Java 测试 - 将 VS Code 用于你的 JUnit 和 TestNG 用例。
  • Java 扩展 - 了解更多适用于 VS Code 的有用 Java 扩展。