詳解Java注解教程及自定義注解
Java注解提供了關(guān)于代碼的一些信息,但并不直接作用于它所注解的代碼內(nèi)容。在這個(gè)教程當(dāng)中,我們將學(xué)習(xí)Java的注解,如何定制注解,注解的使用以及如何通過(guò)反射解析注解。
Java1.5引入了注解,當(dāng)前許多java框架中大量使用注解,如Hibernate、Jersey、Spring。注解作為程序的元數(shù)據(jù)嵌入到程序當(dāng)中。注解可以被一些解析工具或者是編譯工具進(jìn)行解析。我們也可以聲明注解在編譯過(guò)程或執(zhí)行時(shí)產(chǎn)生作用。
在使用注解之前,程序源數(shù)據(jù)只是通過(guò)java注釋和javadoc,但是注解提供的功能要遠(yuǎn)遠(yuǎn)超過(guò)這些。注解不僅包含了元數(shù)據(jù),它還可以作用于程序運(yùn)行過(guò)程中、注解解釋器可以通過(guò)注解決定程序的執(zhí)行順序。例如,在Jersey webservice 我們?yōu)榉椒ㄌ砑覷RI字符串的形式的**PATH**注解,那么在程序運(yùn)行過(guò)程中jerser解釋程序?qū)Q定該方法去調(diào)用所給的URI。
創(chuàng)建Java自定義注解
創(chuàng)建自定義注解和創(chuàng)建一個(gè)接口相似,但是注解的interface關(guān)鍵字需要以@符號(hào)開頭。我們可以為注解聲明方法。我們先來(lái)看看注解的例子,然后我們將討論他的一些特性。
package com.journaldev.annotations; import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Inherited; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; @Documented @Target(ElementType.METHOD) @Inherited @Retention(RetentionPolicy.RUNTIME) public @interface MethodInfo{ String author() default 'Pankaj'; String date(); int revision() default 1; String comments(); }
注解方法不能帶有參數(shù);
注解方法返回值類型限定為:基本類型、String、Enums、Annotation或者是這些類型的數(shù)組;
注解方法可以有默認(rèn)值;
注解本身能夠包含元注解,元注解被用來(lái)注解其它注解。
這里有四種類型的元注解:
1. @Documented —— 指明擁有這個(gè)注解的元素可以被javadoc此類的工具文檔化。這種類型應(yīng)該用于注解那些影響客戶使用帶注釋的元素聲明的類型。如果一種聲明使用Documented進(jìn)行注解,這種類型的注解被作為被標(biāo)注的程序成員的公共API。
2. @Target——指明該類型的注解可以注解的程序元素的范圍。該元注解的取值可以為TYPE,METHOD,CONSTRUCTOR,FIELD等。如果Target元注解沒有出現(xiàn),那么定義的注解可以應(yīng)用于程序的任何元素。
3. @Inherited——指明該注解類型被自動(dòng)繼承。如果用戶在當(dāng)前類中查詢這個(gè)元注解類型并且當(dāng)前類的聲明中不包含這個(gè)元注解類型,那么也將自動(dòng)查詢當(dāng)前類的父類是否存在Inherited元注解,這個(gè)動(dòng)作將被重復(fù)執(zhí)行知道這個(gè)標(biāo)注類型被找到,或者是查詢到頂層的父類。
4.@Retention——指明了該Annotation被保留的時(shí)間長(zhǎng)短。RetentionPolicy取值為SOURCE,CLASS,RUNTIME。
Java內(nèi)建注解
Java提供了三種內(nèi)建注解。
1. @Override——當(dāng)我們想要復(fù)寫父類中的方法時(shí),我們需要使用該注解去告知編譯器我們想要復(fù)寫這個(gè)方法。這樣一來(lái)當(dāng)父類中的方法移除或者發(fā)生更改時(shí)編譯器將提示錯(cuò)誤信息。
2. @Deprecated——當(dāng)我們希望編譯器知道某一方法不建議使用時(shí),我們應(yīng)該使用這個(gè)注解。Java在javadoc 中推薦使用該注解,我們應(yīng)該提供為什么該方法不推薦使用以及替代的方法。
3. @SuppressWarnings——這個(gè)僅僅是告訴編譯器忽略特定的警告信息,例如在泛型中使用原生數(shù)據(jù)類型。它的保留策略是SOURCE(譯者注:在源文件中有效)并且被編譯器丟棄。
我們來(lái)看一個(gè)java內(nèi)建注解的例子參照上邊提到的自定義注解。
package com.journaldev.annotations; import java.io.FileNotFoundException; import java.util.ArrayList; import java.util.List; public class AnnotationExample { public static void main(String[] args) { } @Override @MethodInfo(author = 'Pankaj', comments = 'Main method', date = 'Nov 17 2012', revision = 1) public String toString() { return 'Overriden toString method'; } @Deprecated @MethodInfo(comments = 'deprecated method', date = 'Nov 17 2012') public static void oldMethod() { System.out.println('old method, don't use it.'); } @SuppressWarnings({ 'unchecked', 'deprecation' }) @MethodInfo(author = 'Pankaj', comments = 'Main method', date = 'Nov 17 2012', revision = 10) public static void genericsTest() throws FileNotFoundException { List l = new ArrayList(); l.add('abc'); oldMethod(); } }
相信這個(gè)例子可以不言自明并能展示在不同場(chǎng)景下的應(yīng)用。
Java注解解析
我們將使用反射技術(shù)來(lái)解析java類的注解。那么注解的RetentionPolicy應(yīng)該設(shè)置為RUNTIME否則java類的注解信息在執(zhí)行過(guò)程中將不可用那么我們也不能從中得到任何和注解有關(guān)的數(shù)據(jù)。
package com.journaldev.annotations; import java.lang.annotation.Annotation; import java.lang.reflect.Method; public class AnnotationParsing { public static void main(String[] args) { try { for (Method method : AnnotationParsing.class .getClassLoader() .loadClass(('com.journaldev.annotations.AnnotationExample')) .getMethods()) { // checks if MethodInfo annotation is present for the method if (method.isAnnotationPresent(com.journaldev.annotations.MethodInfo.class)) { try { // iterates all the annotations available in the method for (Annotation anno : method.getDeclaredAnnotations()) { System.out.println('Annotation in Method ''+ method + '' : ' + anno); } MethodInfo methodAnno = method.getAnnotation(MethodInfo.class); if (methodAnno.revision() == 1) { System.out.println('Method with revision no 1 = '+ method); } } catch (Throwable ex) { ex.printStackTrace(); } } } } catch (SecurityException | ClassNotFoundException e) { e.printStackTrace(); } } }
運(yùn)行上面程序?qū)⑤敵觯?br />
Annotation in Method 'public java.lang.String com.journaldev.annotations.AnnotationExample.toString()' : @com.journaldev.annotations.MethodInfo(author=Pankaj, revision=1, comments=Main method, date=Nov 17 2012) Method with revision no 1 = public java.lang.String com.journaldev.annotations.AnnotationExample.toString() Annotation in Method 'public static void com.journaldev.annotations.AnnotationExample.oldMethod()' : @java.lang.Deprecated() Annotation in Method 'public static void com.journaldev.annotations.AnnotationExample.oldMethod()' : @com.journaldev.annotations.MethodInfo(author=Pankaj, revision=1, comments=deprecated method, date=Nov 17 2012) Method with revision no 1 = public static void com.journaldev.annotations.AnnotationExample.oldMethod() Annotation in Method 'public static void com.journaldev.annotations.AnnotationExample.genericsTest() throws java.io.FileNotFoundException' : @com.journaldev.annotations.MethodInfo(author=Pankaj, revision=10, comments=Main method, date=Nov 17 2012)
這就是該教程的全部?jī)?nèi)容,希望你可以從中學(xué)到些東西。
- Java注解之Retention、Documented、Inherited介紹
- java教程之java注解annotation使用方法
- 5分鐘搞懂java注解@Annotation的具體使用
- Java注解Annotation與自定義注解詳解
- Java注解機(jī)制之Spring自動(dòng)裝配實(shí)現(xiàn)原理詳解
- Java注解@Transactional事務(wù)類內(nèi)調(diào)用不生效問題及解決辦法
- 基于Java注解(Annotation)的自定義注解入門介紹
- 創(chuàng)建自定義的Java注解類的方法
- 深入理解Java注解類型(@Annotation)
- 輕松掌握J(rèn)ava注解,讓編程更智能、更優(yōu)雅
相關(guān)文章
java網(wǎng)絡(luò)編程之識(shí)別示例 獲取主機(jī)網(wǎng)絡(luò)接口列表
一個(gè)客戶端想要發(fā)起一次通信,先決條件就是需要知道運(yùn)行著服務(wù)器端程序的主機(jī)的IP地址是多少。然后我們才能夠通過(guò)這個(gè)地址向服務(wù)器發(fā)送信息。2014-01-01Java中構(gòu)造方法set/get和toString的使用詳解
這篇文章主要介紹了Java中構(gòu)造方法set/get和toString的使用詳解,構(gòu)造函數(shù)的最大作用就是創(chuàng)建對(duì)象時(shí)完成初始化,當(dāng)我們?cè)趎ew一個(gè)對(duì)象并傳入?yún)?shù)的時(shí)候,會(huì)自動(dòng)調(diào)用構(gòu)造函數(shù)并完成參數(shù)的初始化,需要的朋友可以參考下2019-07-07Mybatis-plus出現(xiàn)數(shù)據(jù)庫(kù)id很大或者為負(fù)數(shù)的解決
本文主要介紹了Mybatis-plus出現(xiàn)數(shù)據(jù)庫(kù)id很大或者為負(fù)數(shù)的解決,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-02-02springboot配置flyway(入門級(jí)別教程)
本文介紹了springboot配置flyway,主要介紹基于SpringBoot集成flyway來(lái)管理數(shù)據(jù)庫(kù)的變更,具有一定的參考價(jià)值,感興趣的可以了解一下2023-09-09大數(shù)據(jù)Kafka:消息隊(duì)列和Kafka基本介紹
本文對(duì)消息隊(duì)列的應(yīng)用場(chǎng)景,優(yōu)缺點(diǎn),消息隊(duì)列的兩種方式,常見的消息隊(duì)列產(chǎn)品以及Kafka的特點(diǎn)和應(yīng)用場(chǎng)景做了詳細(xì)的講解,需要的朋友可以參考下,希望可以對(duì)大家有所幫助2021-08-08使用ShardingSphere-Proxy實(shí)現(xiàn)分表分庫(kù)
這篇文章介紹了使用ShardingSphere-Proxy實(shí)現(xiàn)分表分庫(kù)的方法,對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2022-02-02鴻蒙HarmonyOS App開發(fā)造輪子之自定義圓形圖片組件的實(shí)例代碼
這篇文章主要介紹了鴻蒙HarmonyOS App開發(fā)造輪子之自定義圓形圖片組件,本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2021-01-01