Java注解簡介和使用詳細(xì)講解
注解
注解基本介紹
注解概述:
Java 注解(Annotation)又稱 Java 標(biāo)注,是 JDK5.0 引入的一種注釋機(jī)制。
Java 語言中的類、構(gòu)造器、方法、成員變量、參數(shù)等都可以被注解進(jìn)行標(biāo)注。
注解的作用:
對Java中類、方法、成員變量做標(biāo)記,然后進(jìn)行特殊處理,至于到底做何種處理由業(yè)務(wù)需求來決定。
例如:JUnit框架中,標(biāo)記了注解@Test的方法就可以被當(dāng)成測試方法執(zhí)行,而沒有標(biāo)記的就不能當(dāng)成測試方法執(zhí)行。
自定義注解
自定義注解:
自定義注解就是自己做一個(gè)注解來使用
自定義注解的格式如下:
public @interface 注解名稱 { public 屬性類型 屬性名() default 默認(rèn)值 ; }
注意:
自定義注解的默認(rèn)值可以省略不寫;
自定義默認(rèn)是公開的, 可以省略public修飾符
演示代碼:
自定義注解MyBook
public @interface MyBook { String name(); String[] authors(); // 給默認(rèn)值 double price() default 88.8; }
使用自定義注解可以標(biāo)注類, 變量, 方法等等
@MyBook(name = "Java數(shù)據(jù)結(jié)構(gòu)", authors = {"作者1", "作者2"}) public class AnnotationDemo { @MyBook(name = "Java數(shù)據(jù)結(jié)構(gòu)1", authors = {"作者1", "作者2"}) public static void main(String[] args) { @MyBook(name = "Java數(shù)據(jù)結(jié)構(gòu)2", authors = {"作者1", "作者2"}) int num = 0; } }
特殊類型:
value屬性,如果只有一個(gè)value屬性的情況下,使用value屬性的時(shí)候可以省略value名稱不寫!!
public @interface Book { // 只有一個(gè)value屬性 String value(); // 特殊屬性 }
//@Book(value = "/delete") @Book("cba") // 可以省略不寫 public class AnnotationDemo { }
但是如果有多個(gè)屬性, 且多個(gè)屬性沒有默認(rèn)值,那么value名稱是不能省略的;
如果多個(gè)屬性都有默認(rèn)值, 那么value名稱又可以省略。
// 多個(gè)值, 且其他值都有默認(rèn)值 public @interface Book { String value(); // 特殊屬性 String name() default "一本書"; double price() default 99.9; }
//@Book(value = "/delete") @Book("cba") // 可以省略不寫 public class AnnotationDemo { }
元注解
元注解定義:
元注解就是注解的注解
元注解有兩個(gè):
@Target: 約束自定義注解只能在哪些地方使用,
@Retention:申明注解的生命周期
Target中可使用的值定義在ElementType枚舉類中,常用值如下:
TYPE,表示該注解只能注解類,接口
FIELD, 表示該注解只能注解成員變量
METHOD, 表示該注解只能注解成員方法
PARAMETER, 表示該注解只能注解方法參數(shù)
CONSTRUCTOR, 表示該注解只能注解構(gòu)造器
LOCAL_VARIABLE, 表示該注解只能注解局部變量
@Target({ElementType.FIELD, ElementType.METHOD}) // 表示自定義注解只能對成員變量和方法進(jìn)行注解 public @interface MyTest { }
Retention中可使用的值定義在RetentionPolicy枚舉類中,常用值如下(一般不用, 希望注解永遠(yuǎn)存在):
SOURCE: 注解只作用在源碼階段,生成的字節(jié)碼文件中不存在
CLASS: 注解作用在源碼階段,字節(jié)碼文件階段,運(yùn)行階段不存在,默認(rèn)值.
RUNTIME:注解作用在源碼階段,字節(jié)碼文件階段,運(yùn)行階段(開發(fā)常用)
@Retention(RetentionPolicy.RUNTIME) // 表示注解一直存在 public @interface MyTest { }
注解解析
注解的解析:
注解的操作中經(jīng)常需要進(jìn)行解析,注解的解析就是判斷是否存在注解,存在注解就解析出內(nèi)容。
與注解解析相關(guān)的接口:
Annotation: 注解的頂級接口,注解都是Annotation類型的對象
AnnotatedElement: 注解的元素接口, 該接口定義了與注解解析相關(guān)的解析方法
注解的方法如下:
所有反射的類成分Class, Method , Field , Constructor,都實(shí)現(xiàn)了AnnotatedElement接口他們都擁有解析注解的能力
方法 | 說明 |
---|---|
Annotation[] getDeclaredAnnotations() | 獲得當(dāng)前對象上使用的所有注解,返回注解數(shù)組。 |
getDeclaredAnnotation(Class<T> annotationClass) | 根據(jù)注解類型獲得對應(yīng)注解對象 |
isAnnotationPresent(Class<Annotation> annotationClass) | 判斷當(dāng)前對象是否使用了指定的注解,如果使用了則返回true,否則false |
解析注解的技巧:
注解在哪個(gè)成分上,我們就先拿哪個(gè)成分對象。
比如注解作用成員方法,則要獲得該成員方法對應(yīng)的Method對象,再來拿上面的注解
比如注解作用在類上,則要該類的Class對象,再來拿上面的注解
比如注解作用在成員變量上,則要獲得該成員變量對應(yīng)的Field對象,再來拿上面的注解
注解解析案例練習(xí):
步驟如下:
定義注解Book,要求如下:
- 包含屬性:String value() 書名
- 包含屬性:double price() 價(jià)格,默認(rèn)值為 100
- 包含屬性:String[] authors() 多位作者
- 限制注解使用的位置:類和成員方法上
- 指定注解的有效范圍:RUNTIME
定義BookStore類,在類和成員方法上使用Book注解
定義AnnotationDemo測試類獲取Book注解上的數(shù)據(jù)
演示代碼:
實(shí)現(xiàn)自定義注解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注解上的數(shù)據(jù)
public class AnnotationDemo { public static void main(String[] args) { // 獲取Class類對象 Class c = BookStore.class; // 判斷該類上是否存在Book.class這個(gè)注解對象 if (c.isAnnotationPresent(Book.class)) { // 存在獲取BookStore類的Book.class這個(gè)注解對象 Book book = (Book) c.getAnnotation(Book.class); // 查看注解內(nèi)容 System.out.println(book.value()); // 大話西游 System.out.println(book.price()); // 100.0 System.out.println(Arrays.toString(book.authors())); // [作者a, 作者b] } } }
到此這篇關(guān)于Java注解的介紹和使用詳細(xì)講解的文章就介紹到這了,更多相關(guān)Java注解使用內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Java中的==和equals()區(qū)別小結(jié)
在Java編程中,理解==操作符和equals()方法的區(qū)別是至關(guān)重要的,本文主要介紹了Java中的==和equals()區(qū)別,具有一定的參考價(jià)值,感興趣的可以了解一下2023-08-08簡單了解redis常見客戶端及Sharding機(jī)制原理
這篇文章主要介紹了簡單了解redis常見客戶端及Sharding機(jī)制原理,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-09-09nacos使用占位符${}進(jìn)行參數(shù)配置的方法
這篇文章主要介紹了nacos如何使用占位符${}進(jìn)行參數(shù)配置,本文結(jié)合示例代碼給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-12-12java實(shí)現(xiàn)圖片角度旋轉(zhuǎn)并獲得圖片信息
這篇文章主要為大家詳細(xì)介紹了java實(shí)現(xiàn)圖片角度旋轉(zhuǎn)并獲得圖片信息,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2019-02-02SpringCloud?Alibaba環(huán)境集成之nacos詳解
Spring?Cloud?Alibaba提供了越來越完善的各類微服務(wù)治理組件,比如分布式服務(wù)配置與注冊中心nacos,服務(wù)限流、熔斷組件sentinel等,本篇先來介紹SpringCloud?Alibaba環(huán)境集成之nacos詳解,需要的朋友可以參考下2023-03-03java實(shí)現(xiàn)簡單的圖書管理系統(tǒng)
這篇文章主要為大家詳細(xì)介紹了java實(shí)現(xiàn)簡單的圖書管理系統(tǒng),文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2021-07-07gateway、webflux、reactor-netty請求日志輸出方式
這篇文章主要介紹了gateway、webflux、reactor-netty請求日志輸出方式,具有很好的參考價(jià)值,希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-03-03