在 VS Code 中管理 Java 项目
Project Manager for Java 扩展帮助您管理 Java 项目及其依赖项。它还帮助您创建新的 Java 项目、包和类。要在 Visual Studio Code 中获得完整的 Java 语言支持,您可以安装 Extension Pack for Java,其中包含 Project Manager for Java 扩展。
有关如何开始使用扩展包的详细信息,您可以查阅Java 入门教程。
项目视图
Java 项目视图可帮助您查看 Java 项目及其依赖项,并提供项目管理任务的入口点。
默认情况下,“Java 项目”视图显示在“资源管理器”视图下方。如果您看不到它,请尝试单击资源管理器标题栏中的
...
按钮,然后选择Java 项目。
在导航栏的溢出按钮中,有更多可用选项。例如,您可以在分层视图和平面视图之间切换。
您可以在“资源管理器”中的节点旁边找到按钮,这些按钮为某些操作提供了有用的快捷方式。
每个节点的上下文菜单中也有许多有用的功能,您可以在“资源管理器”中右键单击节点以将其弹出。
创建新的 Java 项目
您可以通过单击导航栏中的 + 按钮,或通过命令面板中的命令:Java: Create Java Project... (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 来创建新的 Java 项目。在创建过程中,如果尚未安装所需的扩展,VS Code 将根据您的项目类型促进安装所需的扩展。
导入 Java 项目
您可以通过 文件 > 打开文件夹... 直接将现有 Java 项目和模块导入到您的工作区(确保打开的文件夹包含您的构建工具脚本,例如 pom.xml
或 build.gradle
)。VS Code for Java 将自动检测您的项目并导入它们。
当您在项目中添加新模块时,可以触发命令 Java: Import Java projects in workspace 将它们导入到您的工作区。此命令有助于将新项目导入工作区,而无需重新加载 VS Code 窗口。
导出为 JAR
您可以从项目视图中将构建导出到 JAR,或通过运行命令 Java: Export Jar...。
配置项目运行时
随着 Java 的发展,开发人员使用多个 JDK 版本是很常见的。您可以通过设置 java.configuration.runtimes
将它们映射到本地安装路径。该设置的格式如下
"java.configuration.runtimes": [
{
"name": "JavaSE-1.8",
"path": "/usr/local/jdk1.8.0_201"
},
{
"name": "JavaSE-11",
"path": "/usr/local/jdk-11.0.3",
"sources" : "/usr/local/jdk-11.0.3/lib/src.zip",
"javadoc" : "https://docs.oracle.com/en/java/javase/11/docs/api",
"default": true
},
{
"name": "JavaSE-12",
"path": "/usr/local/jdk-12.0.2"
},
{
"name": "JavaSE-13",
"path": "/usr/local/jdk-13"
}
]
注意:您可以通过向条目添加
"default": true
来将其中一个设置为默认值。默认 JDK 将用于您的非受管文件夹(没有构建工具)。
要查看哪些 JDK 用于您的项目,您可以在命令面板中触发命令 Java: Configure Java Runtime (⇧⌘P (Windows、Linux Ctrl+Shift+P))。此命令会打开一个视图,显示项目的运行时信息。
更改 Maven 和 Gradle 项目的 JDK
如果您想更改 Maven 或 Gradle 项目的 JDK 版本,则需要在构建脚本(pom.xml
或 build.gradle
)中进行更新。您可以单击 查看如何进行此类更改。单击 将导航到项目的构建脚本文件。
更改非受管文件夹的 JDK
要更改非受管文件夹(没有任何构建工具)的 JDK,您可以单击 按钮。它将列出所有 JDK,您可以为非受管文件夹选择一个。
下载 JDK
如果您想下载新的 JDK,可以单击 download
链接,或在命令面板中触发命令 Java: Install New JDK (⇧⌘P (Windows、Linux Ctrl+Shift+P))。它将打开一个新视图,指导您下载 JDK。
注意:要启用 Java 预览功能,请参阅如何将 VS Code 与新 Java 版本一起使用。
为非受管文件夹配置类路径
Java 项目管理扩展提供了一个用户界面,用于为非受管文件夹配置类路径。可以在类路径配置页面手动设置类路径。您可以通过从命令面板执行 Java: Configure Classpath 命令来打开它 (⇧⌘P (Windows、Linux Ctrl+Shift+P))。
在某些罕见情况下,您可能需要通过从命令面板执行 Java: Clean Java Language Server Workspace 命令 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 来清理 Java 工作区,以让语言服务器重新构建您的依赖项。
依赖管理
添加 Maven 依赖项
对于 Maven 项目,您可以通过单击项目视图中 Maven Dependencies 节点旁边的 + 图标来添加依赖项。
管理非受管文件夹的依赖项
如果您的项目是没有构建工具的非受管文件夹。您可以通过单击 Referenced Libraries 节点或其下方的项目上的 + 或 - 图标来管理依赖项,或者您可以直接将您的 jar 库拖到 Referenced Libraries
节点。
您还可以在类路径配置页面中管理依赖项。请参阅:为非受管文件夹配置类路径
在幕后,settings.json
中有一个设置 java.project.referencedLibraries
。下面是有关如何自定义此设置的详细信息。
包含库
要引用的库使用一组全局模式进行描述。
例如
"java.project.referencedLibraries": [
"library/**/*.jar",
"/home/username/lib/foo.jar"
]
上述设置将把工作区库文件夹中的所有 .jar
文件以及来自指定绝对路径的 foo.jar
添加到项目的外部依赖项中。
然后,VS Code 会监视引用的库,如果这些依赖文件中的任何一个发生更改,项目将刷新。
默认情况下,VS Code 将使用全局模式 lib/**/*.jar
引用工作区 lib
目录中的所有 JAR 文件。
排除某些库
如果您想从项目中排除某些库,可以展开 java.project.referencedLibraries
以使用 include/exclude
字段并添加 exclude
全局模式。
"java.project.referencedLibraries": {
"include": [
"library/**/*.jar",
"/home/username/lib/foo.jar"
],
"exclude": [
"library/sources/**"
]
}
在上述示例中,library/sources
文件夹中的任何二进制 JAR 文件都将被忽略,不作为项目的外部依赖项。
附加源 JAR
默认情况下,引用的 {binary}.jar
将尝试在同一目录下搜索 {binary}-sources.jar
,如果找到匹配项,则将其作为源附加。
如果您想手动指定 JAR 文件作为源附件,可以在 sources
字段中提供键值映射。
"java.project.referencedLibraries": {
"include": [
"library/**/*.jar",
"/home/username/lib/foo.jar"
],
"exclude": [
"library/sources/**"
],
"sources": {
"library/bar.jar": "library/sources/bar-src.jar"
}
}
通过这种方式,bar-src.jar
将作为 bar.jar 的源文件附加。
轻量级模式
VS Code for Java 支持两种模式:轻量级模式和标准模式。在轻量级模式下,语言服务器仅解析源文件和 JDK;在标准模式下,语言服务器解析导入的依赖项并构建项目。当您需要一个快速启动且轻量级的环境来处理源文件时,轻量级模式是最佳选择,例如,阅读源代码、在源代码和 JDK 之间导航、查看大纲和 Javadoc,以及检测和修复语法错误。此外,在源文件和 JDK 范围内支持代码补全。
轻量级模式不解析导入的依赖项,也不构建项目,因此不支持运行、调试、重构、Linting 或检测语义错误。要使这些功能可用,您需要将工作区从轻量级模式切换到标准模式。
您可以通过使用以下选项配置 java.server.launchMode
来控制启动模式:
Hybrid
(默认)- 首先,工作区以轻量级模式打开。如果您的工作区包含未解析的 Java 项目,系统将询问您是否切换到标准模式。如果您选择以后,它将保持在轻量级模式。您可以单击状态栏上的语言状态项手动切换到标准模式。Standard
- 工作区以标准模式打开。LightWeight
- 工作区以轻量级模式打开。您可以单击状态栏上的语言状态项手动切换到标准模式。
语言状态项使用不同的图标指示当前工作区所处的模式。
- - 工作区以轻量级模式打开。
- - 工作区正在以标准模式打开。
- - 工作区以标准模式打开。
单击语言状态项可切换到标准模式。
构建状态
当您在 Visual Studio Code 中编辑 Java 源代码时,Java 语言服务器正在构建您的工作区,为您提供必要的语言功能。您可以通过单击状态栏中的语言状态项来查看详细的构建任务状态并观察幕后发生的情况。当通知显示语言服务器正在打开 Java 项目时,您还可以选择检查详细信息链接以查看构建任务状态。
其他资源
有多个 Visual Studio Code 扩展支持 Java 的不同构建系统。以下是针对几种流行构建系统的扩展。
- 适用于 Java 的 Maven
- 适用于 Java 的 Gradle
- 适用于 Java 的 Bazel (Bazel 适用于
BUILD
文件,没有 Java 集成))
如果您在使用上述功能时遇到任何问题,可以通过提交问题与我们联系。
后续步骤
继续阅读以了解更多信息: