在 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 项目
可以通过单击导航栏中的 + 按钮或通过命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 中的命令 Java: Create Java Project... 创建新的 Java 项目。创建过程中,如果所需的扩展尚未安装,VS Code 会根据你的项目类型协助安装所需的扩展。
导入 Java 项目
你可以通过 文件 > 打开文件夹... 将现有 Java 项目和模块直接导入到你的工作区(请确保打开的文件夹包含你的构建工具脚本,例如 pom.xml
或 build.gradle
)。面向 Java 的 VS Code 将检测到你的项目并自动导入它们。
当你向项目中添加新模块时,可以触发命令 Java: Import Java projects in workspace 将其导入到你的工作区。此命令有助于在无需重新加载 VS Code 窗口的情况下将新项目导入到工作区。
导出为 JAR
你可以从项目视图或通过运行命令 Java: Export Jar... 将你的构建导出为 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,可以在命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 中触发命令 Java: Configure Java Runtime。此命令会打开一个视图,显示项目的运行时信息。
更改 Maven 和 Gradle 项目的 JDK
如果要更改 Maven 或 Gradle 项目的 JDK 版本,需要在构建脚本(pom.xml
或 build.gradle
)中进行更新。可以单击 查看如何进行此类更改。单击 将导航到项目的构建脚本文件。
更改非受管文件夹的 JDK
要更改非受管文件夹(不使用任何构建工具)的 JDK,可以单击 按钮。它将列出所有 JDK,你可以为非受管文件夹选择一个。
下载 JDK
如果你想下载新的 JDK,可以单击 download
链接,或在命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 中触发命令 Java: Install New JDK。它将打开一个新视图,引导你下载 JDK。
注意:要启用 Java 预览功能,请参阅如何将 VS Code 与新的 Java 版本配合使用。
配置非受管文件夹的类路径
Project Management for Java 扩展提供了一个用户界面来配置非受管文件夹的类路径。可以在类路径配置页面手动设置类路径。可以通过从命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 执行命令 Java: Configure Classpath 来打开它。
在某些罕见情况下,你可能需要通过从命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 执行命令 Java: Clean Java Language Server Workspace 来清理 Java 工作区,以让语言服务器重新构建你的依赖项。
依赖项管理
添加 Maven 依赖项
对于 Maven 项目,你可以通过单击项目视图中Maven Dependencies 节点旁边的 + 图标来添加依赖项。
管理非受管文件夹的依赖项
如果你的项目是没有使用任何构建工具的非受管文件夹。你可以通过单击Referenced Libraries 节点或其下方项目上的 + 图标或 - 图标来管理依赖项,或者你也可以直接将你的 jar 库拖到 Referenced Libraries
节点上。
你也可以在类路径配置页面管理依赖项。参阅:配置非受管文件夹的类路径
在幕后,settings.json
中有一个设置 java.project.referencedLibraries
。下面是关于如何自定义此设置的详细信息。
包含库
要引用的库使用一组 glob 模式进行描述。
例如
"java.project.referencedLibraries": [
"library/**/*.jar",
"/home/username/lib/foo.jar"
]
上述设置会将工作区库文件夹中的所有 .jar
文件以及指定绝对路径中的 foo.jar
添加到项目的外部依赖项中。
然后 VS Code 会监视引用的库,如果这些依赖文件中发生任何更改,项目将刷新。
默认情况下,VS Code 将使用 glob 模式 lib/**/*.jar
引用工作区 lib
目录中的所有 JAR 文件。
排除某些库
如果要从项目中排除某些库,可以展开 java.project.referencedLibraries
以使用 include/exclude
字段并添加 exclude
glob 模式。
"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 作为其源。
轻量模式
面向 Java 的 VS Code 支持两种模式:轻量模式和标准模式。在轻量模式下,语言服务器仅解析源文件和 JDK;在标准模式下,导入的依赖项会被解析,并且项目由语言服务器构建。当你需要一个快速启动且轻量的环境来处理源文件时,轻量模式效果最佳,例如,阅读源代码、在源代码和 JDK 之间导航、查看大纲和 Javadoc,以及检测和修复语法错误。此外,在源文件和 JDK 的范围内支持代码补全。
轻量模式既不解析导入的依赖项也不构建项目,因此不支持运行、调试、重构、代码检查或检测语义错误。要使用这些功能,需要将工作区从轻量模式切换到标准模式。
可以通过配置 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 集成))
如果在使用上述功能时遇到任何问题,可以通过提交一个问题与我们联系。
后续步骤
继续阅读以了解更多关于