java 注解 id_java注解
java注解:
Java 注解用于為 Java 代碼提供元數(shù)據(jù)。作為元數(shù)據(jù),注解不直接影響你的代碼執(zhí)行,但也有一些類(lèi)型的注解實(shí)際上可以用于這一目的。Java 注解是從 Java5 開(kāi)始添加到 Java 的。
注解理解的前提:
我認(rèn)為注解就是標(biāo)簽
它是在 Java SE 5.0 版本中開(kāi)始引入的概念,就如同java中的 class和interface
說(shuō)到這個(gè)就不得不說(shuō)注解中的基礎(chǔ)元注解
元注解: 元注解是可以注解到注解上的注解,或者說(shuō)元注解是一種基本注解,但是它能夠應(yīng)用到其它的注解上面。
如果不理解,可以這么認(rèn)為:元注解也是一張標(biāo)簽,但是它是一張?zhí)厥獾臉?biāo)簽,它的作用和目的就是給其他普通的標(biāo)簽進(jìn)行解釋說(shuō)明的。
元標(biāo)簽有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 種。
@Retention
Retention 的英文意為保留期的意思。當(dāng) @Retention 應(yīng)用到一個(gè)注解上的時(shí)候,它解釋說(shuō)明了這個(gè)注解的的存活時(shí)間。
它的取值如下:
RetentionPolicy.SOURCE 注解只在源碼階段保留,在編譯器進(jìn)行編譯時(shí)它將被丟棄忽視。
RetentionPolicy.CLASS 注解只被保留到編譯進(jìn)行的時(shí)候,它并不會(huì)被加載到 JVM 中。
RetentionPolicy.RUNTIME 注解可以保留到程序運(yùn)行的時(shí)候,它會(huì)被加載進(jìn)入到 JVM 中,所以在程序運(yùn)行時(shí)可以獲取到它們。
我們可以這樣的方式來(lái)加深理解,@Retention 去給一張標(biāo)簽解釋的時(shí)候,它指定了這張標(biāo)簽張貼的時(shí)間。@Retention 相當(dāng)于給一張標(biāo)簽上面蓋了一張時(shí)間戳,時(shí)間戳指明了標(biāo)簽張貼的時(shí)間周期。
@Retention(RetentionPolicy.RUNTIME)public @interfaceTestAnnotation {
}
@Documented
顧名思義,這個(gè)元注解肯定是和文檔有關(guān)。它的作用是能夠?qū)⒆⒔庵械脑匕?Javadoc 中去。
@Target
Target 是目標(biāo)的意思,@Target 指定了注解運(yùn)用的地方。
你可以這樣理解,當(dāng)一個(gè)注解被 @Target 注解時(shí),這個(gè)注解就被限定了運(yùn)用的場(chǎng)景。
類(lèi)比到標(biāo)簽,原本標(biāo)簽是你想張貼到哪個(gè)地方就到哪個(gè)地方,但是因?yàn)?@Target 的存在,它張貼的地方就非常具體了,比如只能張貼到方法上、類(lèi)上、方法參數(shù)上等等。@Target 有下面的取值
ElementType.ANNOTATION_TYPE 可以給一個(gè)注解進(jìn)行注解
ElementType.CONSTRUCTOR 可以給構(gòu)造方法進(jìn)行注解
ElementType.FIELD 可以給屬性進(jìn)行注解
ElementType.LOCAL_VARIABLE 可以給局部變量進(jìn)行注解
ElementType.METHOD 可以給方法進(jìn)行注解
ElementType.PACKAGE 可以給一個(gè)包進(jìn)行注解
ElementType.PARAMETER 可以給一個(gè)方法內(nèi)的參數(shù)進(jìn)行注解
ElementType.TYPE 可以給一個(gè)類(lèi)型進(jìn)行注解,比如類(lèi)、接口、枚舉
@Inherited
Inherited 是繼承的意思,但是它并不是說(shuō)注解本身可以繼承,而是說(shuō)如果一個(gè)超類(lèi)被 @Inherited 注解過(guò)的注解進(jìn)行注解的話,那么如果它的子類(lèi)沒(méi)有被任何注解應(yīng)用的話,那么這個(gè)子類(lèi)就繼承了超類(lèi)的注解。
說(shuō)的比較抽象。代碼來(lái)解釋。
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@interface Test {}
@Test
public class A {}
public class B extends A {}
注解 Test 被 @Inherited 修飾,之后類(lèi) A 被 Test 注解,類(lèi) B 繼承 A,類(lèi) B 也擁有 Test 這個(gè)注解。
@Repeatable
Repeatable 自然是可重復(fù)的意思。@Repeatable 是 Java 1.8 才加進(jìn)來(lái)的,所以算是一個(gè)新的特性。
什么樣的注解會(huì)多次應(yīng)用呢?通常是注解的值可以同時(shí)取多個(gè)。
@interface Persons {
Person[] value();
}
@Repeatable(Persons.class)
@interface Person{
String role() default "";
}
@Person(role="artist")
@Person(role="coder")
@Person(role="PM")
public class SuperMan{
}
注意上面的代碼,@Repeatable 注解了 Person。而 @Repeatable 后面括號(hào)中的類(lèi)相當(dāng)于一個(gè)容器注解。
什么是容器注解呢?就是用來(lái)存放其它注解的地方。它本身也是一個(gè)注解。
@interface Persons {
Person[] value();
}
按照規(guī)定,它里面必須要有一個(gè) value 的屬性,屬性類(lèi)型是一個(gè)被 @Repeatable 注解過(guò)的注解數(shù)組,注意它是數(shù)組。
如果不好理解的話,可以這樣理解。Persons 是一張總的標(biāo)簽,上面貼滿了 Person 這種同類(lèi)型但內(nèi)容不一樣的標(biāo)簽。把 Persons 給一個(gè) SuperMan 貼上,相當(dāng)于同時(shí)給他貼了程序員、產(chǎn)品經(jīng)理、畫(huà)家的標(biāo)簽。
我們可能對(duì)于 @Person(role=”P(pán)M”) 括號(hào)里面的內(nèi)容感興趣,它其實(shí)就是給 Person 這個(gè)注解的 role 屬性賦值為 PM ,大家不明白正常,馬上就講到注解的屬性這一塊。
注解的屬性
注解的屬性也叫做成員變量。注解只有成員變量,沒(méi)有方法。注解的成員變量在注解的定義中以“無(wú)形參的方法”形式來(lái)聲明,其方法名定義了該成員變量的名字,其返回值定義了該成員變量的類(lèi)型。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)public @interfaceTestAnnotation {intid();
String msg();
}
上面代碼定義了 TestAnnotation 這個(gè)注解中擁有 id 和 msg 兩個(gè)屬性。在使用的時(shí)候,我們應(yīng)該給它們進(jìn)行賦值。
賦值的方式是在注解的括號(hào)內(nèi)以 value=”” 形式,多個(gè)屬性之前用 ,隔開(kāi)。
需要注意的是,在注解中定義屬性時(shí)它的類(lèi)型必須是 8 種基本數(shù)據(jù)類(lèi)型外加 類(lèi)、接口、注解及它們的數(shù)組。
注解中屬性可以有默認(rèn)值,默認(rèn)值需要用 default 關(guān)鍵值指定。比如:
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)public @interfaceTestAnnotation {public int id() default -1;public String msg() default "Hi";
}
TestAnnotation 中 id 屬性默認(rèn)值為 -1,msg 屬性默認(rèn)值為 Hi。
它可以這樣應(yīng)用。
@TestAnnotation()
public class Test {}
因?yàn)橛心J(rèn)值,所以無(wú)需要再在 @TestAnnotation 后面的括號(hào)里面進(jìn)行賦值了,這一步可以省略。
最后,還需要注意的一種情況是一個(gè)注解沒(méi)有任何屬性。比如
public @interface Perform {}
那么在應(yīng)用這個(gè)注解的時(shí)候,括號(hào)都可以省略。
java 預(yù)置的注解
學(xué)習(xí)了上面相關(guān)的知識(shí),我們已經(jīng)可以自己定義一個(gè)注解了。其實(shí) Java 語(yǔ)言本身已經(jīng)提供了幾個(gè)現(xiàn)成的注解。
@Override
這個(gè)大家應(yīng)該很熟悉了,提示子類(lèi)要復(fù)寫(xiě)父類(lèi)中被 @Override 修飾的方法
@SuppressWarnings
阻止警告的意思。之前說(shuō)過(guò)調(diào)用被 @Deprecated 注解的方法后,編譯器會(huì)警告提醒,而有時(shí)候開(kāi)發(fā)者會(huì)忽略這種警告,他們可以在調(diào)用的地方通過(guò) @SuppressWarnings 達(dá)到目的。
@SuppressWarnings("deprecation")public voidtest1(){
Hero hero= newHero();
hero.say();
hero.speak();
}
還有一些就不一一列舉了
自定義注解
自定義注解可以理解為:注解自己的注解
建造自己的注解
1 importjava.lang.annotation.RetentionPolicy;2
3 @Retention(RetentionPolicy.RUNTIME)4 public @interfaceExecute {5
6 }
用它注解一些方法
1 public classdatr {2 @Execute3 public voidd(){4 System.out.println("dddd");5 }6 @Execute7 public voida(){8 System.out.println("aaaa");9 }10 @Execute11 public voidb(){12 System.out.println("bbbb");13 }14 @Execute15 public voidc(){16 System.out.println("cccc");17 }18 @Execute19 public voide(){20 System.out.println("eeee");21 }22 }
使用Test類(lèi)測(cè)試調(diào)用方法
importjava.lang.reflect.Method;public classTest {public static void main(String[] args) throwsException {
Class a= Class.forName("com.accp.entity.datr");
datr o=(datr) a.getConstructor().newInstance();for(Method arg : a.getDeclaredMethods()) {if (arg.isAnnotationPresent(Execute.class)){
arg.invoke(o);
}
}
}
}
注解與反射。
注解通過(guò)反射獲取。首先可以通過(guò) Class 對(duì)象的 isAnnotationPresent() 方法判斷它是否應(yīng)用了某個(gè)注解
public boolean isAnnotationPresent(Class extends Annotation> annotationClass) {}
然后通過(guò) getAnnotation() 方法來(lái)獲取 Annotation 對(duì)象。
public A getAnnotation(Class annotationClass) {}
或者是 getAnnotations() 方法。
public Annotation[] getAnnotations() {}
前一種方法返回指定類(lèi)型的注解,后一種方法返回注解到這個(gè)元素上的所有注解。
如果獲取到的 Annotation 如果不為 null,則就可以調(diào)用它們的屬性方法了。
1 @TestAnnotation()2 public classTest {3 public static voidmain(String[] args) {4 boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class);5 if( hasAnnotation ) {6 TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class);7 System.out.println("id:"+testAnnotation.id());8 System.out.println("msg:"+testAnnotation.msg());9 }10 }11 }
程序的運(yùn)行結(jié)果是:
1 id:-1
2 msg:
這個(gè)正是 TestAnnotation 中 id 和 msg 的默認(rèn)值。
需要注意的是,如果一個(gè)注解要在運(yùn)行時(shí)被成功提取,那么 @Retention(RetentionPolicy.RUNTIME) 是必須的。
注解應(yīng)用實(shí)例
注解運(yùn)用的地方太多了,如:
JUnit 這個(gè)是一個(gè)測(cè)試框架,典型使用方法如下:
1 public classExampleUnitTest {2 @Test3 public void addition_isCorrect() throwsException {4 assertEquals(4, 2 + 2);5 }6 }
還有例如ssm框架等運(yùn)用了大量的注解。
總結(jié)
如果注解難于理解,你就把它類(lèi)同于標(biāo)簽,標(biāo)簽為了解釋事物,注解為了解釋代碼。
注解的基本語(yǔ)法,創(chuàng)建如同接口,但是多了個(gè) @ 符號(hào)。
注解的元注解。
注解的屬性。
注解主要給編譯器及工具類(lèi)型的軟件用的。
注解的提取需要借助于 Java 的反射技術(shù),反射比較慢,所以注解使用時(shí)也需要謹(jǐn)慎計(jì)較時(shí)間成本。
總結(jié)
以上是生活随笔為你收集整理的java 注解 id_java注解的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
 
                            
                        - 上一篇: 读入两个字符串java_编写一个Java
- 下一篇: java导出pdf集合_java实现导出
