モーダルを閉じる工作HardwareHub ロゴ画像

工作HardwareHubは、ロボット工作や電子工作に関する情報やモノが行き交うコミュニティサイトです。さらに詳しく

利用規約プライバシーポリシー に同意したうえでログインしてください。

Lombok の使い方 (Java)

モーダルを閉じる

ステッカーを選択してください

お支払い手続きへ
モーダルを閉じる

お支払い内容をご確認ください

購入商品
」ステッカーの表示権
メッセージ
料金
(税込)
決済方法
GooglePayマーク
決済プラットフォーム
確認事項

利用規約をご確認のうえお支払いください

※カード情報はGoogleアカウント内に保存されます。本サイトやStripeには保存されません

※記事の執筆者は購入者のユーザー名を知ることができます

※購入後のキャンセルはできません

作成日作成日
2017/04/01
最終更新最終更新
2019/08/06
記事区分記事区分
一般公開

Lombok というライブラリを導入すると、Getter/Setter といったよく記述するコードをアノテーションだけで自動生成できます。Google Guava と同様に、Java の冗長なコードを削減する効果があります。簡単な使い方をまとめます。

インストール

こちらのページの情報をもとにインストールします。

Eclipse パッチ適用

Eclipse で使用するためには、JAR ファイルをダウンロードしてダブルクリックすることで、GUI インストーラを起動します。Specify location で Eclipse のホームを指定して Install/Update をクリックします。macOS の場合は app 内の ~/bin/Eclipse.app/Contents/Eclipse/ を指定します。インストールが完了すると、eclipse.ini が更新されて lombok.jar が Eclipse ホームにコピーされます。

$ diff -u /path/to/eclipse.ini ~/bin/Eclipse.app/Contents/Eclipse/eclipse.ini
--- /path/to/eclipse.ini 2017-04-01 19:33:25.000000000 +0900
+++ /path/to/bin/Eclipse.app/Contents/Eclipse/eclipse.ini 2017-04-01 19:33:51.000000000 +0900
@@ -23,3 +23,4 @@
 -Xdock:icon=../Resources/Eclipse.icns
 -XstartOnFirstThread
 -Dorg.eclipse.swt.internal.carbon.smallFonts
+-javaagent:../Eclipse/lombok.jar

$ ls ~/bin/Eclipse.app/Contents/Eclipse/lombok.jar

後述の Maven, Gradle ビルドツールを利用していない場合、あるいは利用していても Maven, Gradle で管理対象に含めていない場合は、直接 Eclipse の設定を行います。

cp /path/to/lombok.jar /path/to/workspace/myproject/
  1. プロジェクト右クリック → Refresh
  2. プロジェクト右クリック → Properties → java Build Path → Libraries タブ → Add JARS → Apply → OK

Maven, Gradle 設定

最新版を、こちらのページを参照して設定します。以下は 2017/04/01 現在の設定内容です。

pom.xml (Maven)

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

build.gradle (Gradle >= 2.12)

compileOnly "org.projectlombok:lombok:1.16.16"

サンプルコード

公式ドキュメントを参考にサンプルコードを記載します。

@Getter および @Setter

MyClass.java

package myproject;

import lombok.Getter;
import lombok.Setter;
import lombok.AccessLevel;

public class MyClass {
    @Getter @Setter private boolean employed = true;
    @Getter @Setter private int age;
    @Setter(AccessLevel.PROTECTED) private String name;
}

Main.java

package myproject;

public class Main {

    public static void main(String[] args) {
        MyClass obj = new MyClass();
        obj.setEmployed(false);
        obj.setAge(123);
        obj.setName("myname");
        System.out.println(obj.isEmployed()); // boolean は `is` です。
        System.out.println(obj.getAge()); // int 等は `get` です。
    }
}

実行例

false
123

javap コマンドによるクラスファイルの解析

$ javap -private bin/myproject/MyClass.class
Compiled from "MyClass.java"
public class myproject.MyClass {
  private boolean employed;
  private int age;
  private java.lang.String name;
  public myproject.MyClass();
  public boolean isEmployed();
  public void setEmployed(boolean);
  public int getAge();
  public void setAge(int);
  protected void setName(java.lang.String);
}

@NonNull

null が代入された際に NullPointerException 例外を発生させたい場合に利用します。

MyClass.java

package myproject;

import lombok.Getter;
import lombok.NonNull;
import lombok.Setter;

public class MyClass {
    @Getter @Setter @NonNull private String myval;
}

Main.java

package myproject;

public class Main {

    public static void main(String[] args) {
        MyClass obj = new MyClass();
        obj.setMyval(null);
        System.out.println(obj.getMyval());
    }
}

実行例

Exception in thread "main" java.lang.NullPointerException: myval
    at myproject.MyClass.setMyval(MyClass.java:8)
    at myproject.Main.main(Main.java:7)

@ToString

MyClass.java

package myproject;

import lombok.ToString;

@ToString
public class MyClass {
    private String myval1;
    private String myval2;
}

Main.java

package myproject;

public class Main {

    public static void main(String[] args) {
        MyClass obj = new MyClass();
        System.out.println(obj.toString());
    }
}

実行例

MyClass(myval1=null, myval2=null)

@EqualsAndHashCode

Java データ型のうち参照型の値の比較は == では行えません。参照型のひとつ String 型で実装されている equals() のように、値を比較するためのメソッドを生成するためには @EqualsAndHashCode アノテーションを利用します。メンバ変数をもとにハッシュ値を計算する hashCode() メソッドも定義されます。hashCode が同じであれば equal であると考えます。

MyClass.java

package myproject;

import lombok.EqualsAndHashCode;

@EqualsAndHashCode(exclude = "myval3")
public class MyClass {
    public String myval1;
    public String myval2;
    public String myval3;
}

Main.java

package myproject;

public class Main {

    public static void main(String[] args) {
        MyClass obj1 = new MyClass();
        MyClass obj2 = new MyClass();

        obj1.myval1 = "xxx";
        obj1.myval2 = null;
        obj2.myval1 = "xxx";
        obj2.myval2 = null;
        System.out.println(obj1.equals(obj2));
        System.out.println(obj1.hashCode());
        System.out.println(obj2.hashCode());

        obj1.myval1 = "yyy";
        System.out.println(obj1.equals(obj2));
        System.out.println(obj1.hashCode());
        System.out.println(obj2.hashCode());
    }
}

実行例

true
7033964
7033964
false
7092551
7033964

@Data

@Data アノテーションを適用すると、@Getter, @Setter, @EqualsAndHashCode, @ToString すべてを適用したのと同じ状況になります。

MyClass.java

package myproject;

import lombok.Data;

@Data
public class MyClass {
    public String myval1;
    public String myval2;
}

Main.java

package myproject;

public class Main {

    public static void main(String[] args) {
        MyClass obj1 = new MyClass();
        MyClass obj2 = new MyClass();

        obj1.setMyval1("xxx");
        obj1.setMyval2(null);
        obj2.setMyval1("xxx");
        obj2.setMyval2(null);
        System.out.println(obj1.equals(obj2));
        System.out.println(obj1.hashCode());
        System.out.println(obj2.hashCode());

        obj1.setMyval1("yyy");
        System.out.println(obj1.equals(obj2));
        System.out.println(obj1.hashCode());
        System.out.println(obj2.hashCode());

        System.out.println(obj1.toString());
        System.out.println(obj2.toString());
    }
}

実行例

true
7033964
7033964
false
7092551
7033964
MyClass(myval1=yyy, myval2=null)
MyClass(myval1=xxx, myval2=null)

val

lombok.val を import すると、Scala における val のような記法が Java で利用できるようになります。再代入が行われないことが保証された定数を、型を省略して定義できます。

Main.java

package myproject;

import lombok.val;

public class Main {

    public static void main(String[] args) {
        val str = "str";
        System.out.println(str);
    }
}
Likeボタン(off)0
詳細設定を開く/閉じる
アカウント プロフィール画像

フロントエンドエンジニア。React Hookが好きです!

記事の執筆者にステッカーを贈る

有益な情報に対するお礼として、またはコメント欄における質問への返答に対するお礼として、 記事の読者は、執筆者に有料のステッカーを贈ることができます。

>>さらに詳しくステッカーを贈る
ステッカーを贈る コンセプト画像

Feedbacks

Feedbacks コンセプト画像

    ログインするとコメントを投稿できます。

    ログインする

    関連記事

    • Spring Security フォームログインのサンプルコード
      Spring フレームワークによる Web アプリケーション開発で、ログイン処理を実装する際は Spring Security が便利です。ここでは特に Spring Boot で Web アプリケーションを開発する場合を対象とし、フォームによる ID/Password ログインを行うためのサンプルコードをまとめます。 公式ドキュメント [Spring Security チュートリアル](http...
      えびちゃんえびちゃん12/4/2019に更新
      いいねアイコン画像0
    • Java配列の宣言方法 (C/C++との違い)
      Javaの配列 Javaの配列宣言方法はC/C++と似ているようで若干異なる。 初期化しない場合 C/C++の int array[10]; はJavaでは int array[] = new int[10]; となる。同様にC/C++の int array[3][3]; はJavaでは int array[][] = new int[3][3]; となる。 初期化
      てんとうむしてんとうむし5/13/2018に更新
      いいねアイコン画像0
    • PlantUML による UML 図の描き方
      サムネイル画像-c788fffde5
      PlantUML はテキスト形式で表現されたシーケンス図やクラス図といった UML (Unified Modeling Language) 図の情報から画像を生成するためのツールです。簡単な使い方をまとめます。 インストール方法の選択 Atom や Eclipse のプラグインをインストールしてエディタから利用する方法、JAR をダウンロードして Java コマンドで実行する方法、Redmine ...
      kentakenta1/21/2020に更新
      いいねアイコン画像0
    • Akka HTTP サンプルコード (Scala)
      サムネイル画像-a98142497c
      Akka アクターを用いて実装された汎用 HTTP フレームワークです。Spray の後継です。コアモジュールである akka-http-core は 2016/2/17 に experimental が外れました。akka-http などのいくつかのサブモジュールは 2016/3/1 現在 experimental のままですが、基本的な
      雄太雄太10/7/2021に更新
      いいねアイコン画像0
    • Kestrel の使用例
      Kestrel は Message Queue (MQ) の実装のひとつです。一般に MQ はアプリケーション間やプロセス間、スレッド間で非同期に通信するために用いられます。メッセージの送信側は MQ に書き込めば受信側の応答を待たずに次の処理に非同期に進むことができます。Kestrel はわずか 2500 行程の Scala で実装されており JVM で動作します。MQ 自体はメモリ上に存在する...
      したくんしたくん10/12/2017に更新
      いいねアイコン画像0