Lombok

サポート対象

NRIのOpenStandiaが提供するLombok最新情報

バージョンアップ情報
Lombok情報

バージョンアップ情報

一覧を見る

Lombok情報

Lombokとは
ユースケース
動作環境
Lombokのライセンス
製品ダウンロード
参考情報
オープンソース年間サポートサービス

Lombokとは

Lombok（ロンボック）は、JavaのDTO（Data Transfer Object）のような単調な処理が連続するコードを簡潔に記述するためのJavaライブラリです。アノテーション1つでクラスがDTOとして機能し、getter/setterメソッドやequalsメソッドを書く必要がなくなります。

例えば、以下のようなDTOをLombokを利用して書き直してみましょう。

public public class Author {
    private final int id;
    private String name;
    private String surname;

    public Author(int id) {
        this.id = id;
    }    

    public int getId() {
        return id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getSurname() {
        return surname;
    }

 public void setSurname(String surname) {
        this.surname = surname;
    }

    @Override
    public int hashCode() {
       final int PRIME = 31;
       int result = 1;
       result = prime * result + getId();
       result = prime * result + 
           ((getName() == null) ? 0 : getName().hashCode());
       result = prime * result + 
           ((getSurname() == null) ? 0 : getSurname().hashCode());
       return result;
    }

    @Override
    public boolean equals(Object o) {
       if (o == this) return true;
       if (!(o instanceof Author)) return false;
       Author other = (Author) o;
       if (!other.canEqual((Object)this)) return false;
       if (this.getId() == null ? other.getId() != null : 
           !this.getId().equals(other.getId())) return false;
       if (this.getName() == null ? other.getName() != null : 
           !this.getName().equals(other.getName())) return false;
       if (this.getSurname() == null ? other.getSurname() != null : 
           !this.getSurname().equals(other.getSurname())) return false;
       return true;
    }
}

50行を超えていたコードを6行で記述することができます。

@Data
public class Author {
    private final int id;
    private String name;
    private String surname;
}

Lombokは、ビルドツールやIDE（統合開発環境）に組み込むことができます。
例えば、MavenでビルドするJavaプロジェクトにLombokを組み込む場合は、以下の依存関係をpom.xmlに記述します。


<dependencies>
    ・・・
    <!-- 以下の依存関係を追加 -->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <scope>provided</scope>
    </dependency>
</dependencies>

そしてIDE（ここではIntellij IDEA）にLombokのプラグインをインストールします。