Lombok のご紹介

この CookBook では、Lombok について紹介しています。
intra-mart 開発本部では Lombok を利用しています。
Lombok を簡単に説明すると、「アノテーションを書くだけで setter や getter, toString などのメソッドを自動生成してくれるツール」です。

導入

1. Project Lombok から、lombok.jar をダウンロードします。
2. eclipse の場合 eclipse.ini, eBuilder の場合 eBuilder.ini ファイルに以下を追加します。
   -javaagent:lombok.jar
3. eclipse.ini または eBuilder.ini があるディレクトリに、ダウンロードした lombok.jar ファイルを配置します。

lombok.jar は開発環境にのみ必要であり、実行環境には必要ありません。

利用例

package jp.co.intra_mart.cookbook.im_cookbook_134385;

import lombok.Data;

@Data
public class LombokTest {
    private boolean boolean1;

    private Boolean boolean2;

    private int int1;
}

以下のように、各 private フィールドの getter, setter, toString, equals, hashCode が自動で生成されています。

@Data アノテーションについての詳細はこちらをご覧ください。

このように、lombok を使うことでわずらわしい実装を行わなくて済むようになります。
また、eclipse などのツールからソースコードを生成するのと比べて、フィールドが増えた際に実装の修正を忘れてしまうといった不注意を防ぐ事もできます。

Lombok には @Data 以外にも豊富な機能があります。
詳細はこちらをご覧ください。

この CookBook では、Lombok についてご紹介しました。
是非ご活用ください。