在 VSCode 中配置 Java 开发环境

发表于 分类于 阅读次数：

前言

面向对象（先导）课程组推荐的 Java IDE 是 IDEA，虽说 IDEA 确实是一款功能很强大、完善的软件，但 Jetbrain 的软件有个通病就是相当臃肿，而且多个语言就需要多个软件，相当麻烦。而 VSCode 作为一款轻量化的编辑器，很好地规避了以上问题。人生苦短，我用 VSCode。

如果读者有任何疑问，欢迎联系 admin@aostl.ink 。

VSCode 的安装

点击 VSCode官网，选择对应的版本进行下载并安装即可。

Java 的安装

参见 菜鸟教程。

Git 的安装与配置

Git 的安装

Linux(Ubuntu) sudo apt-get install git -y

Linux(CentOS) sudo yum install git -y

Mac OS X 从 AppStore 安装 Xcode，运行 Xcode，选择菜单 “Xcode” -> “Preferences”，在弹出窗口中找到 “Downloads”，选择 “Command Line Tools”，点 “Install” 即可完成安装。

Windows 在 官网 上选择最新版本进行下载安装。

git 的配置

1
2
git config --global user.name "<Your Name>"
git config --global user.email "<Your e-mail>"

配置 SSH-KEY

打开终端： Linux(Ubuntu) Ctrl+Alt+T

Windows Win+R 然后输入 cmd 并回车（Enter）

Mac OS X 我不知道

在终端内输入 ssh-keygen -t rsa 并一路回车。这表示你的 SSH-KEY 没有额外的密码、也没有修改默认的存储位置，往后如若遇到 SSH-KEY 相关的提示，需要你输入密码，只需要回车即可。 然后打开你保存密钥的文件夹（如图）

找到里面的 xxx.pub 文件，用文本编辑器打开并全部复制到 Gitlab 账户下的 SSH 密钥选项（http://gitlab.oo.buaa.edu.cn/-/profile/keys ）内，如图所示。

最后在终端输入 ssh -T git@<Address> 得到 Welcome to GitLab 的回复即可。 其中 <Address> 是让你换成对应的地址，比如 gitlab.oo.buaa.edu.cn

在 VSCode 内使用 Git

打开 VSCode，选择“克隆Git仓库”，然后按照提示输入对应仓库的地址（git@gitlab.oo.buaa.edu.cn:xxxx）即可。

仓库的地址如下图所示

编辑好了之后，选中左侧工具栏的第三个选项“源代码管理”

会看到“更改”一栏下有你所编辑的文件，选中加号即可将文件放入缓冲区（相当于 git add）

点击“提交”会提交到本地仓库（相当于 git commit），点击“提交”选项旁的“更多选项”下的“提交和推送”会在提交的同时推送到远程仓库（相当于git commit + push）。

常见问题

Q： 点击了“提交”之后弹出来一个 COMMIT_EDITMSG 文件并且一直在加载？ A：该文件是该次提交的说明文件，你可以在这里编辑提交信息。注意，开头带“#”的内容是注释信息，不会被提交。不能进行没有说明的提交。 或者，你也可以在点击“提交”按钮前在按钮上方的“消息”一栏中输入这次提交的说明，并点击“提交”按钮，这样就不会弹出文件了。

VSCode 下的 JAVA 插件推荐

  1. Checkstyle for Java
  2. Debugger for Java
  3. Extension Pack for Java
  4. Test Runner for Java
  5. GitLens — Supercharge Git in VS Code

在 VSCode 内使用 Checkstyle for Java

下载好课程组提供的 config.xml 并放到一个你喜欢的地方，打开 Checkstyle for Java 插件的“拓展设置”（可以通过点击插件右下角的齿轮图标找到），在“Checkstyle 配置文件所在路径”的输入框内输入你的 config.xml 所在的路径（如 D:\config.xml），注意课程组的配置文件不支持更高版本的 Checkstyle，应该选择 8.23 版本的 Checkstyle（可以在拓展设置的最底部找到，默认应该是 9.x 或 10.x）。