深入理解Java注解類型(@Annotation)

http://blog.csdn.net/javazejian/article/details/71860633
 出自【zejian的博客】

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

• 理解Java注解

• 基本語法

• 聲明注解與元注解

• 注解元素及其數據類型

• 編譯器對默認值的限制

• 注解不支持繼承

• 快捷方式

• Java內置注解與其它元注解

• 注解與反射機制

• 運行時注解處理器

• Java 8中注解增強

• 元注解Repeatable

• 新增的兩種ElementType

理解Java注解

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

public class AnnotationDemo {
    
    @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注解是如何聲明的：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {}

 

我們使用了@interface聲明了Test注解，並使用@Target注解傳入ElementType.METHOD參數來標明@Test只能用於方法上，@Retention(RetentionPolicy.RUNTIME)則用來表示該注解生存期是運行時，從代碼上看注解的定義很像接口的定義，確實如此，畢竟在編譯后也會生成Test.class文件。對於@Target和@Retention是由Java提供的元注解，所謂元注解就是標記其他注解的注解，下面分別介紹

@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值時，則此注解可以用於任何元素之上，多個值使用{}包含並用逗號隔開，如下：

@Retention用來約束注解的生命周期，分別有三個值，源碼級別（source），類文件級別（class）或者運行時級別（runtime），其含有如下：

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

 

• 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

上述類型的數組

倘若使用了其他數據類型，編譯器將會丟出一個編譯錯誤，注意，聲明注解元素時可以使用基本類型但不允許使用任何包裝類型，同時還應該注意到注解也可以作為元素的類型，也就是嵌套注解，下面的代碼演示了上述類型的使用過程：

@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 name()default "";

    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，簡單案例如下

@Target(ElementType.FIELD)@Retention(RetentionPolicy.RUNTIME)
@interface IntegerVaule{
    int value() default 0;
    String name() default "";
}public class QuicklyWay {

    
    @IntegerVaule(20)
    public int age;

    
    @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：關於以上所有情況的警告。

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

@Deprecatedclass A{
    public void A(){ }

    
    @Deprecated()
    public void B(){ }
}

class B extends A{

    @Override 
    public void A() {
        super.A();
    }

    
    @SuppressWarnings({"uncheck","deprecation"})
    public void C(){ } 
    
    @SuppressWarnings("uncheck")
    public void D(){ }
}

 

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

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

@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface DocumentA {}
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface DocumentB {}
@DocumentA
@DocumentB
public class DocumentDemo {
    public void A(){
    }
}

 

使用javadoc命令生成文檔：

如下：

可以發現使用@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 {}
@DocumentAclass A{ }

class B extends A{ }@DocumentBclass 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個類都實現以下的方法

                             

返回值	方法名稱	說明
<A extends Annotation>	getAnnotation(Class<A> annotationClass)	該元素如果存在指定類型的注解，則返回這些注解，否則返回 null。
Annotation[]	getAnnotations()	返回此元素上存在的所有注解，包括從父類繼承的
boolean	isAnnotationPresent(Class<? extends Annotation>  annotationClass)	如果指定類型的注解存在於此元素上，則返回 true，否則返回 false。
Annotation[]	getDeclaredAnnotations()	返回直接存在於此元素上的所有注解，注意，不包括父類的注解，調用者可以隨意修改返回的數組；這不會對其他調用者返回的數組產生任何影響，沒有則返回長度為0的數組

簡單案例演示如下：

@DocumentAclass A{ }
@DocumentBpublic 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));

        
        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 "";

    
    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;
    
    boolean allowNull() default false;
    
    boolean unique() default false;
}/**
 * Created by wuzejian on 2017/5/18.
 * 數據庫表Member對應實例類bean
 */@DBTable(name = "MEMBER")public class Member {
    
    @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;

   
}

 

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

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(tableName.length() < 1)
      tableName = cl.getName().toUpperCase();
    List<String> columnDefs = new ArrayList<String>();
    
    for(Field field : cl.getDeclaredFields()) {
      String columnName = null;
      
      Annotation[] anns = field.getDeclaredAnnotations();
      if(anns.length < 1)
        continue; 

      
      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()));
      }
      
      if(anns[0] instanceof SQLString) {
        SQLString sString = (SQLString) anns[0];
        
        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 + ",");

    
    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新加入的，它表示在同一個位置重復相同的注解。在沒有該注解前，一般是無法在同一個類型上使用相同的注解的

@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.
 */
@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/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的話，仍然無法獲取。下面通過代碼來演示：

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;
        
        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注解

public @interface FilterPath {

    String  value();
}@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Inherited @interface FilterPaths {
    FilterPath[] value();
}@FilterPath("/web/list")@FilterPath("/web/getList")class CC { }class AA extends CC{
    public static void main(String[] args) {

        Class<?> clazz = AA.class;
        
        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) {

T[] result = getDeclaredAnnotationsByType(annotationClass);if (result.length == 0 && this instanceof Class && 

 AnnotationType.getInstance(annotationClass).isInherited()) { 
        
       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)。如下所示

class D<@Parameter T> { }
class Image implements @Rectangular Shape { }
new @Path String("/usr/bin")


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 
import java.lang.@NotNull String

 

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

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

 主要參考資料 《Thinking in Java》