常用的VS Code插件（Java后台、前端）

记录一下自己常用的VS Code插件，免得需要的时候又找不到了……

Java开发插件

Debugger for Java

一个轻量级的Java代码调试工具。安装Language Support for Java by Red Hat这个插件的时候会默认安装它。使用这个插件有如下要求：

• Java版本再1.8或以上
• VS Code的版本再1.19.0或以上
• Language Support for Java by Red Hat插件版本再0.14.0或以上

使用方法

1. 打开VS Code
2. 打开Java工程，Maven、Gradle、Eclipse这些工程都支持。
3. 打开一个Java文件
4. 在launch.json文件中添加调试的设置信息
5. 按F5进入调试

launch.json中的设置信息

• mainClass：必填项，启动类的完整路径。
• args：传递给程序的命令行参数。必须是字符串或者字符串的数组。
• sourcePaths：用于启动JVM的模块路径。默认从当前项目中启动。
• modulePaths：用户启动JVM的类路径。默认从当前项目中启动。
• encoding：字符集编码，默认为UTF-8。
• vmArgs：JVM的其他选项和系统属性。
• projectName：项目名称。
• cwd：程序的工作目录。
• env：工程的其他选项。
• stopOnEntry：启动程序后自动暂停运行（相当于启动后立即进入断点）。
• console：运行项目所使用的控制台。有三个可选项：internalConsole、integratedTerminal、externalTerminal。其中internalConsole不支持控制台输入。
• shortenCommandLine：类路径或者VM参数过长的时候可能会超出系统的命令行最大字符串限制。用这个设置可以减少命令行长度。包含none、jarmanifest、auto三个值，默认为auto。
• stepFilters：步进时跳过指定的类或者方法。
• hostName：项目运行后的IP地址。
• port：项目运行后的端口号。
• processId：要附加的进程。
• timeout：重连时的超时时间。
• sourcePaths：程序的其他源目录。默认会在当前工程下寻找源代码。
• projectName：工程名。不同的工程可能有相同的类名，当出现这种情况的时候需要指定工程名，不然调试的时候不知道应该跳哪个断点。

插件设置

{
	// 发送给VS Code的日志的最低级别，默认为警告。
	"java.debug.logLevel": warn,
	// 在变量视图中以16进制显示数字，默认为false
	"java.debug.settings.showHex": false,
	// 在变量视图中显示静态变量，默认值为false
	"java.debug.setting.showStaticVariables": false,
	// 在变量视图中显示类名称，默认值为false
	"java.debug.setting.showQualifiedNames": false,
	// 在变量视图中显示逻辑结构，默认值为true
	"java.debug.setting.showLogicalStructure": true,
	// 在变量或调试控制台视图中显示的最大字符串长度，默认值为0，也就是不进行修剪
	"java.debug.settings.maxStringLength": 0,
	// 在变量或者调试控制台中双精浮点数的精度
	"java.debug.settings.numericPrecision": 2,
	// 热部署
	"java.debug.setting.hotCodeReplace": manual,
	// 自动运行build指令。manual表示手动编译，auto表示自动编译，never表示从来不编译更改
	"java.autobuild.enabled": manual,
	// 在程序主方法上显示运行和调试按钮，默认为true
	"java.debug.settings.enableRunDebugCodeLens": true,
	// 启动Java工程之前强制构建工作区，默认值为true
	"java.debug.settings.forceBuildBeforeLaunch": true,
	// Java工程调试的时候使用的命令行工具，三个选项与lauch.json中的一样。
	"java.debug.settings.console": integratedTerminal
}

Java Dependency Viewer

展示工程用到的依赖。这个插件是Language Support for Java by Red Hat的组件，安装后者时会默认一同安装前者。
使用这个插件需要满足如下要求：

• Java版本在1.8.0及以上
• VS Code的版本在1.28.0及以上
• Language Support for Java by Red Hat插件的版本在0.32.0及以上

插件设置

{
	// 设置是否在依赖窗口显示依赖的成员
	"java.dependency.showMembers": false,
	// 设置在浏览文件的时候是否同步展示依赖
	"java.dependency.syncWithFolderExplorer": true,
	// 设置是否自动刷新依赖信息
	"java.dependency.autoRefresh": true,
	// 设置自动刷新的时间间隔
	"java.dependency.refreshDelay": 2000ms,
	// 设置如何展示依赖包，flat表示平面展示，hierarchical表示分层展示
	"java.dependency.packagePresentation": flat
}

Java Extension Pack

Java开发要用到的依赖包，它包括了6个插件：

• Language Support for Java
• Debugger for Java
• Java Test Runner
• Maven for Java
• Java Dependency Viewer
• Visual/ Studio IntelliCode
  这个插件本身没有什么作用，安装它的时候会一同安装上述6个插件。

Java Test Runner

Java程序测试用的插件。支持JUnit4、JUnit5，TestNG等测试方法。但是暂不支持JUnit3。
想要使用这个插件的话，需要满足如下条件：

• Java版本为1.8.0或以上
• VS Code版本为1.23.0或以上
• 安装Language Support for Java by Red Hat插件
• 安装Debugger for Java插件

插件设置

{
	// 设置在哪里展示测试报告，有sideView和currentView两个选项
	"java.test.report.position": "sideView",
	// 设置测试报告是否在执行之后自动展示，有always、哦那Failure、never三个选项
	"java.test.report.showAfterExecution": onFailure,
	// 设置是否在编译器中显示对应的代码
	"java.test.editor.enableShortcuts": true,
	// 设置测试日志的级别，有error，info，verbose三个级别
	"java.teset.log.level": info,
	// 指定要运行的测试用例的配置
	"java.test.config": {
		// 测试用例的配置
	},
	// 设置默认配置的名字
	"java.test.defaultConfig": ""
}

Language Support for Java by Red Hat

VS Code中的Java运行环境插件。如果想在VS Code中运行Java工程，就需要安装这个插件。该插件可以配置多组Java运行环境，并设置默认的运行环境，例如：

"java.configuration.runtimes":[
	{
		"name": "JavaSE-1.8",
		"path": "/path/to/jdk-8",
	},
	{
		"name": "JavaSE-11",
		"path": "/path/to/jdk-11",
	),
	{
		"name": "JavaSE-14",
		"path": "/path/to/jdk-14",
		"default": true
	}
]

Maven for Java

在VS Code中想要使用Maven的话，就需要安装这个扩展。这个插件支持从Maven Archetype生成Maven工程，也可以通过pom文件去更新项目的Maven仓库。

插件设置

{
	// 指定搜索Maven项目时要排除的文件夹的文件路径模式。
	"maven.excludedFolders": [
		"**/.*",
		"**/node_modules",
		"**/target",
		"**/bin",
		......
	],
	// 设置是否使用Maven包装器，如果true则尝试从上级目录中循环找mvnw，如果为false则使用PATH中设置的mvn
	"maven,executable.preferMavenWrapper": true,
	// maven路径
	"maven.executable.path": "/usr/local/apache-maven-3.6.0/bin/mvn",
	// mvn指令的默认选项
	"maven.executable.options": "-o -DskipTest",
	// 设置是否自动升级pom文件中的依赖
	"maven.pomfile.autoUpdateEffectivePOM": false,
	// 指定用于查找pom.xml文件的全局模式。
	"maven.pomfile.globPattern": "**/pom.xml",
	// 设置Maven使用的Java环境变量，如果为false则使用系统默认的
	"maven.terminal.useJavaHome": false,
	// 指定环境变量名称和值的数组。 这些环境变量值将在首次执行Maven之前添加到终端会话中。
	"maven.terminal.customEnv": [],
	// 指定预先定义的常用命令执行。
	"maven.terminal.favorites": [],
	// 指定查看Maven项目的方式。
	"maven.view": flat
}

前端开发插件

Auto Close Tag

自动补全HTML/XML文件的结束标签。包括如下具体功能：

• 在开发者输入完开始标签后自动补全结束标签
• 自动补全完结束标签后，将光标置于开始标签与结束标签之间
• 允许设置不自动关闭的标签列表
• 自动关闭没有结束标签的标签
• 使用快捷键或者指令面板关闭标签

插件设置：

{
	// 支持sublime模式
	"auto-close-tag.SublimeText3Mode": true,
	// 设置插件是否使用，默认值为true
	"auto-close-tag.enableAutoCloseTag": true,
	// 设置是否自动关闭没有结束标签的标签，默认值为true
	"auto-close-tag.enableAutoCloseSelfClosingTag": true,
	// 设置使用该插件的开发语言，如果支持所有语言的话用["*"]
	"auto-close-tag.activationOnLanguage": [
		"xml",
		"php",
		...
	],
	// 设置不会自动关闭的标签列表
	"auto-close-tag.excludedTags": [
		...
	],
	// 支持所有模式（VS Code和Sublime），默认值为false
	”auto-close-tag.fullMode": true
}

Auto Rename Tag

当开发者修改开始标签或者结束标签的时候，自动修改对应的结束标签或者开始标签。

插件设置

{
	// 设置使用该插件的语言
	"auto-rename-tag.activationOnLanguage": [
		...
	]
}

HTML CSS Support

写CSS的时候提供自动补全和提示功能的插件。
插件功能：

• 自动补全class属性
• 自动补全Id属性
• 支持class和id的Zen Coding
• 扫描工作区文件夹内的CSS样式文件
• 支持远程CSS

HTML Snippets

提供HTML文档的语言支持，包括标签补全、提示，标签的高亮等等。

常用工具插件

GitLens

个人认为git插件中最好用的一个。有了这个插件之后，开发的过程中会在代码的后方标识出这行代码是谁什么时候提交的，非常清晰了然。

插件设置

GitLens的提供的设置非常多，一时间没能全部整理出来，且文档对很多设置解释得不是非常的清楚。这里先给出部分设置。毕竟大部分设置都是平时用不上的且保持默认值就能提供足够的便利，没必要一个不漏地归纳它们的用法。在以后的使用中将用到的设置补充进来即可。

{
	// 设置当前行注释的绝对日期
	"gitlens.currentLine.dateFormat": "yyyy-mm-dd",
	// 设置是否在行间显示版本信息
	"gitlens.currentLine.enabled": true,
	// 设置行间注释的格式
	"gitlens.currentLine.format": "",
	// 设置行间注释能否滚动
	"gitlens.currentLine.scrollable": true,
	// 指定单击作者时要执行的操作
	"gitlens.codeLens.authors.command": true,
	// 设置是否在文件开头显示修改此文件的作者数量
	"gitlens.codeLens.authors.enabled": true,
	// 设置默认情况下是否提供git代码的片段展示
	"gitlens.codeLens.enabled": true,
	// 设置是否在只有一个符号的单行提供git注释
	"gitlens.codeLens.includeSingleLineSymbols": true,
	// 设置是否显示最近的更改
	"gitlens.codeLens.recentChange.command": true,
	// 设置是否显示一个查看最近更改的按钮
	"gitlens.codeLens.recentChange.enabled": true,
	// 设置git注释是否显示在文件中
	"gitlens.codeLens.scopes": true,
	// 设置在指定语言文档中git注释显示的位置
	"gitlens.codeLens.scopesByLanguage": "",
	// 通过文档符号设置是否显示git注释
	"gitlens.codeLens.symbolScopes": true,
}

Lombok Annotations Support for VS Code

Lombok是一个可以在工程中引入的依赖包。其作用是可以自动生成实体类的getter、setter以及toString等等常用方法。因此有Lombok依赖的时候，就不必为实体类写getter和setter方法了。但是这种情况下VS Code是会报错的，因为private类型的成员变量在没有写出getter和setter的时候是无法访问的。这个插件的作用在于”告诉“编译器，不必理会没有getter、setter、toString等方法的问题，从而在开发、编译的过程中不报出错误和警告。
该插件支持如下注解：

• @Getter, @Setter
• @ToString,
• @EqualsAndHashCode
• @AllArgsConstructor, @RequiredArgsConstructor, @NoArgsConstructor
• @Log
• @Slf4j
• @Data
• @Builder
• @Singular
• @Delegate
• @Value
• @Accessors
• @Wither
• @SneakyTrows
• @val
• @UtilityClass

纯粹为了好看用的插件

background

可以将VS Code的背景替换成自己喜欢的图片。拿自己喜欢的照片当开发背景还是蛮愉悦心情的。这个插件通过修改vscode的scc文件来实现修改背景的目的，所以在初次安装或者VS Code升级的时候会有下面的提示，选择【不再提示】即可：

Installation apppears to be corrupt, please reinstall.

不过我本人使用的时候，即便点击不再提示它还是总弹出来这类信息。索性只是一个提示弹框，对其他方面没有任何影响。

插件设置

{
	// 插件是否启用
	"background.enabled": true,
	// 是否使用默认图片
	"background.useDefault": true,
	// 自定义图片
	"background.customTmages": [
		"图片一路径",
		"图片二路径",
		...
	],
	// 自定义样式
	"background.style": {
		// 图片的样式（Object）
	},
	"每个图片的独立样式": [
		{
			// 图片一的样式
		}, {
			// 图片二的样式
		},
		...
	],
	// 前景图还是背景图，true表示图在代码上面，false表示图在代码下面
	"background.useFront": true,
	// 循环模式，会重复显示图片
	"background.loop": true
}

如果图片的链接是外部链接，受到VS Code的显示，http请求获得的图片是不允许使用的，务必使用https协议开头的外链地址。
插件卸载的时候依赖于node环境，因为要自动删除添加的样式。如果没有node环境的话，需要在设置里先将background.enabled设置为false，然后再删除插件。

Material Icon Theme

图标主题，能让侧边栏中的文件和文件夹更好看一些。VS Code中图标主题千千万，这个是我个人比较喜欢的一款。

Noctis

VS Code的一款主题插件，比较喜欢它的亮色主题。