Java Annotation 註解

首先什麼是註解？

最多見的是，在咱們使用Eclipse等工具編寫java代碼的時候，有時候會出現一些好比@Deprecated，@Override，@SuppressWarnings等東東。這個就是常見的幾種註解。

在開發Java程序，尤爲是Java EE應用的時候，老是免不了與各類配置文件打交道。以Java EE中典型的S(pring)S(truts)H(ibernate)架構來講，Spring、Struts和Hibernate這 三個框架都有本身的XML格式的配置文件。這些配置文件須要與Java源代碼保存同步，不然的話就可能出現錯誤。並且這些錯誤有可能到了運行時刻才被髮 現。把同一份信息保存在兩個地方，老是個壞的主意。理想的狀況是在一個地方維護這些信息就行了。其它部分所需的信息則經過自動的方式來生成。JDK 5中引入了源代碼中的註解（annotation）這一機制。註解使得Java源代碼中不但能夠包含功能性的實現代碼，還能夠添加元數據。註解的功能相似 於代碼中的註釋，所不一樣的是註解不是提供代碼功能的說明，而是實現程序功能的重要組成部分。Java註解已經在不少框架中獲得了普遍的使用，用來簡化程序 中的配置。

而咱們最多見的可能就是上面提到的這三個註解了，簡單的介紹一下上面的這三個註解的做用：

一、@Override:只能用在方法之上的，用來告訴別人這一個方法是改寫父類的。 

二、@Deprecated:建議別人不要使用舊的API的時候用的,編譯的時候會用產生警告信息,能夠設定在程序裏的全部的元素上. 

三、@SuppressWarnings:這一個類型能夠來暫時把一些警告信息消息關閉. 

在jdk自帶的java.lang.annotation包裏,打開以下幾個源文件:

Target.java

Retention.java

RetentionPolicy.java

ElementType.java

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
   ElementType[] value();
}

 

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention {
   RetentionPolicy value();
}

 

public enum RetentionPolicy {
 SOURCE,
 CLASS,
 RUNTIME
}

 

public enum ElementType {
 TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR,
 LOCAL_VARIABLE, ANNOTATION_TYPE,PACKAGE
}

 

在設計annotations的時候必須把一個類型定義爲@interface。咱們須要注意的是：SOURCE,CLASS 和 RUNTIME.這三個級別。

SOURCE表明的是這個Annotation類型的信息只會保留在程序源碼裏，源碼若是通過了編譯以後，Annotation的數據就會消失,並不會保留在編譯好的.class文件裏面。 

ClASS的意思是這個Annotation類型的信息保留在程序源碼裏,同時也會保留在編譯好的.class文件裏面,在執行的時候，並不會把這一些 信息加載到虛擬機(JVM)中去.注意一下，當你沒有設定一個Annotation類型的Retention值時，系統默認值是CLASS. 

RUNTIME,表示在源碼、編譯好的.class文件中保留信息，在執行的時候會把這一些信息加載到JVM中去的．

＠Target裏面的ElementType是用來指定Annotation類型能夠用在哪一些元素上的.說明一下：TYPE(類型), FIELD(屬性), METHOD(方法), PARAMETER(參數), CONSTRUCTOR(構造函數),LOCAL_VARIABLE(局部變量), ANNOTATION_TYPE,PACKAGE(包),其中的TYPE(類型)是指能夠用在Class,Interface,Enum和 Annotation類型上.

另外,@Target本身也用了本身來聲明本身。若是一個Annotation類型沒有指明@Target使用在哪些元素上,那麼它可使用在任何元素之上,這裏的元素指的是上面的八種類型.

舉幾個正確的例子:

@Target(ElementType.METHOD) 
@Target(value=ElementType.METHOD) 
@Target(ElementType.METHOD,ElementType.CONSTRUCTOR)

 

@Documented的目的就是讓這一個Annotation類型的信息可以顯示在javaAPI說明文檔上;沒有添加的話，使用javadoc生成API文檔的時候就會找不到這一個類型生成的信息.

另一點，若是須要把Annotation的數據繼承給子類，那麼就會用到@Inherited這一個Annotation類型.

本文只是簡單的說了一下註解的常規用法，至於更加深刻的註解學習，請參見文章末尾的參考資料。下面咱們來看自定義一個註解：源代碼有以下幾個：

源碼分別爲：

package com.java.annotation;
 
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
/**
 * 類註解
 * */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface MyAnnotationClass {
    public String msg();
}

 

package com.java.annotation;
 
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
/**
 * 方法註解
 * */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyAnnotationMethod {
    public String common();
}

 

package com.java.annotation;
 
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface MyAnnotationField {
    boolean request();
}

 

package com.java.annotation;
 
@MyAnnotationClass(msg = "這個是一個類註解")
public class MyAnnotationDemo {
 
    public MyAnnotationDemo() {
    }
 
    public MyAnnotationDemo(String hello) {
        this.hello = hello;
    }
 
    @MyAnnotationMethod(common = "這個是一個方法註解")
    public void method() {
        System.out.println(hello);
    }
 
    @MyAnnotationField(request = true)
    private String hello;
}

 

package com.java.annotation;
 
import java.lang.reflect.Field;
import java.lang.reflect.Method;
 
public class MyAnnotationTest {
    public static void main(String[] args) {
        MyAnnotationDemo demo = new MyAnnotationDemo("hello rollen");
        MyAnnotationClass annotationClass = demo.getClass().getAnnotation(MyAnnotationClass.class);
        System.out.println(annotationClass.msg());
 
        Method method = null;
        try {
            method = demo.getClass().getMethod("method",new Class[0]);
        } catch (SecurityException e) {
            e.printStackTrace();
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        }
        MyAnnotationMethod annotationMethod = method.getAnnotation(MyAnnotationMethod.class);
        System.out.println(annotationMethod.common());
         
        Field field = null;
        try {
            field = demo.getClass().getDeclaredField("hello");
        } catch (SecurityException e) {
            e.printStackTrace();
        } catch (NoSuchFieldException e) {
            e.printStackTrace();
        }
        MyAnnotationField annotationField = field.getAnnotation(MyAnnotationField.class);
        System.out.println(annotationField.request());
 
    }
}