Memproses anotasi pada masa jalankan

Membuat anotasi adalah proses yang agak mudah, walaupun ia dihadkan oleh beberapa peraturan. Sekarang kita perlu memikirkan tujuan praktikal yang mereka sediakan.

Mari kita ingat kembali cara kita mencipta anotasi kita sendiri.

Kami akan menulis anotasi untuk kelas dan kaedah serta mengandungi maklumat tentang pengarang dan versi kod:

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Info {
   String author() default "Author";
   String version() default "0.0";
}

Berikut ialah kelas kami yang kami anotasikan:

@Info
public class MyClass1 {
   @Info
   public void myClassMethod() {}
}
 
@Info(version = "2.0")
public class MyClass2 {
   @Info(author = "Anonymous")
   public void myClassMethod() {}
}
 
@Info(author = "Anonymous", version = "2.0")
public class MyClass3 {
   @Info(author = "Anonymous", version = "4.0")
   public void myClassMethod() {}
}

Bagaimanakah kita boleh menggunakan data ini pada masa jalan?

Dengan menggunakan refleksi untuk mengekstrak metadata daripada anotasi. Ingat apa itu refleksi. Refleksi ialah mekanisme untuk memeriksa data tentang program pada masa jalan. Refleksi membolehkan anda mendapatkan maklumat tentang medan, kaedah, pembina kelas dan kelas.

Kami akan menggunakan refleksi untuk membaca anotasi dalam kelas dan memaparkan maklumat yang kami inginkan.

Kami akan membaca data dari kelas kami dalam kaedah utama :

import java.lang.annotation.Annotation;
import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Method;
 
public class Main {
   public static void main(String[] args) throws NoSuchMethodException {
       readMyClass(MyClass1.class);
       readMyClass(MyClass2.class);
       readMyClass(MyClass3.class);
   }
 
   static void readMyClass(Class<?> myClassObj) throws NoSuchMethodException {
       System.out.println("\nClass: " + myClassObj.getName());
       readAnnotation(myClassObj);
       Method method = myClassObj.getMethod("myClassMethod");
       readAnnotation(method);
   }
 
   static void readAnnotation(AnnotatedElement element) {
       try {
           System.out.println("Search for annotations in " + element.getClass().getName());
           Annotation[] annotations = element.getAnnotations();
           for (Annotation annotation : annotations) {
               if (annotation instanceof Info) {
                   final Info fileInfo = (Info) annotation;
                   System.out.println("Author: " + fileInfo.author());
                   System.out.println("Version: " + fileInfo.version());
               }
           }
       } catch (Exception e) {
           e.printStackTrace();
       }
   }
}

Kami menghantar contoh kelas kami kepada kaedah readMyClass .

Kemudian kita boleh lulus kelas serta kaedah kepada kaedah readAnnotation . Mari lakukan itu — kita akan lulus objek Kelas dan objek Kaedah. Ia memerlukan objek yang melaksanakan antara muka AnnotatedElement . Ini membolehkan kami mendapatkan senarai anotasi daripada objek dan mendapatkan maklumat tentang setiap daripadanya.

Harap maklum bahawa kami hanya mendapat maklumat selepas menyemak sama ada anotasi tergolong dalam jenis anotasi kami: if (annotation instanceof Info) .

Output program memberi kami maklumat lengkap daripada anotasi:

Oleh itu, dengan bantuan refleksi, kami dapat mengekstrak metadata.

Sekarang mari kita lihat contoh penggunaan anotasi untuk menambah baik kod, termasuk meningkatkan kebolehbacaan, kelajuan dan kualiti secara umum. Lombok akan membantu kami dalam hal ini.

Lombok ialah pemalam pengkompil yang menggunakan anotasi untuk menyembunyikan sejumlah besar kod dan memanjangkan bahasa, dengan itu memudahkan pembangunan dan menambah beberapa fungsi.

Pertimbangkan contoh anotasi dari Lombok:

@ToString
public class Example

@Getter 
@Setter 
private String name = "name";

public Example(@NonNull P p) {
 super("Hello");
 this.name = p.getName();
}

Lombok mempunyai banyak lagi anotasi berguna yang jarang digunakan. Kami telah mempertimbangkan anotasinya yang paling mudah. Anda boleh membaca lebih lanjut mengenai projek itu di laman web rasmi .