现已发布!阅读关于 11 月新增功能和修复的内容。

VS Code 中的 Java 构建工具

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

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

Maven

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

安装 Extension Pack for Java

探索 Maven 项目

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

Maven Explorer

解析未知类型

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 目标。

该扩展程序还保留了每个项目的目标历史记录,因此您可以快速重新运行之前的命令,这在运行长自定义目标时很有用。

有两种重新运行目标的方式

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

您也可以在设置中指定您喜欢的命令以供将来执行。

对于您在项目中使用的每个插件,该扩展程序还提供了一种简单的方法来访问每个插件内的目标。

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

从 Maven Archetype 生成项目

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

有几种创建 Maven 项目的方法

  1. 从 Maven 资源管理器中,选择 **+** **Create Maven Project** 按钮。

    Create Maven Project

  2. 打开 **Command Palette**(⇧⌘P (Windows, Linux Ctrl+Shift+P)),搜索 **Create Java Project** 命令。

  3. 右键单击目标文件夹并选择 **Create Maven Project**。

Gradle

VS Code 通过 Gradle for Java 扩展支持 Gradle Java 项目(不包括 Android)。此扩展程序提供了几个组件来增强您的 Gradle Java 项目体验。

  • Gradle Build Server: Gradle Build Server 用于导入 Gradle 项目并将构建任务委派给 Gradle 守护进程,确保项目输出与从命令行运行 Gradle 任务时一致。
  • Visual Interface:允许您在 VS Code 中直接查看和管理 Gradle 任务和项目依赖项,以及运行 Gradle 任务。
  • Gradle Language Server:为 Gradle 构建文件提供改进的编写体验,包括语法高亮、错误报告和自动完成。

Gradle Build Server

默认情况下,如果您安装了 Gradle for Java 扩展,Gradle Build Server 将用于导入 Gradle 项目。您可以通过设置 java.gradle.buildServer.enabled 来启用或禁用 Gradle Build Server。

您可以在 Build Server for Gradle (Build) 输出通道中查看 Gradle 构建输出,并在 Build Server for Gradle (Log) 输出通道中跟踪 VS Code 与 Gradle Build Server 之间的交互。

将测试委托给 Gradle

该扩展程序支持将测试执行委托给 Gradle。您可以在 Testing Explorer 中配置要使用的测试配置文件。

注意:请确保您已安装 Test Runner for Java 扩展程序才能使用此功能。

使用 Gradle 任务

在 VSCode 中打开 Gradle 项目时,可以通过单击 Gradle Side Bar 项来找到一些有用的 Gradle 视图。**Gradle Projects** 视图列出了工作区中找到的所有 Gradle 项目。您可以在此处查看、运行或调试 Gradle 任务。

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

查看 Gradle 依赖项

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

Gradle Dependencies

管理 Gradle Daemons

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

编写构建文件

该扩展程序为 Gradle 构建文件提供了一些有用的编写功能。

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

Gradle Highlighting

在 **Outline** 视图中,扩展程序提供已打开 Gradle 文件的文档符号,这可以帮助您轻松导航到文件的任何部分。

Gradle Outline

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

Gradle Problems

该扩展程序为 Gradle 文件提供基本的自动完成功能。当您尝试在 Gradle 脚本中键入 Gradle 闭包或属性时,该扩展程序将为您建议可用的闭包或属性。

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

其他资源

访问 Maven 扩展的 GitHub Repo 以获取额外的 configurationstroubleshooting guide

除了 Maven,如果您使用 Bazel 来构建和测试项目,还有一个 Bazel extension

后续步骤

继续阅读以了解更多关于

  • Java 编辑 - 探索 VS Code 中的 Java 编辑功能。
  • Java 调试 - 了解如何使用 VS Code 调试您的 Java 项目。
  • Java 测试 - 在 VS Code 中使用您的 JUnit 和 TestNG 用例。
  • Java 扩展 - 了解更多适用于 VS Code 的有用 Java 扩展。
© . This site is unofficial and not affiliated with Microsoft.