spring之自定義注解

1.什么是注解

Annontation是Java5開始引入的新特征，它提供了一種安全的類似注釋的機制，用來將任何的信息或元數據（metadata）與程序元素（類、方法、成員變量等）進行關聯。為程序的元素（類、方法、成員變量）加上更直觀更明了的說明，這些說明信息是與程序的業務邏輯無關，並且供指定的工具或框架使用。Annontation像一種修飾符一樣，應用於包、類型、構造方法、方法、成員變量、參數及本地變量的聲明語句中。

注解本身是沒有功能的，就和xml一樣，注解和xml一樣是一種元數據，所謂元數據就是解釋數據的數據，俗稱配置，Java注解是附加在代碼中的一些元信息，用於一些工具在編譯、運行時進行解析和使用，起到說明、配置的功能。注解不會也不能影響代碼的實際邏輯，僅僅起到輔助性的作用。包含在 java.lang.annotation 包中。

 
2.注解的用處

a、生成文檔。這是最常見的，也是java 最早提供的注解。常用的有@param @return 等
b、跟蹤代碼依賴性，實現替代配置文件功能。比如Dagger 2依賴注入，未來java開發，將大量注解配置，具有很大用處;
c、在編譯時進行格式檢查。如@override 放在方法前，如果你這個方法並不是覆蓋了超類方法，則編譯時就能檢查出。
    
3.注解的原理

注解本質是一個繼承了Annotation的特殊接口，其具體實現類是Java運行時生成的動態代理類。而我們通過反射獲取注解時，返回的是Java運行時生成的動態代理對象$Proxy1。通過代理對象調用自定義注解（接口）的方法，會最終調用AnnotationInvocationHandler的invoke方法。該方法會從memberValues這個Map中索引出對應的值。而memberValues的來源是Java常量池。

 

 
JAVA提供常用的4種元注解：

    java.lang.annotation提供了四種元注解，專門注解其他的注解：
    @Target –注解用於什么地方，默認值為任何元素，表示該注解用於什么地方。可用的ElementType指定參數 ，也同時指定多個
      ● ElementType.CONSTRUCTOR:用於描述構造器
      ● ElementType.FIELD:成員變量、對象、屬性（包括enum實例）
      ● ElementType.LOCAL_VARIABLE:用於描述局部變量
      ● ElementType.METHOD:用於描述方法
      ● ElementType.PACKAGE:用於描述包
      ● ElementType.PARAMETER:用於描述參數
      ● ElementType.TYPE:用於描述類、接口(包括注解類型) 或enum聲明


    @Retention –什么時候使用該注解，即注解的生命周期，使用RetentionPolicy來指定
      ●   RetentionPolicy.SOURCE : 在編譯階段丟棄。這些注解在編譯結束之后就不再有任何意義，所以它們不會寫入字節碼。@Override, @SuppressWarnings都屬於這類注解。
      ●   RetentionPolicy.CLASS : 在類加載的時候丟棄。在字節碼文件的處理中有用。注解默認使用這種方式
      ●   RetentionPolicy.RUNTIME : 始終不會丟棄，運行期也保留該注解，因此可以使用反射機制讀取該注解的信息。我們自定義的注解通常使用這種方式。
        

    @Documented –注解是否將包含在JavaDoc中

    @Inherited – 是否允許子類繼承該注解
        @Inherited 元注解是一個標記注解，@Inherited闡述了某個被標注的類型是被繼承的。如果一個使用了@Inherited修飾的annotation類型被用於一個class，則這個annotation將被用於該class的子類。

 
自定義注解類編寫的一些規則:

        Annotation型定義為@interface, 所有的Annotation會自動繼承java.lang.Annotation這一接口,並且不能再去繼承別的類或是接口.
        參數成員只能用public或默認(default)這兩個訪問權修飾
        參數成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數據類型和String、Enum、Class、annotations等數據類型,以及這一些類型的數組.
        要獲取類方法和字段的注解信息，必須通過Java的反射技術來獲取 Annotation對象,因為你除此之外沒有別的獲取注解對象的方法
        注解也可以沒有定義成員

 
自定義注解

以下是常用的自定義注解demo:

     
    @Target({ElementType.ANNOTATION_TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface Audit {
        OpsType opsType() default OpsType.APP;
        OpsCategory category() default OpsCategory.APP;
        OpsMode mode() default OpsMode.ADD;
        String modelExpression() default "";
    }
     
     
    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    @Configuration
    @ComponentScan
    public @interface KakaConfiguration {
        public String[] value() default {}; //表示注解可以接受的名字是value的值
    }
     
     
    /**
     * 不用登錄注解
     */
    @Target({ ElementType.TYPE, ElementType.METHOD })
    @Retention(RetentionPolicy.RUNTIME)
    public @interface NoLogin {
     
    }
     
    /**
     * 無需權限校驗
     */
    @Target({ ElementType.TYPE, ElementType.METHOD })
    @Retention(RetentionPolicy.RUNTIME)
    public @interface NoAuth {
     
    }
     

可以看出，自定義注解中的格式：public @interface 注解名 {定義體}

注解中的成員只能用public或默認(default)這兩個訪問權修飾，注意如果只有一個參數成員,最好把參數名稱設為"value"

 
組合注解和元注解

元注解就是可以注解其實就是可以注解在其他注解上的注解，被注解的注解成為組合注解，組合注解也具有元注解的功能
6.獲取注解並使用

通過Class對象反射獲取到class對象，通過Class對象獲取字段Field，方法Method等

調用isAnnotationPresent(注解.class)方法判斷字段上（或方法上）是否有注解，然后通過.getAnnotation(注解.class).value().toString()獲取注解的value的值，一般定義注解，我們在springMVC的攔截器中或者SpringAOP中攔截獲取注解的值做出相應的處理

String  nameSpace =method.getAnnotation(QueryCache.class).nameSpace().toString();