深入理解Java註解類型
Java註解是在JDK5時引入的新特性,鑒於目前大部分框架(如spring)都使用了註解簡化代碼並提高編碼的效率,因此掌握並深入理解註解對於一個Java工程師是來說是很有必要的事。
理解Java註解
實際上Java註解與普通修飾符(public、static、void等)的使用方式並沒有多大區別,下面的例子是常見的註解:
通過在方法上使用@Test註解後,在運行該方法時,測試框架會自動識別該方法並單獨調用,@Test實際上是一種標記註解,起標記作用,運行時告訴測試框架該方法為測試方法。而對於@Deprecated和@SuppressWarnings(「uncheck」),則是Java本身內置的註解,在代碼中,可以經常看見它們,但這並不是一件好事,畢竟當方法或是類上面有@Deprecated註解時,說明該方法或是類都已經過期不建議再用,@SuppressWarnings 則表示忽略指定警告,比如@SuppressWarnings(「uncheck」),這就是註解的最簡單的使用方式,那麼下面我們就來看看註解定義的基本語法
基本語法
聲明註解與元註解
我們先來看看前面的Test註解是如何聲明的:
我們使用了@interface
聲明了Test註解,並使用@Target
註解傳入ElementType.METHOD
參數來標明@Test只能用於方法上,@Retention(RetentionPolicy.RUNTIME)
則用來表示該註解生存期是運行時,從代碼上看註解的定義很像介面的定義,確實如此,畢竟在編譯後也會生成Test.class文件。對於@Target
和@Retention
是由Java提供的元註解,所謂元註解就是標記其他註解的註解,下面分別介紹
@Target 用來約束註解可以應用的地方(如方法、類或欄位),其中ElementType是枚舉類型,其定義如下,也代表可能的取值範圍
請注意,當註解未指定Target值時,則此註解可以用於任何元素之上,多個值使用{}包含並用逗號隔開,如下:
@Retention用來約束註解的生命周期,分別有三個值,源碼級別(source),類文件級別(class)或者運行時級別(runtime),其含有如下:
SOURCE:註解將被編譯器丟棄(該類型的註解信息只會保留在源碼里,源碼經過編譯後,註解信息會被丟棄,不會保留在編譯好的class文件里)
CLASS:註解在class文件中可用,但會被VM丟棄(該類型的註解信息會保留在源碼里和class文件里,在執行的時候,不會載入到虛擬機中),請注意,當註解未定義Retention值時,默認值是CLASS,如Java內置註解,@Override、@Deprecated、@SuppressWarnning等
RUNTIME:註解信息將在運行期(JVM)也保留,因此可以通過反射機制讀取註解的信息(源碼、class文件和執行的時候都有註解的信息),如SpringMvc中的@Controller、@Autowired、@RequestMapping等。
註解元素及其數據類型
通過上述對@Test註解的定義,我們了解了註解定義的過程,由於@Test內部沒有定義其他元素,所以@Test也稱為標記註解(marker annotation),但在自定義註解中,一般都會包含一些元素以表示某些值,方便處理器使用,這點在下面的例子將會看到:
上述定義一個名為DBTable的註解,該用於主要用於資料庫表與Bean類的映射(稍後會有完整案例分析),與前面Test註解不同的是,我們聲明一個String類型的name元素,其默認值為空字元,但是必須注意到對應任何元素的聲明應採用方法的聲明方式,同時可選擇使用default提供默認值,@DBTable使用方式如下:
關於註解支持的元素數據類型除了上述的String,還支持如下數據類型
所有基本類型(int,float,boolean,byte,double,char,long,short)
String
Class
enum
Annotation
上述類型的數組
倘若使用了其他數據類型,編譯器將會丟出一個編譯錯誤,注意,聲明註解元素時可以使用基本類型但不允許使用任何包裝類型,同時還應該注意到註解也可以作為元素的類型,也就是嵌套註解,下面的代碼演示了上述類型的使用過程:
編譯器對默認值的限制
編譯器對元素的默認值有些過分挑剔。首先,元素不能有不確定的值。也就是說,元素必須要麼具有默認值,要麼在使用註解時提供元素的值。其次,對於非基本類型的元素,無論是在源代碼中聲明,還是在註解介面中定義默認值,都不能以null作為值,這就是限制,沒有什麼利用可言,但造成一個元素的存在或缺失狀態,因為每個註解的聲明中,所有的元素都存在,並且都具有相應的值,為了繞開這個限制,只能定義一些特殊的值,例如空字元串或負數,表示某個元素不存在。
註解不支持繼承
註解是不支持繼承的,因此不能使用關鍵字extends來繼承某個@interface,但註解在編譯後,編譯器會自動繼承java.lang.annotation.Annotation介面,這裡我們反編譯前面定義的DBTable註解
雖然反編譯後發現DBTable註解繼承了Annotation介面,請記住,即使Java的介面可以實現多繼承,但定義註解時依然無法使用extends關鍵字繼承@interface。
快捷方式
所謂的快捷方式就是註解中定義了名為value的元素,並且在使用該註解時,如果該元素是唯一需要賦值的一個元素,那麼此時無需使用key=value的語法,而只需在括弧內給出value元素所需的值即可。這可以應用於任何合法類型的元素,記住,這限制了元素名必須為value,簡單案例如下
Java內置註解與其它元註解
接著看看Java提供的內置註解,主要有3個,如下:
@Override:用於標明此方法覆蓋了父類的方法,源碼如下
@Deprecated:用於標明已經過時的方法或類,源碼如下,關於@Documented稍後分析:
@SuppressWarnnings:用於有選擇的關閉編譯器對類、方法、成員變數、變數初始化的警告,其實現源碼如下:
其內部有一個String數組,主要接收值如下:
這個三個註解比較簡單,看個簡單案例即可:
前面我們分析了兩種元註解,@Target和@Retention,除了這兩種元註解,Java還提供了另外兩種元註解,@Documented和@Inherited,下面分別介紹:
@Documented 被修飾的註解會生成到javadoc中
使用javadoc命令生成文檔:
如下:
可以發現使用@Documented元註解定義的註解(@DocumentA)將會生成到javadoc中,而@DocumentB則沒有在doc文檔中出現,這就是元註解@Documented的作用。
@Inherited 可以讓註解被繼承,但這並不是真的繼承,只是通過使用@Inherited,可以讓子類Class對象使用getAnnotations()獲取父類被@Inherited修飾的註解,如下:
註解與反射機制
前面經過反編譯後,我們知道Java所有註解都繼承了Annotation介面,也就是說 Java使用Annotation介面代表註解元素,該介面是所有Annotation類型的父介面。同時為了運行時能準確獲取到註解的相關信息,Java在java.lang.reflect 反射包下新增了AnnotatedElement介面,它主要用於表示目前正在 VM 中運行的程序中已使用註解的元素,通過該介面提供的方法可以利用反射技術地讀取註解的信息,如反射包的Constructor類、Field類、Method類、Package類和Class類都實現了AnnotatedElement介面,它簡要含義如下(更多詳細介紹可以看 深入理解Java類型信息(Class對象)與反射機制):
Class:類的Class對象定義
Constructor:代表類的構造器定義
Field:代表類的成員變數定義
Method:代表類的方法定義
Package:代表類的包定義
下面是AnnotatedElement中相關的API方法,以上5個類都實現以下的方法
今天先寫這麼多,未完待續...
學習Java的同學注意了!!!
學習過程中遇到什麼問題或者想獲取學習資源的話,歡迎加入Java學習交流群495273252,我們一起學Java!


※Java虛擬機內部結構——JVM8
※Java泛型的應用
※Java學習之static關鍵字
※Java學習之數組
TAG:Java團長 |
※深入理解Flask
※深入理解 ES Modules
※DeepMind論文解讀:讓機器更深入地理解文本
※深入理解Flutter引擎線程模式
※更深入理解 Python 中的迭代
※入門 | 通過 Q-learning 深入理解強化學習
※通過 Q-learning 深入理解強化學習
※深入淺出 + 徹底理解 Python 編碼
※深入理解消息中間件技術之RabbitMQ服務
※深入理解Windows頁幀號(一)
※深入理解 Web Server 原理與實踐:Nginx
※ES6之類class的原理解析
※深入理解JVM—JVM內存模型
※Android圖片載入框架最全解析二,從源碼的角度理解Glide的執行流程
※Python中 Flask的魔法方法深入理解
※MapReduce Shuffle深入理解
※Word2v的ec 原理解析!
※UNC&Adobe提出模塊化注意力模型MAttNet,解決指示表達的理解問題
※代碼詳解:通過模擬API來理解TensorFlow
※深入理解Git的實現原理