關聯文章：

java註解是在JDK5時引入的新特性，鑑於目前大部分框架(如Spring)都使用了註解簡化程式碼並提高編碼的效率，因此掌握並深入理解註解對於一個Java工程師是來說是很有必要的事。本篇我們將通過以下幾個角度來分析註解的相關知識點

理解Java註解

實際上Java註解與普通修飾符(public、static、void等)的使用方式並沒有多大區別，下面的例子是常見的註解：

public class AnnotationDemo {
    //@Test註解修飾方法A
    @Test
    public static void A(){
        System.out.println("Test....."
 
);
    }

    //一個方法上可以擁有多個不同的註解
    @Deprecated
    @SuppressWarnings("uncheck")
    public static void B(){

    }
}

通過在方法上使用@Test註解後，在執行該方法時，測試框架會自動識別該方法並單獨呼叫，@Test實際上是一種標記註解，起標記作用，執行時告訴測試框架該方法為測試方法。而對於@Deprecated和@SuppressWarnings(“uncheck”)，則是Java本身內建的註解，在程式碼中，可以經常看見它們，但這並不是一件好事，畢竟當方法或是類上面有@Deprecated註解時，說明該方法或是類都已經過期不建議再用，@SuppressWarnings 則表示忽略指定警告，比如@SuppressWarnings(“uncheck”)，這就是註解的最簡單的使用方式，那麼下面我們就來看看註解定義的基本語法

基本語法

宣告註解與元註解

我們先來看看前面的Test註解是如何宣告的：

//宣告Test註解
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {

} 

我們使用了@interface聲明瞭Test註解，並使用@Target註解傳入ElementType.METHOD引數來標明@Test只能用於方法上，@Retention(RetentionPolicy.RUNTIME)則用來表示該註解生存期是執行時，從程式碼上看註解的定義很像介面的定義，確實如此，畢竟在編譯後也會生成Test.class檔案。對於@Target

• @Target 用來約束註解可以應用的地方（如方法、類或欄位），其中ElementType是列舉型別，其定義如下，也代表可能的取值範圍

  public enum ElementType {
      /**標明該註解可以用於類、介面（包括註解型別）或enum宣告*/
      TYPE,
  
      /** 標明該註解可以用於欄位(域)宣告，包括enum例項 */
      FIELD,
  
      /** 標明該註解可以用於方法宣告 */
      METHOD,
  
      /** 標明該註解可以用於引數宣告 */
      PARAMETER,
  
      /** 標明註解可以用於建構函式宣告 */
      CONSTRUCTOR,
  
      /** 標明註解可以用於區域性變數宣告 */
      LOCAL_VARIABLE,
  
      /** 標明註解可以用於註解宣告(應用於另一個註解上)*/
      ANNOTATION_TYPE,
  
      /** 標明註解可以用於包宣告 */
      PACKAGE,
  
      /**
       * 標明註解可以用於型別引數宣告（1.8新加入）
       * @since 1.8
       */
      TYPE_PARAMETER,
  
      /**
       * 型別使用宣告（1.8新加入)
       * @since 1.8
       */
      TYPE_USE
  }

  請注意，當註解未指定Target值時，則此註解可以用於任何元素之上，多個值使用{}包含並用逗號隔開，如下：

  @Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})

• @Retention用來約束註解的生命週期，分別有三個值，原始碼級別（source），類檔案級別（class）或者執行時級別（runtime），其含有如下：

  • SOURCE：註解將被編譯器丟棄（該型別的註解資訊只會保留在原始碼裡，原始碼經過編譯後，註解資訊會被丟棄，不會保留在編譯好的class檔案裡）

  • CLASS：註解在class檔案中可用，但會被VM丟棄（該型別的註解資訊會保留在原始碼裡和class檔案裡，在執行的時候，不會載入到虛擬機器中），請注意，當註解未定義Retention值時，預設值是CLASS，如Java內建註解，@Override、@Deprecated、@SuppressWarnning等

  • RUNTIME：註解資訊將在執行期(JVM)也保留，因此可以通過反射機制讀取註解的資訊（原始碼、class檔案和執行的時候都有註解的資訊），如SpringMvc中的@Controller、@Autowired、@RequestMapping等。

註解元素及其資料型別

通過上述對@Test註解的定義，我們瞭解了註解定義的過程，由於@Test內部沒有定義其他元素，所以@Test也稱為標記註解（marker annotation），但在自定義註解中，一般都會包含一些元素以表示某些值，方便處理器使用，這點在下面的例子將會看到：

/**
 * Created by wuzejian on 2017/5/18.
 * 對應資料表註解
 */
@Target(ElementType.TYPE)//只能應用於類上
@Retention(RetentionPolicy.RUNTIME)//儲存到執行時
public @interface DBTable {
    String name() default "";
}

上述定義一個名為DBTable的註解，該用於主要用於資料庫表與Bean類的對映（稍後會有完整案例分析），與前面Test註解不同的是，我們宣告一個String型別的name元素，其預設值為空字元，但是必須注意到對應任何元素的宣告應採用方法的宣告方式，同時可選擇使用default提供預設值，@DBTable使用方式如下：

//在類上使用該註解
@DBTable(name = "MEMBER")
public class Member {
    //.......
}

關於註解支援的元素資料型別除了上述的String，還支援如下資料型別

• 所有基本型別（int,float,boolean,byte,double,char,long,short）

• String

• Class

• enum

• Annotation

• 上述型別的陣列

倘若使用了其他資料型別，編譯器將會丟出一個編譯錯誤，注意，宣告註解元素時可以使用基本型別但不允許使用任何包裝型別，同時還應該注意到註解也可以作為元素的型別，也就是巢狀註解，下面的程式碼演示了上述型別的使用過程：

package com.zejian.annotationdemo;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Created by wuzejian on 2017/5/19.
 * 資料型別使用Demo
 */

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface Reference{
    boolean next() default false;
}

public @interface AnnotationElementDemo {
    //列舉型別
    enum Status {FIXED,NORMAL};

    //宣告列舉
    Status status() default Status.FIXED;

    //布林型別
    boolean showSupport() default false;

    //String型別
    String name()default "";

    //class型別
    Class<?> testCase() default Void.class;

    //註解巢狀
    Reference reference() default @Reference(next=true);

    //陣列型別
    long[] value();
}

編譯器對預設值的限制

編譯器對元素的預設值有些過分挑剔。首先，元素不能有不確定的值。也就是說，元素必須要麼具有預設值，要麼在使用註解時提供元素的值。其次，對於非基本型別的元素，無論是在原始碼中宣告，還是在註解介面中定義預設值，都不能以null作為值，這就是限制，沒有什麼利用可言，但造成一個元素的存在或缺失狀態，因為每個註解的宣告中，所有的元素都存在，並且都具有相應的值，為了繞開這個限制，只能定義一些特殊的值，例如空字串或負數，表示某個元素不存在。

註解不支援繼承

註解是不支援繼承的，因此不能使用關鍵字extends來繼承某個@interface，但註解在編譯後，編譯器會自動繼承java.lang.annotation.Annotation介面，這裡我們反編譯前面定義的DBTable註解

package com.zejian.annotationdemo;

import java.lang.annotation.Annotation;
//反編譯後的程式碼
public interface DBTable extends Annotation
{
    public abstract String name();
}

雖然反編譯後發現DBTable註解繼承了Annotation介面，請記住，即使Java的介面可以實現多繼承，但定義註解時依然無法使用extends關鍵字繼承@interface。

快捷方式

所謂的快捷方式就是註解中定義了名為value的元素，並且在使用該註解時，如果該元素是唯一需要賦值的一個元素，那麼此時無需使用key=value的語法，而只需在括號內給出value元素所需的值即可。這可以應用於任何合法型別的元素，記住，這限制了元素名必須為value，簡單案例如下

package com.zejian.annotationdemo;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Created by zejian on 2017/5/20.
 * Blog : http://blog.csdn.net/javazejian [原文地址,請尊重原創]
 */
//定義註解
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface IntegerVaule{
    int value() default 0;
    String name() default "";
}

//使用註解
public class QuicklyWay {

    //當只想給value賦值時,可以使用以下快捷方式
    @IntegerVaule(20)
    public int age;

    //當name也需要賦值時必須採用key=value的方式賦值
    @IntegerVaule(value = 10000,name = "MONEY")
    public int money;

}

Java內建註解與其它元註解

接著看看Java提供的內建註解，主要有3個，如下：

• @Override：用於標明此方法覆蓋了父類的方法，原始碼如下

  @Target(ElementType.METHOD)
  @Retention(RetentionPolicy.SOURCE)
  public @interface Override {
  }

• @Deprecated：用於標明已經過時的方法或類，原始碼如下，關於@Documented稍後分析：

  @Documented
  @Retention(RetentionPolicy.RUNTIME)
  @Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
  public @interface Deprecated {
  }

• @SuppressWarnnings:用於有選擇的關閉編譯器對類、方法、成員變數、變數初始化的警告，其實現原始碼如下：

  @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
  @Retention(RetentionPolicy.SOURCE)
  public @interface SuppressWarnings {
      String[] value();
  }

  其內部有一個String陣列，主要接收值如下：

  deprecation：使用了不贊成使用的類或方法時的警告；
  unchecked：執行了未檢查的轉換時的警告，例如當使用集合時沒有用泛型 (Generics) 來指定集合儲存的型別; 
  fallthrough：當 Switch 程式塊直接通往下一種情況而沒有 Break 時的警告;
  path：在類路徑、原始檔路徑等中有不存在的路徑時的警告; 
  serial：當在可序列化的類上缺少 serialVersionUID 定義時的警告; 
  finally：任何 finally 子句不能正常完成時的警告; 
  all：關於以上所有情況的警告。

這個三個註解比較簡單，看個簡單案例即可：

//註明該類已過時，不建議使用
@Deprecated
class A{
    public void A(){ }

    //註明該方法已過時，不建議使用
    @Deprecated()
    public void B(){ }
}

class B extends A{

    @Override //標明覆蓋父類A的A方法
    public void A() {
        super.A();
    }

    //去掉檢測警告
    @SuppressWarnings({"uncheck","deprecation"})
    public void C(){ } 
    //去掉檢測警告
    @SuppressWarnings("uncheck")
    public void D(){ }
}

前面我們分析了兩種元註解，@Target和@Retention，除了這兩種元註解，Java還提供了另外兩種元註解，@Documented和@Inherited，下面分別介紹：

• @Documented 被修飾的註解會生成到javadoc中

  /**
   * Created by zejian on 2017/5/20.
   * Blog : http://blog.csdn.net/javazejian [原文地址,請尊重原創]
   */
  @Documented
  @Target(ElementType.TYPE)
  @Retention(RetentionPolicy.RUNTIME)
  public @interface DocumentA {
  }
  
  //沒有使用@Documented
  @Target(ElementType.TYPE)
  @Retention(RetentionPolicy.RUNTIME)
  public @interface DocumentB {
  }
  
  //使用註解
  @DocumentA
  @DocumentB
  public class DocumentDemo {
      public void A(){
      }
  }

  使用javadoc命令生成文件：

  [email protected] annotationdemo$ javadoc DocumentDemo.java DocumentA.java DocumentB.java 

  如下：
  

  可以發現使用@Documented元註解定義的註解(@DocumentA)將會生成到javadoc中,而@DocumentB則沒有在doc文件中出現，這就是元註解@Documented的作用。

• @Inherited 可以讓註解被繼承，但這並不是真的繼承，只是通過使用@Inherited，可以讓子類Class物件使用getAnnotations()獲取父類被@Inherited修飾的註解，如下：

  @Inherited
  @Documented
  @Target(ElementType.TYPE)
  @Retention(RetentionPolicy.RUNTIME)
  public @interface DocumentA {
  }
  
  @Target(ElementType.TYPE)
  @Retention(RetentionPolicy.RUNTIME)
  public @interface DocumentB {
  }
  
  @DocumentA
  class A{ }
  
  class B extends A{ }
  
  @DocumentB
  class C{ }
  
  class D extends C{ }
  
  //測試
  public class DocumentDemo {
  
      public static void main(String... args){
          A instanceA=new B();
          System.out.println("已使用的@Inherited註解:"+Arrays.toString(instanceA.getClass().getAnnotations()));
  
          C instanceC = new D();
  
          System.out.println("沒有使用的@Inherited註解:"+Arrays.toString(instanceC.getClass().getAnnotations()));
      }
  
      /**
       * 執行結果:
       已使用的@Inherited註解:[@com.zejian.annotationdemo.DocumentA()]
       沒有使用的@Inherited註解:[]
       */
  }

註解與反射機制

前面經過反編譯後，我們知道Java所有註解都繼承了Annotation介面，也就是說　Java使用Annotation介面代表註解元素，該介面是所有Annotation型別的父介面。同時為了執行時能準確獲取到註解的相關資訊，Java在java.lang.reflect 反射包下新增了AnnotatedElement介面，它主要用於表示目前正在 VM 中執行的程式中已使用註解的元素，通過該介面提供的方法可以利用反射技術地讀取註解的資訊，如反射包的Constructor類、Field類、Method類、Package類和Class類都實現了AnnotatedElement介面，它簡要含義如下（更多詳細介紹可以看 深入理解Java型別資訊(Class物件)與反射機制）：

Class：類的Class物件定義 　
Constructor：代表類的構造器定義 　
Field：代表類的成員變數定義
Method：代表類的方法定義 　
Package：代表類的包定義

下面是AnnotatedElement中相關的API方法，以上5個類都實現以下的方法

簡單案例演示如下：

package com.zejian.annotationdemo;

import java.lang.annotation.Annotation;
import java.util.Arrays;

/**
 * Created by zejian on 2017/5/20.
 * Blog : http://blog.csdn.net/javazejian [原文地址,請尊重原創]
 */
@DocumentA
class A{ }

//繼承了A類
@DocumentB
public class DocumentDemo extends A{

    public static void main(String... args){

        Class<?> clazz = DocumentDemo.class;
        //根據指定註解型別獲取該註解
        DocumentA documentA=clazz.getAnnotation(DocumentA.class);
        System.out.println("A:"+documentA);

        //獲取該元素上的所有註解，包含從父類繼承
        Annotation[] an= clazz.getAnnotations();
        System.out.println("an:"+ Arrays.toString(an));
        //獲取該元素上的所有註解，但不包含繼承！
        Annotation[] an2=clazz.getDeclaredAnnotations();
        System.out.println("an2:"+ Arrays.toString(an2));

        //判斷註解DocumentA是否在該元素上
        boolean b=clazz.isAnnotationPresent(DocumentA.class);
        System.out.println("b:"+b);

        /**
         * 執行結果:
         A:@com.zejian.annotationdemo.DocumentA()
         an:[@com.zejian.annotationdemo.DocumentA(), @com.zejian.annotationdemo.DocumentB()]
         an2:@com.zejian.annotationdemo.DocumentB()
         b:true
         */
    }
}

執行時註解處理器

瞭解完註解與反射的相關API後，現在通過一個例項（該例子是博主改編自《Tinking in Java》）來演示利用執行時註解來組裝資料庫SQL的構建語句的過程

/**
 * Created by wuzejian on 2017/5/18.
 * 表註解
 */
@Target(ElementType.TYPE)//只能應用於類上
@Retention(RetentionPolicy.RUNTIME)//儲存到執行時
public @interface DBTable {
    String name() default "";
}


/**
 * Created by wuzejian on 2017/5/18.
 * 註解Integer型別的欄位
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface SQLInteger {
    //該欄位對應資料庫表列名
    String name() default "";
    //巢狀註解
    Constraints constraint() default @Constraints;
}


/**
 * Created by wuzejian on 2017/5/18.
 * 註解String型別的欄位
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface SQLString {

    //對應資料庫表的列名
    String name() default "";

    //列型別分配的長度，如varchar(30)的30
    int value() default 0;

    Constraints constraint() default @Constraints;
}


/**
 * Created by wuzejian on 2017/5/18.
 * 約束註解
 */

@Target(ElementType.FIELD)//只能應用在欄位上
@Retention(RetentionPolicy.RUNTIME)
public @interface Constraints {
    //判斷是否作為主鍵約束
    boolean primaryKey() default false;
    //判斷是否允許為null
    boolean allowNull() default false;
    //判斷是否唯一
    boolean unique() default false;
}

/**
 * Created by wuzejian on 2017/5/18.
 * 資料庫表Member對應例項類bean
 */
@DBTable(name = "MEMBER")
public class Member {
    //主鍵ID
    @SQLString(name = "ID",value = 50, constraint = @Constraints(primaryKey = true))
    private String id;

    @SQLString(name = "NAME" , value = 30)
    private String name;

    @SQLInteger(name = "AGE")
    private int age;

    @SQLString(name = "DESCRIPTION" ,value = 150 , constraint = @Constraints(allowNull = true))
    private String description;//個人描述

   //省略set get.....
}

上述定義4個註解，分別是@DBTable(用於類上)、@Constraints(用於欄位上)、 @SQLString(用於欄位上)、@SQLString(用於欄位上)並在Member類中使用這些註解，這些註解的作用的是用於幫助註解處理器生成建立資料庫表MEMBER的構建語句，在這裡有點需要注意的是，我們使用了巢狀註解@Constraints，該註解主要用於判斷欄位是否為null或者欄位是否唯一。必須清楚認識到上述提供的註解生命週期必須為@Retention(RetentionPolicy.RUNTIME)，即執行時，這樣才可以使用反射機制獲取其資訊。有了上述註解和使用，剩餘的就是編寫上述的註解處理器了，前面我們聊了很多註解，其處理器要麼是Java自身已提供、要麼是框架已提供的，我們自己都沒有涉及到註解處理器的編寫，但上述定義處理SQL的註解，其處理器必須由我們自己編寫了，如下

package com.zejian.annotationdemo;
import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.List;

/**
 * Created by zejian on 2017/5/13.
 * Blog : http://blog.csdn.net/javazejian [原文地址,請尊重原創]
 * 執行時註解處理器，構造表建立語句
 */
public class TableCreator {

  public static String createTableSql(String className) throws ClassNotFoundException {
    Class<?> cl = Class.forName(className);
    DBTable dbTable = cl.getAnnotation(DBTable.class);
    //如果沒有表註解，直接返回
    if(dbTable == null) {
      System.out.println(
              "No DBTable annotations in class " + className);
      return null;
    }
    String tableName = dbTable.name();
    // If the name is empty, use the Class name:
    if(tableName.length() < 1)
      tableName = cl.getName().toUpperCase();
    List<String> columnDefs = new ArrayList<String>();
    //通過Class類API獲取到所有成員欄位
    for(Field field : cl.getDeclaredFields()) {
      String columnName = null;
      //獲取欄位上的註解
      Annotation[] anns = field.getDeclaredAnnotations();
      if(anns.length < 1)
        continue; // Not a db table column

      //判斷註解型別
      if(anns[0] instanceof SQLInteger) {
        SQLInteger sInt = (SQLInteger) anns[0];
        //獲取欄位對應列名稱，如果沒有就是使用欄位名稱替代
        if(sInt.name().length() < 1)
          columnName = field.getName().toUpperCase();
        else
          columnName = sInt.name();
        //構建語句
        columnDefs.add(columnName + " INT" +
                getConstraints(sInt.constraint()));
      }
      //判斷String型別
      if(anns[0] instanceof SQLString) {
        SQLString sString = (SQLString) anns[0];
        // Use field name if name not specified.
        if(sString.name().length() < 1)
          columnName = field.getName().toUpperCase();
        else
          columnName = sString.name();
        columnDefs.add(columnName + " VARCHAR(" +
                sString.value() + ")" +
                getConstraints(sString.constraint()));
      }


    }
    //資料庫表構建語句
    StringBuilder createCommand = new StringBuilder(
            "CREATE TABLE " + tableName + "(");
    for(String columnDef : columnDefs)
      createCommand.append("\n    " + columnDef + ",");

    // Remove trailing comma
    String tableCreate = createCommand.substring(
            0, createCommand.length() - 1) + ");";
    return tableCreate;
  }


    /**
     * 判斷該欄位是否有其他約束
     * @param con
     * @return
     */
  private static String getConstraints(Constraints con) {
    String constraints = "";
    if(!con.allowNull())
      constraints += " NOT NULL";
    if(con.primaryKey())
      constraints += " PRIMARY KEY";
    if(con.unique())
      constraints += " UNIQUE";
    return constraints;
  }

  public static void main(String[] args) throws Exception {
    String[] arg={"com.zejian.annotationdemo.Member"};
    for(String className : arg) {
      System.out.println("Table Creation SQL for " +
              className + " is :\n" + createTableSql(className));
    }

    /**
     * 輸出結果：
     Table Creation SQL for com.zejian.annotationdemo.Member is :
     CREATE TABLE MEMBER(
     ID VARCHAR(50) NOT NULL PRIMARY KEY,
     NAME VARCHAR(30) NOT NULL,
     AGE INT NOT NULL,
     DESCRIPTION VARCHAR(150)
     );
     */
  }
}

如果對反射比較熟悉的同學，上述程式碼就相對簡單了，我們通過傳遞Member的全路徑後通過Class.forName()方法獲取到Member的class物件，然後利用Class物件中的方法獲取所有成員欄位Field，最後利用field.getDeclaredAnnotations()遍歷每個Field上的註解再通過註解的型別判斷來構建建表的SQL語句。這便是利用註解結合反射來構建SQL語句的簡單的處理器模型，是否已回想起Hibernate？

Java 8中註解增強

元註解@Repeatable

元註解@Repeatable是JDK1.8新加入的，它表示在同一個位置重複相同的註解。在沒有該註解前，一般是無法在同一個型別上使用相同的註解的

//Java8前無法這樣使用
@FilterPath("/web/update")
@FilterPath("/web/add")
public class A {}

Java8前如果是想實現類似的功能，我們需要在定義@FilterPath註解時定義一個數組元素接收多個值如下

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface FilterPath {
    String [] value();
}

//使用
@FilterPath({"/update","/add"})
public class A { }

但在Java8新增了@Repeatable註解後就可以採用如下的方式定義並使用了

package com.zejian.annotationdemo;

import java.lang.annotation.*;

/**
 * Created by zejian on 2017/5/20.
 * Blog : http://blog.csdn.net/javazejian [原文地址,請尊重原創]
 */
//使用Java8新增@Repeatable原註解
@Target({ElementType.TYPE,ElementType.FIELD,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(FilterPaths.class)//引數指明接收的註解class
public @interface FilterPath {
    String  value();
}

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface FilterPaths {
    FilterPath[] value();
}

//使用案例
@FilterPath("/web/update")
@FilterPath("/web/add")
@FilterPath("/web/delete")
class AA{ }

我們可以簡單理解為通過使用@Repeatable後，將使用@FilterPaths註解作為接收同一個型別上重複註解的容器，而每個@FilterPath則負責儲存指定的路徑串。為了處理上述的新增註解，Java8還在AnnotatedElement介面新增了getDeclaredAnnotationsByType() 和 getAnnotationsByType()兩個方法並在介面給出了預設實現，在指定@Repeatable的註解時，可以通過這兩個方法獲取到註解相關資訊。但請注意，舊版API中的getDeclaredAnnotation()和 getAnnotation()是不對@Repeatable註解的處理的(除非該註解沒有在同一個宣告上重複出現)。注意getDeclaredAnnotationsByType方法獲取到的註解不包括父類，其實當 getAnnotationsByType()方法呼叫時，其內部先執行了getDeclaredAnnotationsByType方法，只有當前類不存在指定註解時，getAnnotationsByType()才會繼續從其父類尋找，但請注意如果@FilterPath和@FilterPaths沒有使用了@Inherited的話，仍然無法獲取。下面通過程式碼來演示：

/**
 * Created by zejian on 2017/5/20.
 * Blog : http://blog.csdn.net/javazejian [原文地址,請尊重原創]
 */
//使用Java8新增@Repeatable原註解
@Target({ElementType.TYPE,ElementType.FIELD,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(FilterPaths.class)
public @interface FilterPath {
    String  value();
}


@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface FilterPaths {
    FilterPath[] value();
}

@FilterPath("/web/list")
class CC { }

//使用案例
@FilterPath("/web/update")
@FilterPath("/web/add")
@FilterPath("/web/delete")
class AA extends CC{
    public static void main(String[] args) {

        Class<?> clazz = AA.class;
        //通過getAnnotationsByType方法獲取所有重複註解
        FilterPath[] annotationsByType = clazz.getAnnotationsByType(FilterPath.class);
        FilterPath[] annotationsByType2 = clazz.getDeclaredAnnotationsByType(FilterPath.class);
        if (annotationsByType != null) {
            for (FilterPath filter : annotationsByType) {
                System.out.println("1:"+filter.value());
            }
        }

        System.out.println("-----------------");

        if (annotationsByType2 != null) {
            for (FilterPath filter : annotationsByType2) {
                System.out.println("2:"+filter.value());
            }
        }


        System.out.println("使用getAnnotation的結果:"+clazz.getAnnotation(FilterPath.class));


        /**
         * 執行結果(當前類擁有該註解FilterPath,則不會從CC父類尋找)
         1:/web/update
         1:/web/add
         1:/web/delete
         -----------------
         2:/web/update
         2:/web/add
         2:/web/delete
         使用getAnnotation的結果:null
         */
    }
}

從執行結果來看如果當前類擁有該註解@FilterPath,則getAnnotationsByType方法不會從CC父類尋找，下面看看另外一種情況，即AA類上沒有@FilterPath註解

/**
 * Created by zejian on 2017/5/20.
 * Blog : http://blog.csdn.net/javazejian [原文地址,請尊重原創]
 */
//使用Java8新增@Repeatable原註解
@Target({ElementType.TYPE,ElementType.FIELD,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited //新增可繼承元註解
@Repeatable(FilterPaths.class)
public @interface FilterPath {
    String  value();
}


@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited //新增可繼承元註解
@interface FilterPaths {
    FilterPath[] value();
}

@FilterPath("/web/list")
@FilterPath("/web/getList")
class CC { }

//AA上不使用@FilterPath註解,getAnnotationsByType將會從父類查詢
class AA extends CC{
    public static void main(String[] args) {

        Class<?> clazz = AA.class;
        //通過getAnnotationsByType方法獲取所有重複註解
        FilterPath[] annotationsByType = clazz.getAnnotationsByType(FilterPath.class);
        FilterPath[] annotationsByType2 = clazz.getDeclaredAnnotationsByType(FilterPath.class);
        if (annotationsByType != null) {
            for (FilterPath filter : annotationsByType) {
                System.out.println("1:"+filter.value());
            }
        }

        System.out.println("-----------------");

        if (annotationsByType2 != null) {
            for (FilterPath filter : annotationsByType2) {
                System.out.println("2:"+filter.value());
            }
        }


        System.out.println("使用getAnnotation的結果:"+clazz.getAnnotation(FilterPath.class));


        /**
         * 執行結果(當前類沒有@FilterPath,getAnnotationsByType方法從CC父類尋找)
         1:/web/list
         1:/web/getList
         -----------------
         使用getAnnotation的結果:null
         */
    }
}

注意定義@FilterPath和@FilterPath時必須指明@Inherited，getAnnotationsByType方法否則依舊無法從父類獲取@FilterPath註解，這是為什麼呢，不妨看看getAnnotationsByType方法的實現原始碼：

//介面預設實現方法
default <T extends Annotation> T[] getAnnotationsByType(Class<T> annotationClass) {
//先呼叫getDeclaredAnnotationsByType方法
T[] result = getDeclaredAnnotationsByType(annotationClass);

//判斷當前類獲取到的註解陣列是否為0
if (result.length == 0 && this instanceof Class && 
//判斷定義註解上是否使用了@Inherited元註解 
 AnnotationType.getInstance(annotationClass).isInherited()) { // Inheritable
        //從父類獲取
       Class<?> superClass = ((Class<?>) this).getSuperclass();
   if (superClass != null) {
      result = superClass.getAnnotationsByType(annotationClass);
       }
   }

   return result;
}

新增的兩種ElementType

在Java8中 ElementType 新增兩個列舉成員，TYPE_PARAMETER 和 TYPE_USE ，在Java8前註解只能標註在一個宣告(如欄位、類、方法)上，Java8後，新增的TYPE_PARAMETER可以用於標註型別引數，而TYPE_USE則可以用於標註任意型別(不包括class)。如下所示

//TYPE_PARAMETER 標註在型別引數上
class D<@Parameter T> { }

//TYPE_USE則可以用於標註任意型別(不包括class)
//用於父類或者介面
class Image implements @Rectangular Shape { }

//用於建構函式
new @Path String("/usr/bin")

//用於強制轉換和instanceof檢查,注意這些註解中用於外部工具，它們不會對型別轉換或者instanceof的檢查行為帶來任何影響。
String path=(@Path String)input;
if(input instanceof @Path String)

//用於指定異常
public Person read() throws @Localized IOException.

//用於萬用字元繫結
List<@ReadOnly ? extends Person>
List<? extends @ReadOnly Person>

@NotNull String.class //非法，不能標註class
import [email protected] String //非法，不能標註import

這裡主要說明一下TYPE_USE，型別註解用來支援在Java的程式中做強型別檢查，配合第三方外掛工具（如Checker Framework），可以在編譯期檢測出runtime error（如UnsupportedOperationException、NullPointerException異常），避免異常延續到執行期才發現，從而提高程式碼質量，這就是型別註解的主要作用。總之Java 8 新增加了兩個註解的元素型別ElementType.TYPE_USE 和ElementType.TYPE_PARAMETER ，通過它們，我們可以把註解應用到各種新場合中。

ok~，關於註解暫且聊到這，實際上還有一個大塊的知識點沒詳細聊到，原始碼級註解處理器，這個話題博主打算後面另開一篇分析。

主要參考資料 《Thinking in Java》

如果您喜歡我寫的博文，讀後覺得收穫很大，不妨小額贊助我一下，讓我有動力繼續寫出高質量的博文，感謝您的讚賞！支付寶、微信