Rumah > Java > javaTutorial > teks badan

Cara menggunakan projek Lombok

WBOY
Lepaskan: 2024-07-24 19:26:41
asal
852 orang telah melayarinya

How to use project Lombok

Project Lombok ialah perpustakaan Java yang membantu mengurangkan kod boilerplate dengan menjana kaedah dan anotasi yang biasa digunakan secara automatik. Ia menyediakan anotasi yang boleh memudahkan dan mengurangkan verbositi kelas Java anda, menjadikan kod anda lebih mudah dibaca dan diselenggara.

Mengapa Menggunakan Projek Lombok?

  1. Kurangkan Kod Boilerplate:

    • Lombok menjana kod yang biasa digunakan seperti kaedah getter, setter, constructor, toString(), equals(), dan hashCode(), yang mengurangkan kod berulang dan kekusutan dalam kelas anda.
  2. Tingkatkan Kebolehbacaan:

    • Dengan mengalih keluar kod boilerplate, Lombok menjadikan kelas anda lebih ringkas dan lebih mudah dibaca dan difahami.
  3. Kebolehselenggaraan:

    • Dengan kurang kod plat dandang, pangkalan kod anda lebih mudah diselenggara dan difaktorkan semula.
  4. Gaya Pengekodan Konsisten:

    • Lombok memastikan gaya yang konsisten untuk kaedah biasa dan mengurangkan kemungkinan ralat atau ketidakkonsistenan.

Cara Menggunakan Projek Lombok

Langkah 1: Tambahkan Lombok pada Projek Anda

Maven:
Tambahkan kebergantungan Lombok pada fail pom.xml anda:

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.22</version>
    <scope>provided</scope>
</dependency>
Salin selepas log masuk

Gradle:
Tambahkan kebergantungan Lombok pada fail build.gradle anda:

dependencies {
    compileOnly 'org.projectlombok:lombok:1.18.22'
    annotationProcessor 'org.projectlombok:lombok:1.18.22'
}
Salin selepas log masuk

Langkah 2: Dayakan Lombok dalam IDE Anda

Kebanyakan IDE seperti IntelliJ IDEA dan Eclipse menyokong Lombok, tetapi anda perlu memasang pemalam Lombok untuk mendayakannya.

IDEA IntelliJ:

  1. Pergi ke Fail > Tetapan > Pemalam.
  2. Cari Lombok dan pasangkannya.
  3. Mulakan semula IntelliJ IDEA.

Gerhana:

  1. Pergi ke Bantuan > Eclipse Marketplace.
  2. Cari Lombok dan pasangkannya.
  3. Mulakan semula Eclipse.

Langkah 3: Gunakan Anotasi Lombok dalam Kod Anda

Berikut ialah beberapa anotasi Lombok yang biasa digunakan:

@Getter dan @ Setter:
Menjana kaedah getter dan setter untuk medan kelas anda.

import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
public class User {
    private Long id;
    private String name;
    private String email;
}
Salin selepas log masuk

@ToString:
Menjana kaedah toString() untuk kelas anda.

import lombok.ToString;

@ToString
public class User {
    private Long id;
    private String name;
    private String email;
}
Salin selepas log masuk

@EqualsAndHashCode:
Menjana kaedah equals() dan hashCode() untuk kelas anda.

import lombok.EqualsAndHashCode;

@EqualsAndHashCode
public class User {
    private Long id;
    private String name;
    private String email;
}
Salin selepas log masuk

@NoArgsConstructor, @AllArgsConstructor dan @RequiredArgsConstructor:
Menjana pembina untuk kelas anda.

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;
}
Salin selepas log masuk

@data:
Pintasan mudah yang menggabungkan ciri @ToString, @EqualsAndHashCode, @Getter pada semua medan dan @Setter pada semua medan bukan akhir dan @RequiredArgsConstructor.

import lombok.Data;

@Data
public class User {
    private Long id;
    private String name;
    private String email;
}
Salin selepas log masuk
Salin selepas log masuk

Contoh Kelas Menggunakan Lombok

Berikut ialah contoh kelas sebelum dan selepas menggunakan Lombok:

Tanpa 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);
    }
}
Salin selepas log masuk

Dengan Lombok:

import lombok.Data;

@Data
public class User {
    private Long id;
    private String name;
    private String email;
}
Salin selepas log masuk
Salin selepas log masuk

Ringkasan

  • Projek Lombok digunakan untuk mengurangkan kod boilerplate dalam aplikasi Java dengan menjana kaedah dan anotasi yang biasa digunakan secara automatik.
  • Faedah: Mengurangkan kod boilerplate, meningkatkan kebolehbacaan, meningkatkan kebolehselenggaraan dan memastikan gaya pengekodan yang konsisten.
  • Anotasi Biasa: @Getter, @Setter, @ToString, @EqualsAndHashCode, @NoArgsConstructor, @AllArgsConstructor, @RequiredArgsConstructor dan @Data.
  • Persediaan: Tambahkan pergantungan Lombok pada projek anda, dayakan Lombok dalam IDE anda dan gunakan anotasi Lombok dalam kod anda.

Dengan menyepadukan Lombok ke dalam projek anda, anda boleh memudahkan kod anda dengan ketara dan lebih fokus pada logik perniagaan daripada menulis kod boilerplate berulang.

Atas ialah kandungan terperinci Cara menggunakan projek Lombok. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!

sumber:dev.to
Kenyataan Laman Web ini
Kandungan artikel ini disumbangkan secara sukarela oleh netizen, dan hak cipta adalah milik pengarang asal. Laman web ini tidak memikul tanggungjawab undang-undang yang sepadan. Jika anda menemui sebarang kandungan yang disyaki plagiarisme atau pelanggaran, sila hubungi admin@php.cn
Tutorial Popular
Lagi>
Muat turun terkini
Lagi>
kesan web
Kod sumber laman web
Bahan laman web
Templat hujung hadapan