Projek Lombok di Jawa

pengenalan

Lombok ialah perpustakaan yang bertindak sebagai pemproses anotasi untuk Java, direka untuk menghapuskan lebihan dalam kod. Fungsi utamanya adalah untuk mengautomasikan penjanaan kod berulang atau "boilerplate" - elemen yang, walaupun perlu, tidak menambah nilai langsung kepada logik program kami. Terutamanya, ia digunakan untuk penjanaan automatik pada masa penyusunan kaedah getter dan setter, pembina, equals(), hashCode(), toString(), kaedah, antara elemen biasa lain dalam kelas Java.

Daripada menulis berdozen baris kod secara manual untuk fungsi asas ini, Lombok membenarkan anda mentakrifkannya menggunakan anotasi mudah, menghasilkan kod yang lebih bersih, lebih boleh diselenggara dan kurang terdedah kepada ralat.

Kemudahan

Untuk menggunakan Lombok dalam projek Java, anda perlu menambah kebergantungan yang sepadan dalam fail pom.xml (sekiranya projek Maven) atau build.gradle (dalam kes projek Gradle), sebagai tambahan kepada pemasangan pemalam yang sepadan dalam IDE yang kami gunakan. Semasa siaran ini, kami akan menggunakan Maven dan IntelliJ IDEA sebagai contoh.

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

Sekiranya terdapat sebarang keraguan, anda sentiasa boleh menyemak dokumentasi rasmi Lombok:

• Lombok dengan Maven
• Lombok dalam IntelliJ IDEA

@data

Apabila kami membuat kelas kami kerap melakukan tindakan berikut, sama ada secara manual atau dengan pintasan yang disediakan oleh IDE kami:

• Encapsulate atribut dan jana kaedah getter dan setternya
• Jana pembina kosong dan satu lagi yang menerima semua atribut
• Laksanakan kaedah equals(), hashCode() dan toString().

Nah, Lombok mempunyai anotasi @Data yang membolehkan kami melakukan semua ini dalam satu baris, menjana semua yang berkaitan dengan POJO (Objek Java Lama Biasa). Anotasi ini ialah gabungan anotasi @Getter, @Setter, @EqualsAndHashCode, @NoArgsConstructor dan @AllArgsConstructor yang akan kita lihat kemudian.

import lombok.Data;

@Data
public class Persona {
    private String nombre;
}

public class Main {
    public static void main(String[] args) {
        Persona p1 = new Persona();
        p2.setNombre("Maria");

        System.out.println(p1.getNombre());
    }
}

@NoArgsConstructor, @AllArgsConstructor dan @RequiredArgsConstructor

Anotasi ini membolehkan kami menjana pembina secara automatik dengan gabungan argumen yang berbeza, memandangkan atribut digunakan mengikut susunan ia diisytiharkan dalam kelas.

• @NoArgsConstructor: Menjana pembina tanpa hujah (kosong), jika tidak mungkin untuk menjana satu, pengecualian akan dilemparkan, untuk mengelakkan ini hanya gunakan anotasi seperti berikut @NoArgsConstructor(force = true).
• @AllArgsConstructor: Menghasilkan pembina dengan semua atribut kelas sebagai argumen.
• @RequiredArgsConstructor: Menghasilkan pembina untuk semua medan akhir dan/atau ditandakan dengan anotasi @NonNull.

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

@Getter dan @setter

Anotasi ini membolehkan kami menjana kaedah pengambil dan penetap secara automatik untuk semua atribut kelas, atau hanya untuk yang ditandakan dengan anotasi yang sepadan, iaitu, ia boleh digunakan pada peringkat kelas atau atribut.

import lombok.Data;

@Data
public class Persona {
    private String nombre;
}

public class Main {
    public static void main(String[] args) {
        Persona p1 = new Persona();
        p2.setNombre("Maria");

        System.out.println(p1.getNombre());
    }
}

@ToString

Anotasi ini menjana kaedah toString() secara automatik, yang mengembalikan perwakilan rentetan kelas dan atributnya dengan format berikut: ClassName(attribute1=value1, attribute2=value2, ...). Secara lalai semua atribut bukan statik kelas disertakan dalam hasilnya, tetapi atribut khusus boleh dikecualikan menggunakan atribut @ToString.Exclude. Sekiranya anda hanya mahu memaparkan nilai atribut dan bukan nama seperti yang diisytiharkan, anda boleh menggunakan @ToString(includeFieldNames = false).

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Persona {
    private String nombre;
}

@EqualsAndHashCode

Membolehkan anda menjana kaedah equals() dan hashCode() daripada semua atribut kelas Jika anda ingin mengecualikan atau menyertakan atribut, anda boleh melakukannya menggunakan anotasi @EqualsAndHashCode.Exclude dan @EqualsAndHashCode.Include. masing-masing.

import lombok.*;

@Getter
@Setter
public class Persona {
    private String nombre;
    private String apellido;
}

@Nilai

Sebelum ini di Java untuk mencipta kelas tidak berubah, satu siri langkah perlu dijalankan, seperti menjadikan kelas dan/atau atribut daripada jenis terakhir dan kaedah penetap tidak akan dihasilkan. Lombok memudahkan kami mencipta kelas tidak berubah menggunakan anotasi @Value, yang menggabungkan anotasi @Getter, @ToString, @EqualsAndHashCode dan @AllArgsConstructor untuk menjana kelas tidak berubah. Semua atribut ditandakan sebagai muktamad peribadi dan kaedah penetap tidak dijana. Ia ialah varian @Data yang tidak boleh diubah.

import lombok.*;

public class Persona {
    @Getter @Setter
    private String nombre;
    private String apellido;
}

Dalam versi Java terkini anotasi ini kehilangan makna berbanding penggunaan Rekod, kerana ia mempunyai tujuan yang sama, dan lebih praktikal untuk menggunakan rekod. Jika anda berminat untuk mengetahui lebih lanjut tentang topik ini, terdapat lebih banyak catatan di blog tentang rekod.

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

@val

Anotasi ini membolehkan kami mengisytiharkan pembolehubah sebagai muktamad dan membuat kesimpulan secara automatik jenis datanya, iaitu, tidak perlu menentukan jenis data pembolehubah, Lombok mengambil kira membuat kesimpulan. Ia berguna sekiranya jenis data pembolehubah sangat panjang atau kompleks, dengan cara ini anda mengelak daripada mengulanginya.

import lombok.Data;

@Data
public class Persona {
    private String nombre;
}

Anotasi ini mungkin kehilangan makna jika kita terus menggunakan var akhir atau hanya var untuk jenis inferens, yang lebih mudah kerana ia merupakan ciri bahasa. Jika anda berminat untuk mengetahui lebih lanjut mengenai perkara ini, anda boleh rujuk post berikut

public class Main {
    public static void main(String[] args) {
        Persona p1 = new Persona();
        p2.setNombre("Maria");

        System.out.println(p1.getNombre());
    }
}

@var

Ia berfungsi sama seperti @val, tetapi ia tidak mengisytiharkan pembolehubah sebagai muktamad, ia hanya menyimpulkan jenisnya. Adalah perlu untuk mempertimbangkan konsep jenis inferens, kerana anda tidak boleh mengisytiharkan sesuatu jenis String dan kerana ia tidak muktamad untuk memberikannya nilai jenis int. Sekali lagi, anotasi ini digantikan dengan var dalam versi Java terkini.

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Persona {
    private String nombre;
}

@NonNull

Anotasi ini boleh digunakan pada atribut kelas dan parameter kaedah, ia pada asasnya menunjukkan bahawa nilai atribut tidak boleh batal, sekiranya percubaan dibuat untuk memberikan nilai nol kepada atribut yang ditandakan dengan @NonNull ia akan dilemparkan NullPointerException, iaitu, jika (param == null) buang NullPointerException baru("param ditanda bukan nol tetapi adalah nol"); Tanpa mengira pengecualian yang dijananya, penggunaannya lebih ketara dalam IDE itu sendiri, kerana ia akan menunjukkan kepada kita dalam beberapa cara bahawa nilai ini tidak boleh batal.

import lombok.*;

@Getter
@Setter
public class Persona {
    private String nombre;
    private String apellido;
}

@Pembersihan

Anotasi ini membolehkan kami memastikan bahawa mana-mana sumber yang menggunakannya jika ia mempunyai kaedah close() atau yang melaksanakan antara muka AutoCloseable atau Closeable ditutup secara automatik pada penghujung blok kod di mana ia berada. Ia berguna sekiranya bekerja dengan sumber yang perlu dikeluarkan, seperti fail, sambungan ke pangkalan data, dsb.

import lombok.*;

public class Persona {
    @Getter @Setter
    private String nombre;
    private String apellido;
}

Hasil ini boleh diperoleh secara manual jika kita menggunakan percubaan dengan sumber.

import lombok.*;

@AllArgsConstructor
@ToString
public class Persona {
    private String nombre;
    @ToString.Exclude
    private String apellido;
}

// Output: Persona(nombre=Maria)

@pembina

Anotasi ini membolehkan kami menjana corak reka bentuk Pembina secara automatik, iaitu objek yang membolehkan kami membina objek kompleks langkah demi langkah, supaya atribut objek yang berbeza boleh dikonfigurasikan tanpa perlu panggil pembina dengan banyak parameter. Ia berguna sekiranya kelas mempunyai banyak atribut dan kami tidak mahu mempunyai pembina dengan banyak parameter.

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

@Dengan

Anotasi ini membolehkan kami mencipta kaedah yang mengembalikan salinan objek semasa dengan atribut yang diubah suai, iaitu, ia menghasilkan kaedah denganAttributeName(objek objek) yang membolehkan kami membuat salinan objek semasa dengan objek atribut diubah suai oleh nilai yang kami luluskan sebagai hujah. Ia berguna sekiranya kita ingin mengubah suai atribut objek tanpa mengubah suai objek asal.

import lombok.Data;

@Data
public class Persona {
    private String nombre;
}

public class Main {
    public static void main(String[] args) {
        Persona p1 = new Persona();
        p2.setNombre("Maria");

        System.out.println(p1.getNombre());
    }
}

Sehingga ini kami telah melihat beberapa anotasi yang boleh digunakan paling kerap, setiap satu daripada ini mungkin atau mungkin tidak menerima konfigurasi tambahan, begitu juga terdapat yang lain yang ditandakan sebagai percubaan, dalam apa jua keadaan. Adalah penting untuk berunding dokumentasi rasmi untuk memanfaatkan sepenuhnya semua ciri yang Lombok tawarkan kepada kami dan kelebihan berkenaan penjanaan kod berulang.

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