A little bit of everything

元・情報系大学院生の備忘録

EclipseやSTSでlombokを使えるようにする方法

EclipseSTSlombokを使える状態にする方法の解説です。 したがって、「lombokとは?」みたいな説明は省略します。
環境:
 - OS:OS X El Capitan
 - Eclipse:Version: Neon.1a Release (4.6.1)

Step1: lombok.jar をダウンロードする

主に2種類のやり方があるかと思います。どっちでやってもOKです。

ダウンロードの方法1つ目:

以下から直接jarファイルをダウンロードする方法。 https://projectlombok.org/download
ダウンロードしたjarファイルは好きな場所に置きます。

ダウンロードの方法2つ目:

Maven を使ってダウンロードする方法。
pomに記述するdependency は以下に載っています。
https://projectlombok.org/setup/maven


自分は「ダウンロードの方法2つ目」でやりました。バージョンは1.16.18だったので、次のようなdependency を追加しました。

<dependencies>
   <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.16.18</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

lombokはボイラープレートコードをコンパイル時に生成します。したがって、アプリケーション実行時には必要ないライブラリなので、スコープはprovidedでOKです。

Step2: lombokをインストールする

Step1でダウンロードしてきた jar ファイルをダブルクリックします。

【メモ】
Step1でMavenを使った場合は、
.m2/repository/org/projectlombok/lombok/{バージョン}
lombok-{バージョン}.jar があるかと思います。
.m2ディレクトリは、デフォルトだとユーザディレクトリの直下になっているはずです。自分の場合だと、
/Users/Yuuki/.m2/repository/org/projectlombok/lombok/1.16.18/lombok-1.16.18.jar
となっていました。

jar ファイルをダブルクリックすると、↓のようなウィンドウが出ます。
f:id:yuukiyg:20171216205029p:plain

↑の写真ではIDEsの欄に3種類、EclipseSTSの情報が出ていますが、これはどのIDElombokをインストールするかを聞かれています。

↓の画像のように、「Specify location」のボタンを押してlombokを入れる対象のIDEを選択(①)すると、そのIDEがIDEsの欄に出てきます(②)。最後に、インストール対象のIDEを選択して、「Install/Upadate」を押します(③)。

f:id:yuukiyg:20171216205107p:plain


これでStep2は終了です。

Step3: iniファイルに設定を追加する

Eclipse.ini (STSの場合はSTS.ini)に以下の1行を追加します。
-vmargs -javaagent:lombok.jar


これでEclipse を再起動すれば、lombokが使えるようになります。
Eclipseimport lombok.Getter; とか書いてみると、問題なくインポートできるはずなので、確認してみてください。

ダメだった場合は、Eclipseを一旦閉じて、-clean のオプションを付けて起動しなおすなどしてみてください。