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

2024-12-11

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

Javaのインストール

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

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

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

asdf でインストールした場合、 JAVA_HOME の設定には専用のスクリプトが用意されています。(参考: JAVA_HOME

$ java --version
openjdk version "21.0.5" 2024-10-15 LTS
OpenJDK Runtime Environment Corretto-21.0.5.11.1 (build 21.0.5+11-LTS)
OpenJDK 64-Bit Server VM Corretto-21.0.5.11.1 (build 21.0.5+11-LTS, mixed mode, sharing)

Mavenのインストール

同じく asdf を利用します。

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

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

プロジェクトの作成

mvn コマンドで作成

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

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

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

$ mvn spring-boot:run

VSCode 拡張機能で作成

(1)VSCode を起動して Shift + Command + P を実行すると、 コマンドパレット が起動します。

(2)コマンドパレットが起動したら、 Spring Initialzr と途中まで打つと選択肢が現れるので、ここでは Spring Initialzr: Create Maven Project... を選択します。

(3)SpringBoot のバージョンの選択肢が出るので選びます。

(4)プログラミング言語の選択を求められるので Java を選択します。

(5)Group ID の入力を求められるので com.pepese.sample のような ID を入力します。

(6)Artifact ID の入力を求められるので springboot-sample-jar のような ID を入力します。

(7)Packaging Type の選択を求められるので Jar を選択します。

(8)Java バージョンの選択を求められるので 21 を選択します。

(9)依存するライブラリの選択を求められるので、ここでは Spring Boot DevTools を選択します。(複数選択可能)

(10)プロジェクト作成ディレクトリの場所を求められるので指定します。

以上で、VSCode 拡張機能を用いてプロジェクトを作成することができます。

おすすめ書籍

おすすめ記事