🚀 在 VS Code 中

导航和编辑 Java 源代码

Visual Studio Code 首先是一个源代码编辑器,具有丰富的编辑功能。在本文档中,我们将介绍一些 Java 特有的功能,这些功能在处理 Java 代码时非常有用。

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

代码导航

使用大纲视图,您可以方便地导航当前文件中的成员。项目视图也提供了项目概览。作为一个 Java 编辑器,它还支持调用层次结构、类型层次结构、定义导航、在工作区中搜索类型等功能。

搜索符号

您可以在当前文件或工作区中搜索符号,以更快地导航代码。

在工作区中搜索符号

要在当前工作区中搜索符号,请先按 ⌘T (Windows, Linux Ctrl+T),然后输入符号的名称。将像以前一样出现潜在匹配项的列表。如果您选择在尚未打开的文件中找到的匹配项,则会先打开该文件,然后再导航到匹配项的位置。或者,您也可以使用快速打开 (⌘P (Windows, Linux Ctrl+P)),然后输入“#”命令来搜索当前工作区。⌘T (Windows, Linux Ctrl+T) 只是“#”命令的快捷方式,因此一切工作方式都相同。

在当前文件中搜索符号

要在当前文件中搜索符号,请使用快速打开 (⌘P (Windows, Linux Ctrl+P)),然后输入“@”命令,然后输入您要查找的符号的名称。将出现潜在匹配项的列表,并在您键入时进行筛选。从匹配项列表中选择以导航到其位置。

查看定义

您可以使用“查看定义”功能快速查看符号的定义方式。此功能会在查看窗口中显示定义附近的几行代码,以便您在不离开当前位置的情况下查看。

要查看符号的定义,请将光标放在源代码中使用的符号上的任意位置,然后按 ⌥F12 (Windows Alt+F12, Linux Ctrl+Shift+F10)。或者,您可以从上下文菜单中选择查看定义(右键单击,然后选择查看定义)。

跳转到定义

您还可以使用“跳转到定义”功能快速导航到符号的定义位置。

要跳转到符号的定义,请将光标放在源代码中使用的符号上的任意位置,然后按 F12。或者,您可以从上下文菜单中选择跳转到定义(右键单击,然后选择跳转到定义)。当符号只有一个定义时,您将直接导航到其位置,否则,竞争的定义将显示在上一节中描述的查看窗口中,您必须选择要跳转到的定义。

跳转到父类实现

您可以通过悬停时单击“跳转到父类实现”链接来跟踪类实现和重写方法。

Spring Navigation

调用层次结构

“调用层次结构”视图显示从函数到函数或从函数到函数的所有调用,并允许您深入查看调用者的调用者和调用的调用。右键单击函数,然后选择查看 > 查看调用层次结构

Call Hierarchy Peek

您也可以在函数体中单击鼠标右键,然后选择显示调用层次结构

Call Hierarchy Menu

类型层次结构

“类型层次结构”视图显示 Java 对象之间的继承关系。您可以右键单击类型,然后选择显示类型层次结构

折叠区域

折叠区域允许您折叠或展开代码片段,以便更好地查看源代码。

智能选择

使用智能选择(语义选择),您可以根据源代码中插入符号位置的语义信息来扩展或缩小选择范围。

  • 要扩展选择范围,请使用 ⌃⇧⌘→ (Windows, Linux Shift+Alt+Right)
  • 要缩小选择范围,请使用 ⌃⇧⌘← (Windows, Linux Shift+Alt+Left)

语义高亮

语法高亮是一项重要功能,可让您更有效地阅读代码。借助语义高亮,VS Code 可以根据 Java 语言服务提供的符号信息提供更准确的源代码着色。

下面只是一个示例,左侧是启用语义高亮后的行为,右侧是仅使用语法高亮的行为。

Semantic Highlighting

您可以在 Java 语言支持扩展 wiki 上了解有关 Java 语义高亮的更多详细信息。

使用 Spring Boot 导航代码

Spring Boot 工具扩展为 Spring Boot 项目提供了增强的导航和代码完成支持。

  • @/ 显示所有已定义的请求映射(映射路径、请求方法、源位置)
  • @+ 显示所有已定义的 Bean(Bean 名称、Bean 类型、源位置)
  • @> 显示所有函数(原型实现)
  • @ 显示代码中的所有 Spring 注释

Spring Navigation

要了解有关 Visual Studio Code 对 Spring Boot 的更多支持,请阅读“Visual Studio Code 中的 Spring Boot”

代码编辑

借助 IntelliSense 提供的智能代码完成和签名详细信息,代码编辑也很容易。您可以使用代码片段以及各种代码操作(例如生成 Getter/Setter 和组织导入)来进一步提高工作效率。

Visual Studio Code 中的 Java 支持会自动检测代码中的问题,并为您提供快速修复建议。

有关重构和代码操作的更多详细信息,请参阅“重构和源代码操作”

IntelliSense

Visual Studio Code 中 Java 的代码完成由 Red Hat 的 Language Support for Java™ 提供。该扩展由 Eclipse 背后的同一 Java 开发工具 (JDT) 提供支持,因此您可以期待相同的支持水平。

此外,还有 AI 辅助的 IntelliSense,称为 IntelliCode。它通过将您最有可能使用的内容放在完成列表的顶部来节省您的时间。IntelliCode 建议基于 GitHub 上成千上万个拥有超过 100 个星标的开源项目,因此它经过高质量项目中最常见用法的训练。当与您的代码上下文结合使用时,完成列表会进行定制以推广这些实践。以下是 IntelliCode for Java 的实际应用。

IntelliCode 与流行的 Java 库和框架(如 Java SE 和 Spring)配合良好。无论您是在开发单体 Web 应用程序还是现代微服务,它都将为您提供帮助。

创建新文件

当您创建 Java 源代码文件时,VS Code 支持应用模板。当您在文件资源管理器中创建 .java 文件时,语言服务器将自动生成类主体,并为您填充包信息

代码片段

Visual Studio Code 支持各种流行的 Java 代码片段,以提高您的工作效率,例如 class/interface、syserr、sysout、if/else、try/catch、static main method。使用来自 Java 语言服务器的信息,它还在选择期间提供代码片段的预览。

例如,键入“sout”或“sysout”将生成 System.out.println() 的代码片段。
同样,键入“main”或“psvm”将生成 public static void main(String[] args) {} 的代码片段。

Code Snippet

完整的快捷方式列表如下所示

代码片段快捷方式

快捷键 描述
ctor 公共构造函数
dowhile Do-while 语句
foreach, iter 迭代数组或 Iterable
fori 迭代数组
if If 语句
ifelse If-else 语句
ifnull 检查 null 的 If 语句
ifnotnull 检查非 null 的 If 语句
main, psvm 公共静态 main 方法
new 创建新对象
private_method 私有方法
private_static_method 私有静态方法
prf 私有字段
protected_method 受保护的方法
public_method 公共方法
public_static_method 公共静态方法
switch Switch 语句
syserr, serr 打印到标准错误输出
sysout, sout 打印到标准输出
systrace, soutm 将当前方法打印到标准输出
try_catch Try/catch 块
try_resources Try-with-resources 语句
while While 语句

后缀代码片段快捷方式

快捷键 模板内容 描述
cast ((SomeType) expr) 将表达式强制转换为新类型
else if (!expr) 创建一个取反的 if 语句
for for (T item : expr) 创建一个 for 语句
fori for (int i = 0; i < expr.length; i++) 创建一个迭代数组的 for 语句
forr for (int i = expr.length-1; i >= 0; i--) 创建一个反向迭代数组的 for 语句
if if (expr) 创建一个 if 语句
nnull if (expr != null) 创建一个 if 语句并检查表达式是否不解析为 null
null if (expr == null) 创建一个 if 语句,检查表达式是否解析为 null
sysout System.out.println(expr) 将受影响的字符串发送到 System.out.println(..) 调用
throw throw expr 抛出给定的异常
var T name = expr 创建一个新变量
while while (expr) {} 创建一个 while 循环