アノテーションをつけるだけで、Getter, Setterといった繰り返し書くコードをコンパイル時に自動生成してくれるLombok、便利ですよね。そんなLombokをIntelliJ IDEAで使う方法をメモしておきます。環境は以下のとおりです。
- macOS Mojave 10.14.3
- IntelliJ IDEA Version 2018.3.3(Community版)
IntelliJ IDEAでLombokを使う方法
IntelliJ IDEAでLombokを使うためには、Lombok Pluginというプラグインが必要です。このプラグインがないと、IntelliJ IDEAがLombokのアノテーションを認識せずにコンパイルエラーとなったり、便利な機能(Delombokなど)が使えなかったりします。
Lombok Pluginをインストールする
メニューの「IntelliJ IDEA」 > 「Preferences」 > 「Plugins」までたどっていき、「Lombok Plugin」で検索し、インストールします。
インストール後、プラグインを有効化するためにIntelliJ IDEAの再起動が求められるので「Restart」を選択し、IntelliJ IDEAの再起動を行います。
Annotation Processorsを有効化する
Lombok Pluginを使うためにはIntelliJ IDEAのAnnotation Processorsという設定を有効化する必要があります。
メニューの「IntelliJ IDEA」 > 「Preferences」 > 「Build, Execution, Deployment」 > 「Annotation Processors」までたどっていき、「Enable annotation processing」にチェックを入れ、「OK」を選択します。
Lombokを依存性に追加する
あとは、ビルドツールの依存性にLombokを追加しれやればOKです。
Gradleの場合は、build.gradle
に追加します。
Mavenの場合は、pom.xml
に追加します。
これで、IntelliJ IDEAでLombokが使えるようになりました。
動作確認
ここまで設定できれば、IntelliJ IDEAでLombokが使えることを確認しておきましょう。Lombokのアノテーション@Getter
, @Setter
を付与したクラスを作成します。
作成したクラスをアウトライン表示(Ctrl
+F12
or ⌘
+F12
)すると、メンバ変数のGetter, Setterが定義されているはずです。Lombokがきちんと動作していますね。
まとめ
IntelliJ IDEAでLombokを使う方法でした。