本エントリでは、チーム開発でIntelliJ IDEAを使う場合に、
Lombokプラグインを利用させるために必要な設定の手順を示します。

この手順では「.idea」配下のファイルをGitで共有しますが、
本手順の前に、最低限Git管理に追加しておくファイルは以下のエントリを参考にしてください。

Gitで共有管理すべきIntelliJ IDEAの設定ファイルのメモ
http://takemikami.com/2018/08/29/GitIntelliJ-IDEA.html

Lombok Pluginのインストール

Preferences → Plugins → Browse Repositoriesを開き、
「Lombok Plugin」を検索し、プラグインをインストールします。

Annotation Processorの設定

プロジェクトの設定をAnnotation Processor有効に変更しておきます。

Preferences → Build, Execution, Deployment → Compiler → Annotation Processor
と選び、
「Enable annotation processing」にチェックを入れておきます。

intellij-lomobk02

この設定は「.idea/compiler.xml」というファイルに保存されます。

必須プラグインにLombok Pluginの追加

次に、プロジェクトに必要なプラグインとして「Lombok Plugin」を追加しておきます。

Preferences → Build, Execution, Deployment → Required Pluginを選び
以下の画面のように「Lombok Plugin」を追加します。

intellijideagit-plugin02

intellijideagit-plugin03

これは「.idea/externalDependencies.xml」というファイルに設定が保存されます。

設定ファイルのGitへの追加

ここまでの手順で生成された設定ファイルをGit管理に追加します。
具体的には以下のファイルを追加することになります。

  • .idea/compiler.xml
  • .idea/externalDependencies.xml

これをGit管理に追加します。
「.gitignore」ファイルは、以下のようなイメージになります。

.idea/*
!.idea/gradle.xml
!.idea/misc.xml
!.idea/compiler.xml
!.idea/externalDependencies.xml

ここまでの流れで、プロジェクトでLombokを利用するように設定出来ました。

Lombok Pluginの設定について

プラグインをインストールした後、
Other Settings → Lombok Plugin
から、Lombok Pluginの各種設定が出来るのですが、
これらの設定は、.idea/workspace.xmlというファイルに保存されます。

このファイルは各ユーザの操作に依存した情報が含まれるので、
Gitで共有するのは避けた方がよいと考えています。

ここの設定は、各自で「Enable Lobmok Plugin for this project」に
チェックを入れてもらうのが妥当でしょう。

intellij-lomobk01