Java四種元注解介紹
Java四種元注解相關(guān)介紹
概述
注解從Java1.5
引入以來,不斷地簡化我們編寫代碼的流程,逐漸的也成為了我們必學的一項技術(shù)。我們學習了各種注解,學習了他們的用法,學習了他們的限制,是否想過他們的組成呢,下面我將我對元注解的理解分享給大家。
元注解是用來修飾注解的注解,在java.lang.annotation
包下,當我們需要自己定義一個注解去做某些事情的時候,我們要對該注解進行一些限制,確保我們注解的作用域,有的注解有屬性,有的注解沒有屬性,我們點進去就能看到。這樣的注解一共有四個,如下圖
定義一個注解用@interface
來修飾文件類型,這四個元注解我們一個一個分析
@Documented
該注解是用來聲明,我們的注解是否能被Javadoc
等API
文檔生成工具展示出來,如果某個注解上面聲明了@Documented
,就說明這個注解可以被那些生成文檔的工具展示出來。
我們點進去可以看到,該注解用到了三個注解,其中有他自己,還有兩個元注解,并且這個注解沒有屬性,所以我們的使用方法很簡單,就是寫或者不寫該注解。
@Retention
我們點進這個注解可以看到,首先他寫了@Documented
,說明他是可以被文檔生成工具顯示到文檔中,并且他有一條屬性,他同樣也對自己使用了@Retention
,并且給了一個值->RetentionPolicy.RUNTIME
,可以看到跟我們上邊的@Documented
注解是一樣的,然后我們點到RetentionPolicy
這個類中去看看這個位置都可以給什么值
首先我們注意到了,這個類是個枚舉類,也就是說我們還可以這樣寫
那么這三個常量都代表什么意思呢
SOURCE:我們翻譯一下注釋:編譯器將丟棄注解就是說如果用了他,那么你的注解編譯成.class
文件之后就會被丟掉,所以如果我們的注解是用來輔助編譯過程的,那么我們可以用它。
例如
@SuppressWarnings
,我們通常用該注解來告訴編譯器忽略某些警告信息,編譯之后我們就不需要了,所以這個場景用SOURCE肯定是沒毛病的
CLASS:我們翻譯一下注釋:編譯器將注解記錄在類文件中,VM
在運行時不需要保留這些注釋。這是默認設(shè)置行為。也就是說,編譯器編譯成.class
文件后,這個注解仍然存在,但是在我們的jvm
去加載.class
文件的時候會被丟掉,這個使用的不多所以我們知道這個是什么意思就行。如果不寫,默認就是選擇CLASS
。
RUNTIME:使用率最高的一個常量,隨便去某個類庫里去查一下注解,點進去基本都是RUNTIME。老樣子,我們先翻譯注釋:注釋將由編譯器記錄在類文件中,并在運行時由VM
定義,因此可以反射性地讀取。也就是說這個常量所定義的范圍是最大的了,都可以被反射了,也就是不光編譯器編譯了、JVM
加載了還能反射性的讀取到,會一直存在。我們自己在定義注解的時候,除非有特殊需要,一般業(yè)務也是用這個常量,比較方便一些。@Target
由圖可以看到,這個元注解用到了三個元注解,有我們上邊說的兩個和他自己。此處我們不過多贅述。再看他的屬性,可以看到用到了中括號,說明注解的參數(shù)這里是可以放一個枚舉數(shù)組的,我們點開枚舉后可以看到聲明了很多常量。
老樣子先翻譯一下注釋,基本都能看出來是啥意思了,TYPE_PARAMETER
和TYPE_USE
是JDK1.8
加進來的
TYPE:類、接口(包括注解類型)或枚舉聲明。
- TYPE:類、接口(包括注解類型)或枚舉聲明。
- FIELD:字段聲明(包括枚舉常量)
- METHOD:方法聲明
- PARAMETER:形式參數(shù)聲明
- CONSTRUCTOR:構(gòu)造函數(shù)聲明
- LOCAL_VARIABLE:局部變量聲明
- ANNOTATION_TYPE:注釋類型聲明
- PACKAGE:包聲明
- TYPE_PARAMETER:類型參數(shù)聲明。該常量可以用于各種參數(shù)類型(包括類)的前面
- TYPE_USE:類型的使用。該常量可以用來標注任何類型的名稱,包括
TYPE_PARAMETER
的
所以我們可以根據(jù)我們的需要選擇此處的常量,當然可以多選
例如這樣,按照圖片的寫法,這個@annotationT
就既可以聲明在字段上,又可以聲明在方法上。
@Inherited
如圖可見,這個注解是一個可以被文檔生成工具顯示,不會被編譯器、JVM
丟棄,且用到了ANNOTATION_TYPE
,也就是說這個注解只能定義到注解上,所以他一定是用來規(guī)定注解的某些特性的。
老樣子我們翻譯一下上邊的注釋,由于篇幅較長此處不展示具體內(nèi)容,大佬們可以點進去看看,大概是:被這個注解注釋的注解可以自動繼承的,查詢類上的注解類型,如果類聲明沒有針對該類型的注解將自動查詢超類(直到Object)
PS:請注意,如果注解類型用于注解類以外的任何內(nèi)容,則此元注解類型無效。還要注意,此元注解只會導致注解從超類繼承;已實現(xiàn)接口上的注解沒有影響。
簡單說,如果想讓你定義的注解被繼承,那就把@Inherited
掛在你的注解上
總結(jié)
以上就是作用于我們所有注解上的元注解的基本信息,我們明白每個元注解代表什么意思會方便我們?nèi)ダ斫庖恍?code>JDK自帶的、或者第三方類庫中定義或使用的注解,也會方便我們自己去定義一些注解,比如可以用注解的方式實現(xiàn)在操作我們自定義的注解注釋的方法執(zhí)行之前或者之后要做些什么,當我們真正會使用這些元注解去自定義屬于自己的注解的時候,一定會理解為什么注解使用的如此普遍。
到此這篇關(guān)于Java元注解介紹的文章就介紹到這了,更多相關(guān)Java元注解內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Java中使用Jedis操作Redis的實現(xiàn)代碼
本篇文章主要介紹了Java中使用Jedis操作Redis的實現(xiàn)代碼。詳細的介紹了Redis的安裝和在java中的操作,具有一定的參考價值,有興趣的可以了解一下2017-05-05聊聊@value注解和@ConfigurationProperties注解的使用
這篇文章主要介紹了@value注解和@ConfigurationProperties注解的使用,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-09-09MyBatisPuls多數(shù)據(jù)源操作數(shù)據(jù)源偶爾報錯問題
這篇文章主要介紹了MyBatisPuls多數(shù)據(jù)源操作數(shù)據(jù)源偶爾報錯問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-06-06Spring-cloud-eureka使用feign調(diào)用服務接口
這篇文章主要為大家詳細介紹了Spring-cloud-eureka使用feign調(diào)用服務接口,具有一定的參考價值,感興趣的小伙伴們可以參考一下2019-04-04通過實例深入學習Java的Struts框架中的OGNL表達式使用
這篇文章主要通過實例介紹了Java的Strus框架中的OGNL表達式使用,Struts框架是Java的SSH三大web開發(fā)框架之一,需要的朋友可以參考下2015-11-11