Visual Studio CodeでJavaの開発環境を作成する

2022-04-08

Visual Studio Code (以降 VSCode) は多くのプログラミング言語に対応した強力なコードエディターです。
この記事では、Java、Maven、VSCodeのインストール・設定・使い方について記載します。

Javaのインストール

asdf でインストールします。
asdf については以下の記事を参照してください。

ここでは Amazon ディストリビューションである Corretto を利用します。

$ asdf plugin add java
$ asdf install java corretto-17.0.2.8.1
$ asdf global java corretto-17.0.2.8.1

asdf でインストールした場合、 JAVA_HOME の設定には専用のスクリプトが用意されています。(参考: JAVA_HOME
シェルの種類に合わせて .zshrc などに以下を追記します。

# To set JAVA_HOME in your shell's initialization add the following:
. ~/.asdf/plugins/java/set-java-home.bash

# For zsh shell, instead use:
. ~/.asdf/plugins/java/set-java-home.zsh

# For fish shell, instead use:
. ~/.asdf/plugins/java/set-java-home.fish

# For xonsh shell, instead use:
source ~/.asdf/plugins/java/set-java-home.xsh
$ exec $SHELL -l
$ java --version
openjdk 17.0.2 2022-01-18 LTS
OpenJDK Runtime Environment Corretto-17.0.2.8.1 (build 17.0.2+8-LTS)

Mavenのインストール

同じく asdf を利用します。

$ asdf plugin add maven
$ asdf install maven 3.8.4
$ asdf global maven 3.8.4
$ mvn -v
Apache Maven 3.8.4 (9b656c72d54e5bacbed989b64718c159fe39b537)
Maven home: /Users/xxxxx/.asdf/installs/maven/3.8.4
Java version: 17.0.2, vendor: Amazon.com Inc., runtime: /Users/xxxxx/.asdf/installs/java/corretto-17.0.2.8.1
Default locale: ja_JP, platform encoding: UTF-8
OS name: "mac os x", version: "12.1", arch: "x86_64", family: "mac"

プロジェクトの作成

通常の Java プロジェクトを作成する場合は以下のコマンドで作成します。

$ mvn archetype:create -DgroupId=com.example -DartifactId=sample

SpringBoot のプロジェクトを作成する場合は spring initialzr を使用すると便利です。
各種設定を入力した後に GENERATE すると SpringBoot の雛形プロジェクトをダウンロードできます。
最低限 Spring Web を Dependencies として追加しておけば REST API アプリケーションを作成できます。
作成したプロジェクトの実行は以下です。

$ mvn spring-boot:run

VSCodeのインストールと設定

VSCode のインストールは以下を参照してください。

以下の拡張機能を入れます。

  • Extension Pack for Java ( Microsoft 製)
  • Maven for Java ( Microsoft 製)
  • Debugger for Java ( Microsoft 製)
  • Project Manager for Java ( Microsoft 製)
  • Test Runner for Java ( Microsoft 製)
  • Spring Initializr Java Suppoirt ( Microsoft 製)
  • Spring Boot Dashboard ( Microsoft 製)
  • Spring Boot Tools ( Pivotal 製)
  • Spring Boot Extension Pack ( Pivotal 製)
  • Lombok Annotations Support for VS Code

ショートカットは以下のようなものがありますが、 VSCode メニューの「移動」を見ればすぐ分かります。

  • インポート:( コードのエラーの箇所を選択してから) Command + .
  • クラス定義に飛ぶ:(該当箇所を選択してから) F12fn 押しながら)
  • 参照先へ飛ぶ:(該当箇所を選択してから) Shift + F12

おすすめ書籍

おすすめ記事