java注解

java注解:

Java 注解用於為 Java 代碼提供元數據。作為元數據，注解不直接影響你的代碼執行，但也有一些類型的注解實際上可以用於這一目的。Java 注解是從 Java5 開始添加到 Java 的。

注解理解的前提：知道什么是反射

我認為注解就是標簽

它是在 Java SE 5.0 版本中開始引入的概念，就如同java中的 class和interface

說到這個就不得不說注解中的基礎元注解

元注解：　元注解是可以注解到注解上的注解，或者說元注解是一種基本注解，但是它能夠應用到其它的注解上面。

如果不理解，可以這么認為：元注解也是一張標簽，但是它是一張特殊的標簽，它的作用和目的就是給其他普通的標簽進行解釋說明的。

元標簽有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 種。

@Retention 

Retention 的英文意為保留期的意思。當 @Retention 應用到一個注解上的時候，它解釋說明了這個注解的的存活時間。

 

它的取值如下：

 

• RetentionPolicy.SOURCE 注解只在源碼階段保留，在編譯器進行編譯時它將被丟棄忽視。
• RetentionPolicy.CLASS 注解只被保留到編譯進行的時候，它並不會被加載到 JVM 中。
• RetentionPolicy.RUNTIME 注解可以保留到程序運行的時候，它會被加載進入到 JVM 中，所以在程序運行時可以獲取到它們。

 

我們可以這樣的方式來加深理解，@Retention 去給一張標簽解釋的時候，它指定了這張標簽張貼的時間。@Retention 相當於給一張標簽上面蓋了一張時間戳，時間戳指明了標簽張貼的時間周期。

@Retention(RetentionPolicy.RUNTIME) public @interface TestAnnotation { 　　　　 }

 

 

@Documented

顧名思義，這個元注解肯定是和文檔有關。它的作用是能夠將注解中的元素包含到 Javadoc 中去。

　

@Target

 

Target 是目標的意思，@Target 指定了注解運用的地方。

你可以這樣理解，當一個注解被 @Target 注解時，這個注解就被限定了運用的場景。

類比到標簽，原本標簽是你想張貼到哪個地方就到哪個地方，但是因為 @Target 的存在，它張貼的地方就非常具體了，比如只能張貼到方法上、類上、方法參數上等等。@Target 有下面的取值

• ElementType.ANNOTATION_TYPE 可以給一個注解進行注解
• ElementType.CONSTRUCTOR 可以給構造方法進行注解
• ElementType.FIELD 可以給屬性進行注解
• ElementType.LOCAL_VARIABLE 可以給局部變量進行注解
• ElementType.METHOD 可以給方法進行注解
• ElementType.PACKAGE 可以給一個包進行注解
• ElementType.PARAMETER 可以給一個方法內的參數進行注解
• ElementType.TYPE 可以給一個類型進行注解，比如類、接口、枚舉

 

@Inherited

Inherited 是繼承的意思，但是它並不是說注解本身可以繼承，而是說如果一個超類被 @Inherited 注解過的注解進行注解的話，那么如果它的子類沒有被任何注解應用的話，那么這個子類就繼承了超類的注解。 
說的比較抽象。代碼來解釋。

@Inherited
@Retention(RetentionPolicy.RUNTIME)
@interface Test {}
@Test
public class A {}
public class B extends A {}

　　注解 Test 被 @Inherited 修飾，之后類 A 被 Test 注解，類 B 繼承 A,類 B 也擁有 Test 這個注解。

 

@Repeatable

Repeatable 自然是可重復的意思。@Repeatable 是 Java 1.8 才加進來的，所以算是一個新的特性。

什么樣的注解會多次應用呢？通常是注解的值可以同時取多個。

@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 后面括號中的類相當於一個容器注解。

什么是容器注解呢？就是用來存放其它注解的地方。它本身也是一個注解。

@interface Persons {
    Person[]  value();
}　

按照規定，它里面必須要有一個 value 的屬性，屬性類型是一個被 @Repeatable 注解過的注解數組，注意它是數組。

如果不好理解的話，可以這樣理解。Persons 是一張總的標簽，上面貼滿了 Person 這種同類型但內容不一樣的標簽。把 Persons 給一個 SuperMan 貼上，相當於同時給他貼了程序員、產品經理、畫家的標簽。

我們可能對於 @Person(role=”PM”) 括號里面的內容感興趣，它其實就是給 Person 這個注解的 role 屬性賦值為 PM ，大家不明白正常，馬上就講到注解的屬性這一塊。

注解的屬性

注解的屬性也叫做成員變量。注解只有成員變量，沒有方法。注解的成員變量在注解的定義中以“無形參的方法”形式來聲明，其方法名定義了該成員變量的名字，其返回值定義了該成員變量的類型。

@Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface TestAnnotation { int id(); String msg(); }

 

上面代碼定義了 TestAnnotation 這個注解中擁有 id 和 msg 兩個屬性。在使用的時候，我們應該給它們進行賦值。

賦值的方式是在注解的括號內以 value=”” 形式，多個屬性之前用 ，隔開。

 

需要注意的是，在注解中定義屬性時它的類型必須是 8 種基本數據類型外加 類、接口、注解及它們的數組。

注解中屬性可以有默認值，默認值需要用 default 關鍵值指定。比如：

@Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface TestAnnotation { public int id() default -1; public String msg() default "Hi"; }

 

TestAnnotation 中 id 屬性默認值為 -1，msg 屬性默認值為 Hi。 
它可以這樣應用。

@TestAnnotation()
public class Test {}

因為有默認值，所以無需要再在 @TestAnnotation 后面的括號里面進行賦值了，這一步可以省略。

最后，還需要注意的一種情況是一個注解沒有任何屬性。比如

public @interface Perform {}

　那么在應用這個注解的時候，括號都可以省略。

java 預置的注解

學習了上面相關的知識，我們已經可以自己定義一個注解了。其實 Java 語言本身已經提供了幾個現成的注解。

@Override

這個大家應該很熟悉了，提示子類要復寫父類中被 @Override 修飾的方法

@SuppressWarnings

阻止警告的意思。之前說過調用被 @Deprecated 注解的方法后，編譯器會警告提醒，而有時候開發者會忽略這種警告，他們可以在調用的地方通過 @SuppressWarnings 達到目的。

@SuppressWarnings("deprecation") public void test1(){ Hero hero = new Hero(); hero.say(); hero.speak(); }

 

還有一些就不一一列舉了

自定義注解

自定義注解可以理解為：注解自己的注解

建造自己的注解

import java.lang.annotation.RetentionPolicy; 2 
@Retention(RetentionPolicy.RUNTIME) 4 public @interface Execute { 5 
}

 

用它注解一些方法

public class datr {  2  @Execute  3     public void d(){  4         System.out.println("dddd");  5  }  6  @Execute  7     public void a(){  8         System.out.println("aaaa");  9  } 10  @Execute 11     public void b(){ 12         System.out.println("bbbb"); 13  } 14  @Execute 15     public void c(){ 16         System.out.println("cccc"); 17  } 18  @Execute 19     public void e(){ 20         System.out.println("eeee"); 21  } 22 }

 

使用Test類測試調用方法

import java.lang.reflect.Method; public class Test { public static void main(String[] args) throws Exception { 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); } } } }

注解與反射。

注解通過反射獲取。首先可以通過 Class 對象的 isAnnotationPresent() 方法判斷它是否應用了某個注解

public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}

然后通過 getAnnotation() 方法來獲取 Annotation 對象。

 public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}

或者是 getAnnotations() 方法。

public Annotation[] getAnnotations() {}

前一種方法返回指定類型的注解，后一種方法返回注解到這個元素上的所有注解。

如果獲取到的 Annotation 如果不為 null，則就可以調用它們的屬性方法了。

@TestAnnotation()  2 public class Test {  3     public static void main(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 }

 

程序的運行結果是：

id:-1
msg:

 

這個正是 TestAnnotation 中 id 和 msg 的默認值。

需要注意的是，如果一個注解要在運行時被成功提取，那么 @Retention(RetentionPolicy.RUNTIME) 是必須的。

注解應用實例

注解運用的地方太多了，如：
JUnit 這個是一個測試框架，典型使用方法如下：

public class ExampleUnitTest { 2  @Test 3     public void addition_isCorrect() throws Exception { 4         assertEquals(4, 2 + 2); 5  } 6 }

還有例如ssm框架等運用了大量的注解。

總結

• 如果注解難於理解，你就把它類同於標簽，標簽為了解釋事物，注解為了解釋代碼。
• 注解的基本語法，創建如同接口，但是多了個 @ 符號。
• 注解的元注解。
• 注解的屬性。
• 注解主要給編譯器及工具類型的軟件用的。
• 注解的提取需要借助於 Java 的反射技術，反射比較慢，所以注解使用時也需要謹慎計較時間成本。