Java注解怎么自定義使用

這篇文章主要介紹了Java注解怎么自定義使用的相關知識，內容詳細易懂，操作簡單快捷，具有一定借鑒價值，相信大家閱讀完這篇Java注解怎么自定義使用文章都會有所收獲，下面我們一起來看看吧。

注解

注解基本介紹

注解概述:

Java 注解（Annotation）又稱 Java 標注，是 JDK5.0 引入的一種注釋機制。

Java 語言中的類、構造器、方法、成員變量、參數等都可以被注解進行標注。

注解的作用:

對Java中類、方法、成員變量做標記，然后進行特殊處理，至于到底做何種處理由業務需求來決定。

例如：JUnit框架中，標記了注解@Test的方法就可以被當成測試方法執行，而沒有標記的就不能當成測試方法執行。

自定義注解

自定義注解:

自定義注解就是自己做一個注解來使用

自定義注解的格式如下:

public @interface 注解名稱 {
  	public 屬性類型 屬性名() default 默認值 ;
}

注意:

自定義注解的默認值可以省略不寫;

自定義默認是公開的, 可以省略public修飾符

演示代碼:

自定義注解MyBook

public @interface MyBook {
    String name();
    String[] authors();
    // 給默認值
    double price() default 88.8;
}

使用自定義注解可以標注類, 變量, 方法等等

@MyBook(name = "Java數據結構", authors = {"作者1", "作者2"})
public class AnnotationDemo {
    @MyBook(name = "Java數據結構1", authors = {"作者1", "作者2"})
    public static void main(String[] args) {
        @MyBook(name = "Java數據結構2", authors = {"作者1", "作者2"})
        int num = 0;
    }
}

特殊類型:

value屬性，如果只有一個value屬性的情況下，使用value屬性的時候可以省略value名稱不寫!!

public @interface Book {
    // 只有一個value屬性
    String value(); // 特殊屬性
}

//@Book(value = "/delete")

@Book("cba") // 可以省略不寫
public class AnnotationDemo {
}

但是如果有多個屬性, 且多個屬性沒有默認值，那么value名稱是不能省略的;

如果多個屬性都有默認值, 那么value名稱又可以省略。

// 多個值,	且其他值都有默認值
public @interface Book {
    String value(); // 特殊屬性
    String name() default "一本書";
    double price() default 99.9;
}

//@Book(value = "/delete")

@Book("cba") // 可以省略不寫
public class AnnotationDemo {
}

元注解

元注解定義:

元注解就是注解的注解

元注解有兩個:

@Target: 約束自定義注解只能在哪些地方使用，

@Retention：申明注解的生命周期

Target中可使用的值定義在ElementType枚舉類中，常用值如下:

TYPE，表示該注解只能注解類，接口

FIELD, 表示該注解只能注解成員變量

METHOD, 表示該注解只能注解成員方法

PARAMETER, 表示該注解只能注解方法參數

CONSTRUCTOR, 表示該注解只能注解構造器

LOCAL_VARIABLE, 表示該注解只能注解局部變量

@Target({ElementType.FIELD, ElementType.METHOD}) // 表示自定義注解只能對成員變量和方法進行注解
public @interface MyTest {
}

Retention中可使用的值定義在RetentionPolicy枚舉類中，常用值如下(一般不用, 希望注解永遠存在):

SOURCE： 注解只作用在源碼階段，生成的字節碼文件中不存在

CLASS： 注解作用在源碼階段，字節碼文件階段，運行階段不存在，默認值.

RUNTIME：注解作用在源碼階段，字節碼文件階段，運行階段（開發常用）

@Retention(RetentionPolicy.RUNTIME) // 表示注解一直存在
public @interface MyTest {
}

注解解析

注解的解析:

注解的操作中經常需要進行解析，注解的解析就是判斷是否存在注解，存在注解就解析出內容。

與注解解析相關的接口:

Annotation: 注解的頂級接口，注解都是Annotation類型的對象

AnnotatedElement: 注解的元素接口, 該接口定義了與注解解析相關的解析方法

注解的方法如下:

所有反射的類成分Class, Method , Field , Constructor，都實現了AnnotatedElement接口他們都擁有解析注解的能力

解析注解的技巧:

注解在哪個成分上，我們就先拿哪個成分對象。

比如注解作用成員方法，則要獲得該成員方法對應的Method對象，再來拿上面的注解

比如注解作用在類上，則要該類的Class對象，再來拿上面的注解

比如注解作用在成員變量上，則要獲得該成員變量對應的Field對象，再來拿上面的注解

注解解析案例練習:

步驟如下:

定義注解Book，要求如下：

• 包含屬性：String value() 書名

• 包含屬性：double price() 價格，默認值為 100

• 包含屬性：String[] authors() 多位作者

• 限制注解使用的位置：類和成員方法上

• 指定注解的有效范圍：RUNTIME

定義BookStore類，在類和成員方法上使用Book注解

定義AnnotationDemo測試類獲取Book注解上的數據

演示代碼:

實現自定義注解Book

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Book {
    String value();
    double price() default 100;
    String[] authors();
}

定義BookStore類, 在類和成員方法上使用Book注解

@Book(value = "大話西游", authors = {"作者a", "作者b"})
public class BookStore {
    @Book(value = "盜夢空間", price = 10.99,authors = {"作者1", "作者2"})
    public void bubBook() {
        System.out.println("買書成功");
    }
}

定義AnnotationDemo測試類獲取Book注解上的數據

public class AnnotationDemo {
    public static void main(String[] args) {
        // 獲取Class類對象
        Class c = BookStore.class;

        // 判斷該類上是否存在Book.class這個注解對象
        if (c.isAnnotationPresent(Book.class)) {
            // 存在獲取BookStore類的Book.class這個注解對象
            Book book = (Book) c.getAnnotation(Book.class);

            // 查看注解內容
            System.out.println(book.value()); // 大話西游
            System.out.println(book.price()); // 100.0
            System.out.println(Arrays.toString(book.authors())); // [作者a, 作者b]
        }
    }
}

關于“Java注解怎么自定義使用”這篇文章的內容就介紹到這里，感謝各位的閱讀！相信大家對“Java注解怎么自定義使用”知識都有一定的了解，大家如果還想學習更多知識，歡迎關注億速云行業資訊頻道。