Spring Tool Suite 4インストールマニュアル

要旨

目的

• STS4が動く環境を作る
• STS4の設定を整える

環境

前提となる環境情報

• Windows10 (64bit)

今回導入する環境情報

• Java SE 8 (jdk-8u181)
• Maven 3.5.4
• Spring Tool Suite 4

概要

• Javaをインストールする
• Mavenをインストールする
• STSをインストールする
  • 日本語化する
  • lombokを有効化する
  • ワークスペースの設定を確認する

詳細手順

Javaをインストールする

1. 適当なjdkをインストールする。
   jdk8の場合はここからインストーラを取得し、実行する。

2. 環境変数JAVA_HOMEにjdkのインストールディレクトリのパスを登録する。

3. 環境変数Pathに%JAVA_HOME%/binを追加する。

4. 上記手順が完了したことを確認する。
   コマンドプロンプトから下記コマンドを実行する。

>echo %JAVA_HOME%
C:\Program Files\Java\jdk1.8.0_181

>java -version
java version "1.8.0_181"
Java(TM) SE Runtime Environment (build 1.8.0_181-b13)
Java HotSpot(TM) 64-Bit Server VM (build 25.181-b13, mixed mode)

Mavenをインストールする

1. Mavenをダウンロードする。
   ここの「Binary zip archive」からアーカイブを取得し、任意の場所に展開する。
2. 環境変数M2_HOMEに展開したディレクトリのパスを登録する。
3. 環境変数Pathに%M2_HOME%/binを追加する。
4. 上記手順が完了したことを確認する。
   コマンドプロンプトから下記コマンドを実行する。

>echo %M2_HOME%
C:\apache-maven-3.5.4

>mvn -v
Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-18T03:33:14+09:00)
Maven home: C:\apache-maven-3.5.4\bin\..
Java version: 1.8.0_181, vendor: Oracle Corporation, runtime: C:\Program Files\Java\jdk1.8.0_181\jre
Default locale: ja_JP, platform encoding: MS932
OS name: "windows 10", version: "10.0", arch: "amd64", family: "windows"

STSをインストールする

1. STSをダウンロードする。
   ここの「Spring Tools 4 for Eclipse」の「Download STS4」からアーカイブを取得し、任意の場所に展開する。

[2021/01/27追記]: 4.9.0 - WINDOWS 64-BITはjar形式になっている。jarを実行(ダブルクリック)するとjarと同じディレクトリに展開される。

日本語化する

1. Pleiadesプラグインをダウンロードする。
   ここの「Pleiades プラグイン・ダウンロード」からアーカイブを取得し、任意の場所に展開する。
2. 展開したディレクトリ内にあるsetup.exeを実行する。
3. 「日本語化するアプリケーション」の選択から上で展開したディレクトリ内の「SpringToolSuite4.exe」を選択する。
4. 「日本語化する」をクリックし、完了したら終了する。

lombokを有効化する

1. jarをダウンロードする。
   ここからjarを取得する。
2. lombokのjarを実行(ダブルクリック)する。
3. IDEが検出されない場合(多分されない)は「Specify location...」から上で展開したディレクトリを指定する。
4. 「IDEs」に「SpringToolSuite4.exe」が表示され、チェックが入っていることを確認して「Install/Update」をクリックし、完了したら終了する。

※この手順を行うことでSTSがlombokのアノテーションに従い、ソースに明示されていないメソッドを検知することができるようになる。

ワークスペースの設定を確認する

以下の設定はワークスペースごとに行う。

設定画面を開く

1. SpringToolSuite4.exeを実行し、ワークスペースとなるディレクトリを選択する。
2. メニューバーの「ウインドウ(W)」>「設定(P)」から設定画面を開く。

JREを確認する

1. サイドメニューの「Java」>「インストール済みのJRE」をクリックし、今回インストールしたjdkにチェックが入っているかを確認する。
2. 無い場合は右の「追加(A)...」から追加ウィザードを開く。
3. 「標準VM」を選択して次へ進み、JREホームとしてJAVA_HOMEと同じディレクトリを指定し、「完了(F)」をクリックする。
4. 「インストール済みのJRE」の一覧に追加したjdkが表示されるのでチェックを入れて、適用をクリックする。

Mavenのインストール先を確認する

1. サイドメニューの「Maven」>「インストール」をクリックし、今回インストールしたMavenにチェックが入っているかを確認する。
2. 無い場合は右の「追加(A)...」から追加ウィザードを開く。
3. インストール・タイプを「外部」とし、インストール・ホームにM2_HOMEと同じディレクトリを指定し、「完了(F)」をクリックする。
4. 「Mavenの起動で使用するインストールの選択：」の一覧に追加したMavenディレクトリが表示されるのでチェックを入れて、適用をクリックする。

フォントを確認する。

※デフォルトフォントであるConsolasを使うとコメント行の先頭の日本語が化けることがある。

1. サイドメニューの「一般」>「外観」>「色とフォント」をクリックする。
2. それぞれのエディターのフォントを適宜修正する。

参考サイト

Javaの構成管理ツールMavenのインストール手順
Spring Tool Suiteのインストールと日本語化 - Qiita
Lombok 使い方メモ - Qiita
Eclipseでコメントの前の方だけ文字化けする - Qiita