Java基礎：註解Annotation

時間  2019-11-26
標籤 java 基礎 註解 annotation 欄目 Java 简体版
原文   原文鏈接

從JDK5開始，Java增長了Annotation(註解)，Annotation是代碼裏的特殊標記，這些標記能夠在編譯、類加載、運行時被讀取，並執行相應的處理。經過使用Annotation，開發人員能夠在不改變原有邏輯的狀況下，在源文件中嵌入一些補充的信息。代碼分析工具、開發工具和部署工具能夠經過這些補充信息進行驗證、處理或者進行部署。html

Annotation提供了一種爲程序元素（包、類、構造器、方法、成員變量、參數、局域變量）設置元數據的方法。Annotation不能運行，它只有成員變量，沒有方法。Annotation跟public、final等修飾符的地位同樣，都是程序元素的一部分，Annotation不能做爲一個程序元素使用。java

1 定義Annotationide

定義新的Annotation類型使用@interface關鍵字（在原有interface關鍵字前增長@符號）。定義一個新的Annotation類型與定義一個接口很像，例如：工具

public @interface Test{
}

定義完該Annotation後，就能夠在程序中使用該Annotation。使用Annotation，很是相似於public、final這樣的修飾符，一般，會把Annotation另放一行，而且放在全部修飾符以前。例如：開發工具

@Test
public class MyClass{
....
}

1.1 成員變量測試

Annotation只有成員變量，沒有方法。Annotation的成員變量在Annotation定義中以「無形參的方法」形式來聲明，其方法名定義了該成員變量的名字，其返回值定義了該成員變量的類型。例如：spa

public @interface MyTag{
    string name();
    int age();
}

示例中定義了2個成員變量，這2個成員變量以方法的形式來定義。.net

一旦在Annotation裏定義了成員變量後，使用該Annotation時就應該爲該Annotation的成員變量指定值。例如：code

public class Test{
    @MyTag(name="紅薯"，age=30)
    public void info(){
    ......
    }
}

也能夠在定義Annotation的成員變量時，爲其指定默認值，指定成員變量默認值使用default關鍵字。示例：orm

public @interface MyTag{
    string name() default "我蘭";
    int age() default 18;
}

若是Annotation的成員變量已經指定了默認值，使用該Annotation時能夠不爲這些成員變量指定值，而是直接使用默認值。例如：

public class Test{
    @MyTag
    public void info(){
    ......
    }
}

根據Annotation是否包含成員變量，能夠把Annotation分爲以下兩類：

  • 標記Annotation：沒有成員變量的Annotation被稱爲標記。這種Annotation僅用自身的存在與否來爲咱們提供信息，例如@override等。

  • 元數據Annotation：包含成員變量的Annotation。由於它們能夠接受更多的元數據，所以被稱爲元數據Annotation。

1.2 元註解

在定義Annotation時，也可使用JDK提供的元註解來修飾Annotation定義。JDK提供了以下4個元註解（註解的註解，不是上述的」元數據Annotation「）：

  • @Retention

  • @Target

  • @Documented

  • @Inherited

1.2.1 @Retention

@Retention用於指定Annotation能夠保留多長時間。

@Retention包含一個名爲「value」的成員變量，該value成員變量是RetentionPolicy枚舉類型。使用@Retention時，必須爲其value指定值。value成員變量的值只能是以下3個：

  • RetentionPolicy.SOURCE：Annotation只保留在源代碼中，編譯器編譯時，直接丟棄這種Annotation。

  • RetentionPolicy.CLASS：編譯器把Annotation記錄在class文件中。當運行Java程序時，JVM中再也不保留該Annotation。

  • RetentionPolicy.RUNTIME：編譯器把Annotation記錄在class文件中。當運行Java程序時，JVM會保留該Annotation，程序能夠經過反射獲取該Annotation的信息。

示例：

package com.demo1;
 
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
 
//name=value形式
//@Retention(value=RetentionPolicy.RUNTIME)
 
//直接指定
@Retention(RetentionPolicy.RUNTIME)
public @interface MyTag{
    String name() default "我蘭";
}

若是Annotation裏有一個名爲「value「的成員變量，使用該Annotation時，能夠直接使用XXX(val)形式爲value成員變量賦值，無須使用name=val形式。

1.2.2 @Target

@Target指定Annotation用於修飾哪些程序元素。@Target也包含一個名爲」value「的成員變量，該value成員變量類型爲ElementType[ ]，ElementType爲枚舉類型，值有以下幾個：

  • ElementType.TYPE：能修飾類、接口或枚舉類型

  • ElementType.FIELD：能修飾成員變量

  • ElementType.METHOD：能修飾方法

  • ElementType.PARAMETER：能修飾參數

  • ElementType.CONSTRUCTOR：能修飾構造器

  • ElementType.LOCAL_VARIABLE：能修飾局部變量

  • ElementType.ANNOTATION_TYPE：能修飾註解

  • ElementType.PACKAGE：能修飾包

示例1（單個ElementType）：

package com.demo1;
 
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
 
@Target(ElementType.FIELD)
public @interface AnnTest {
    String name() default "sunchp";
}

示例2（多個ElementType）：

package com.demo1;
 
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
 
@Target({ ElementType.FIELD, ElementType.METHOD })
public @interface AnnTest {
    String name() default "sunchp";
}

1.2.3 @Documented

若是定義註解A時，使用了@Documented修飾定義，則在用javadoc命令生成API文檔後，全部使用註解A修飾的程序元素，將會包含註解A的說明。

示例：

@Documented
public @interface Testable {
}
public class Test {
    @Testable
    public void info() {
    }
}

1.2.4 @Inherited

@Inherited指定Annotation具備繼承性。

示例：

package com.demo2;
 
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface MyTag{
 
}
package com.demo2;
 
@MyTag
public class Base {
 
}
package com.demo2;
 
//SubClass只是繼承了Base類
//並未直接使用@MyTag註解修飾
public class SubClass extends Base {
    public static void main(String[] args) {
        System.out.println(SubClass.class.isAnnotationPresent(MyTag.class));
    }
}

示例中Base使用@MyTag修飾，SubClass繼承Base，並且沒有直接使用@MyTag修飾，可是由於MyTag定義時，使用了@Inherited修飾，具備了繼承性，因此運行結果爲true。

若是MyTag註解沒有被@Inherited修飾，則運行結果爲：false。

1.3 基本Annotation

JDK默認提供了以下幾個基本Annotation：

  • @Override 

限定重寫父類方法。對於子類中被@Override 修飾的方法，若是存在對應的被重寫的父類方法，則正確；若是不存在，則報錯。@Override 只能做用於方法，不能做用於其餘程序元素。

  • @Deprecated

用於表示某個程序元素（類、方法等）已過期。若是使用被@Deprecated修飾的類或方法等，編譯器會發出警告。

  • @SuppressWarning

抑制編譯器警告。指示被@SuppressWarning修飾的程序元素（以及該程序元素中的全部子元素，例如類以及該類中的方法.....）取消顯示指定的編譯器警告。例如，常見的@SuppressWarning（value="unchecked"）

  • @SafeVarargs

@SafeVarargs是JDK 7 專門爲抑制「堆污染」警告提供的。


2 提取Annotation信息（反射）

當開發者使用了Annotation修飾了類、方法、Field等成員以後，這些Annotation不會本身生效，必須由開發者提供相應的代碼來提取並處理Annotation信息。這些處理提取和處理Annotation的代碼統稱爲APT（Annotation Processing Tool）。

JDK主要提供了兩個類，來完成Annotation的提取：

  • java.lang.annotation.Annotation接口：這個接口是全部Annotation類型的父接口（後面會分析Annotation的本質，Annotation本質是接口，而java.lang.annotation.Annotation接口是這些接口的父接口）。

  • java.lang.reflect.AnnotatedElement接口：該接口表明程序中能夠被註解的程序元素。

2.1 java.lang.annotation.Annotation

java.lang.annotation.Annotation接口源碼:

package java.lang.annotation;
 
public interface Annotation {
 
    boolean equals(Object obj);
 
    int hashCode();
 
    String toString();
 
    Class<? extends Annotation> annotationType();
}

java.lang.annotation.Annotation接口的主要方法是annotationType( )，用於返回該註解的java.lang.Class。

2.2 java.lang.reflect.AnnotatedElement

java.lang.reflect.AnnotatedElement接口源碼：

package java.lang.reflect;
 
import java.lang.annotation.Annotation;
 
public interface AnnotatedElement {
 
     boolean isAnnotationPresent(Class<? extends Annotation> annotationClass);
 
    <T extends Annotation> T getAnnotation(Class<T> annotationClass);
 
    Annotation[] getAnnotations();
 
    Annotation[] getDeclaredAnnotations();
}

主要方法有：

  • isAnnotationPresent(Class<? extends Annotation> annotationClass)：判斷該程序元素上是否存在指定類型的註解，若是存在則返回true，不然返回false。

  • getAnnotation(Class<T> annotationClass)：返回該程序元素上存在的指定類型的註解，若是該類型的註解不存在，則返回null

  • Annotation[] getAnnotations()：返回該程序元素上存在的全部註解。

java.lang.reflect.AnnotatedElement接口是全部程序元素（例如java.lang.Class、java.lang.reflect.Method、java.lang.reflect.Constructor等）的父接口。類圖結構以下：

因此程序經過反射獲取了某個類的AnnotatedElement對象（例如，A類method1()方法的java.lang.reflect.Method對象）後，就能夠調用該對象的isAnnotationPresent( )、getAnnotation( )等方法來訪問註解信息。

爲了獲取註解信息，必須使用反射知識。

PS：若是想要在運行時提取註解信息，在定義註解時，該註解必須使用@Retention(RetentionPolicy.RUNTIME)修飾。

2.3 示例

2.3.1 標記Annotation

給定一個類的全額限定名，加載類，並列出該類中被註解@MyTag修飾的方法和沒被修飾的方法。

註解定義：

package com.demo1;
 
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 MyTag {
 
}

註解處理：

package com.demo1;
 
import java.lang.reflect.Method;
 
public class ProcessTool {
    public static void process(String clazz) {
        Class targetClass = null;
 
        try {
            targetClass = Class.forName(clazz);
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        }
 
        for (Method m : targetClass.getMethods()) {
            if (m.isAnnotationPresent(MyTag.class)) {
                System.out.println("被MyTag註解修飾的方法名：" + m.getName());
            } else {
                System.out.println("沒被MyTag註解修飾的方法名：" + m.getName());
            }
        }
    }
}

測試類：

package com.demo1;
 
public class Demo {
    public static void m1() {
 
    }
 
    @MyTag
    public static void m2() {
 
    }
}
package com.demo1;
 
public class Test {
 
    public static void main(String[] args) {
        ProcessTool.process("com.demo1.Demo");
    }
}

運行結果：

沒被MyTag註解修飾的方法名：m1
被MyTag註解修飾的方法名：m2
沒被MyTag註解修飾的方法名：wait
沒被MyTag註解修飾的方法名：wait
沒被MyTag註解修飾的方法名：wait
沒被MyTag註解修飾的方法名：equals
沒被MyTag註解修飾的方法名：toString
沒被MyTag註解修飾的方法名：hashCode
沒被MyTag註解修飾的方法名：getClass
沒被MyTag註解修飾的方法名：notify
沒被MyTag註解修飾的方法名：notifyAll

2.3.2 元數據Annotation

給定一個類的全額限定名，加載類，找出被註解MyTag修飾的方法，並輸出每一個方法的MyTag註解的屬性。

註解定義:

package com.demo1;
 
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 MyTag {
    String name() default "我蘭";
 
    int age() default 18;
}

註解處理：

package com.demo1;
 
import java.lang.reflect.Method;
 
public class ProcessTool {
    public static void process(String clazz) {
        Class targetClass = null;
 
        try {
            targetClass = Class.forName(clazz);
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        }
 
        for (Method m : targetClass.getMethods()) {
            if (m.isAnnotationPresent(MyTag.class)) {
                MyTag tag = m.getAnnotation(MyTag.class);
                System.out.println("方法" + m.getName() + "的MyTag註解內容爲：" + tag.name() + "，" + tag.age());
            }
        }
    }
}

測試類：

package com.demo1;
 
public class Demo {
    public static void m1() {
 
    }
 
    @MyTag
    public static void m2() {
 
    }
 
    @MyTag(name = "紅薯")
    public static void m3() {
 
    }
 
    @MyTag(name = "紅薯", age = 30)
    public static void m4() {
 
    }
}
package com.demo1;
 
public class Test {
 
    public static void main(String[] args) {
        ProcessTool.process("com.demo1.Demo");
    }
}

運行結果：

方法m2的MyTag註解內容爲：我蘭，18
方法m3的MyTag註解內容爲：紅薯，18
方法m4的MyTag註解內容爲：紅薯，30

若要獲取註解中的成員變量值，直接調用註解對象的"成員變量民( )"形式的方法就行，例如示例中的tag.name()等。

PS：在編譯器編譯註解定義時，自動在class文件中，添加與成員變量同名的抽象方法，用於反射時獲取成員變量的值。

經過上面的示例能夠看出，其實Annotation十分簡單，它是對源代碼增長的一些特殊標記，這些特殊標記可經過反射獲取，當程序獲取這些特殊標記後，程序能夠作出相應的處理（固然也能夠徹底忽略這些Annotation）。


3 註解本質

對於示例」2.3.2 元數據Annotation「中的MyTag註解，在編譯後，生成一個MyTag.class文件。反編譯該class文件：

javap -verbose -c MyTag.class > m.txt

MyTag註解的字節碼爲：

經過分析字節碼可知：

  • 註解實質上會被編譯器編譯爲接口，而且繼承java.lang.annotation.Annotation接口。

  • 註解的成員變量會被編譯器編譯爲同名的抽象方法。

  • 根據Java的class文件規範，class文件中會在程序元素的屬性位置記錄註解信息。例如，RuntimeVisibleAnnotations屬性位置，記錄修飾該類的註解有哪些；flags屬性位置，記錄該類是否是註解；在方法的AnnotationDefault屬性位置，記錄註解的成員變量默認值是多少。

咱們再反編譯下示例」2.3.2 元數據Annotation「中的Demo測試類，查看下」被註解修飾的方法是怎樣記錄本身被註解修飾的「：

javap -verbose -c Demo.class > d.txt

反編譯結果以下：

經過字節碼可知：

在字節碼文件中，每一個方法都有RuntimeVisibleAnnotations屬性位置，用來放置註解和註解的成員變量賦值。JVM在解析class文件時，會解析RuntimeVisibleAnnotations屬性，並新建相應類型的註解對象，並將成員變量賦值。

若是要明白JVM對註解的運行機制，須要對class文件的格式規範有必定了解。（資料）


4 註解的意義

爲編譯器提供輔助信息 — Annotations能夠爲編譯器提供而外信息，以便於檢測錯誤，抑制警告等.

編譯源代碼時進行而外操做 — 軟件工具能夠經過處理Annotation信息來生成原代碼，xml文件等等.

運行時處理 — 有一些annotation甚至能夠在程序運行時被檢測，使用.

總之，註解是一種元數據，起到了」描述，配置「的做用。

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程