在 VS Code 中管理 Java 项目
Java 项目管理器扩展可帮助你管理 Java 项目及其依赖项。它还可以帮助你创建新的 Java 项目、包和类。要在 Visual Studio Code 中获得完整的 Java 语言支持,可以安装 Java 扩展包,其中包含了 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
)。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,你可以在命令面板 (⇧⌘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 预览功能,请参阅如何在新版 Java 中使用 VS Code。
为非托管文件夹配置类路径
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"
]
上面的设置会将工作区 library 文件夹中的所有 .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 上。
轻量模式
VS Code for Java 支持两种模式:轻量模式和标准模式。在轻量模式下,语言服务器只解析源文件和 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
- Bazel for Java (Bazel 用于
BUILD
文件,没有 Java 集成))
如果你在使用上述功能时遇到任何问题,可以通过提交问题与我们联系。
后续步骤
继续阅读以了解更多信息