プロジェクトロンボクの使い方

Project Lombok は、一般的に使用されるメソッドとアノテーションを自動的に生成することで定型コードを削減するのに役立つ Java ライブラリです。これは、Java クラスの冗長性を簡素化して軽減するアノテーションを提供し、コードをより読みやすく、保守しやすくします。

プロジェクト ロンボクを使用する理由

1. 定型コードを削減:

   • Lombok は、ゲッター、セッター、コンストラクター、toString()、equals()、hashCode() メソッドなどの一般的に使用されるコードを生成します。これにより、クラス内のコードの繰り返しや煩雑さが軽減されます。

2. 読みやすさの向上:

   • Lombok は定型コードを削除することで、クラスをより簡潔にし、読みやすく理解しやすくします。

3. 保守性:

   • 定型コードが減ると、コードベースの保守とリファクタリングが容易になります。

4. 一貫したコーディング スタイル:

   • Lombok は、一般的なメソッドの一貫したスタイルを保証し、エラーや不一致の可能性を減らします。

プロジェクト ロンボクの使用方法

ステップ 1: Lombok をプロジェクトに追加する

Maven:
Lombok 依存関係を pom.xml ファイルに追加します:

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

グラドル:
Lombok 依存関係を build.gradle ファイルに追加します:

dependencies {
    compileOnly 'org.projectlombok:lombok:1.18.22'
    annotationProcessor 'org.projectlombok:lombok:1.18.22'
}

ステップ 2: IDE で Lombok を有効にする

IntelliJ IDEA や Eclipse などのほとんどの IDE は Lombok をサポートしていますが、有効にするには Lombok プラグインをインストールする必要があります。

IntelliJ IDEA:

1. ファイルに移動 >設定 >プラグイン。
2. Lombok を検索してインストールします。
3. IntelliJ IDEA を再起動します。

日食:

1. ヘルプに移動 > Eclipse マーケットプレイス。
2. Lombok を検索してインストールします。
3. Eclipse を再起動します。

ステップ 3: コードで Lombok アノテーションを使用する

一般的に使用される Lombok アノテーションをいくつか示します:

@Getter および @ Setter:
クラスのフィールドのゲッター メソッドとセッター メソッドを生成します。

import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
public class User {
    private Long id;
    private String name;
    private String email;
}

@ToString:
クラスの toString() メソッドを生成します。

import lombok.ToString;

@ToString
public class User {
    private Long id;
    private String name;
    private String email;
}

@EqualsAndHashCode:
クラスのequals()メソッドとhashCode()メソッドを生成します。

import lombok.EqualsAndHashCode;

@EqualsAndHashCode
public class User {
    private Long id;
    private String name;
    private String email;
}

@NoArgsConstructor、@AllArgsConstructor、および @RequiredArgsConstructor:
クラスのコンストラクターを生成します。

import lombok.NoArgsConstructor;
import lombok.AllArgsConstructor;
import lombok.RequiredArgsConstructor;

@NoArgsConstructor
@AllArgsConstructor
@RequiredArgsConstructor
public class User {
    private Long id;
    private final String name;
    private final String email;
}

@data:
@ToString、@EqualsAndHashCode、すべてのフィールドの @Getter、すべての非最終フィールドの @Setter、および @RequiredArgsConstructor の機能をバンドルする便利なショートカット。

import lombok.Data;

@Data
public class User {
    private Long id;
    private String name;
    private String email;
}

Lombok を使用したクラスの例

Lombok を使用する前後のクラスの例を次に示します。

ロンボク島なし:

public class User {
    private Long id;
    private String name;
    private String email;

    public User() {}

    public User(Long id, String name, String email) {
        this.id = id;
        this.name = name;
        this.email = email;
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

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

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", email='" + email + '\'' +
                '}';
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        User user = (User) o;
        return Objects.equals(id, user.id) &&
                Objects.equals(name, user.name) &&
                Objects.equals(email, user.email);
    }

    @Override
    public int hashCode() {
        return Objects.hash(id, name, email);
    }
}

ロンボク島と:

import lombok.Data;

@Data
public class User {
    private Long id;
    private String name;
    private String email;
}

まとめ

• Project Lombok は、一般的に使用されるメソッドと注釈を自動的に生成することにより、Java アプリケーションの定型コードを削減するために使用されます。
• 利点: 定型コードを削減し、可読性を向上させ、保守性を高め、一貫したコーディング スタイルを保証します。
• 共通のアノテーション: @Getter、@Setter、@ToString、@EqualsAndHashCode、@NoArgsConstructor、@AllArgsConstructor、@RequiredArgsConstructor、および @Data。
• セットアップ: Lombok 依存関係をプロジェクトに追加し、IDE で Lombok を有効にし、コードで Lombok アノテーションを使用します。

Lombok をプロジェクトに統合すると、コードが大幅に簡素化され、定型的なコードを繰り返し記述するのではなく、ビジネス ロジックに集中できます。

以上がプロジェクトロンボクの使い方の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。