Spring Boot STS利用

STS(Spring Tool Suite)上でlombokを利用してみた

今回は、STSを利用して、lombokを利用してみたので、その手順を共有する。STS上でlombokを利用できるようにするには、あらかじめSTS上にlombokをインストールしておく必要がある。

前提条件

下記記事の手順に従って、STSによるSpring Bootプロジェクトを作成済であること

STS上でGradleを使ってWeb画面のSpring Bootプロジェクトを作成してみた今回は、STSを利用して、下記記事と同等のSpring Bootアプリケーションを作成してみたので、その手順を共有する。なお、今回もビル...

lombokのインストール

STSにlombokをインストールする。その手順は以下の通り。

1) STS(Spring Tool Suite)が起動している場合は終了する

2) lombok-(バージョン).jarファイルを探し、ダブルクリック
下図のように、「C:\Users\(ユーザー名)\.gradle\caches\modules-(X)\files-(X.X)」下にGradleでダウンロードされたファイルが配置されているので、そこから「lombok-(バージョン).jar」を探す
lombokのインストール_2

3) 下記ダイアログが出るため「OK」ボタンを押下
lombokのインストール_3

4) 「Specify location …」ボタンを押下し、STSの起動exe(SpringToolSuite4.exe)を選択
lombokのインストール_4_1

lombokのインストール_4_2

5) 「IDEs」に先ほど設定したexeファイルが選択されていることを確認後、「Install / Update」ボタンを押下
lombokのインストール_5

6) インストールが完了すると、下記ダイアログが表示されるので、「Quit Installer」を押下
lombokのインストール_6

7) 「SpringToolSuite4.ini」の最終行に「-javaagent:C:\work\sts\sts-4.5.1.RELEASE\lombok.jar」が追記されていることを確認
lombokのインストール_7_1

lombokのインストール_7_2

サンプルプログラムの内容

今回作成したlombokを利用したサンプルプログラムの構成は以下の通り。
サンプルプログラムの構成
なお、上記の赤枠のうち、前提条件のプログラムと比較して、「DemoForm.java」は今回新規で作成したプログラムで、他は変更したプログラムとなる。

build.gradleの内容は以下の通りで、lombokの設定を追加している。

なお、STSの場合は、build.gradleの修正内容を反映するには、以下のように、プロジェクトを選択し右クリックし、「Gradle」メニューから「Gradleプロジェクトのリフレッシュ」を選択する。
Gradleプロジェクトのリフレッシュ

Formオブジェクトの内容は以下の通り。lombokのアノテーション「@Data」をクラスに付与した上で、テスト用文字列「testStr」を定義している。「@Data」が付与されているため、「testStr」のGetter/Setterメソッドが利用できるようになっている。

次に、コントローラクラスの内容は以下の通り。DemoFormのテスト用文字列「testStr」に値を設定した後で、それを画面表示用のModelオブジェクトに設定している。

さらに、HTMLファイルの内容は以下の通り。Modelオブジェクトの値を画面上で表示している。

STSを起動し、Webブラウザ上で「http://(サーバー名):(ポート番号)/」とアクセスすると、下記画面が表示され、DemoFormのテスト用文字列「testStr」に設定した値が表示されることが確認できる。
サンプルプログラムの実行結果

要点まとめ

  • STS上でlombokを利用するには、あらかじめSTS上にlombokをインストールしておく必要がある。