注解

注解（Annotation）是JDK1.5引入的新特性，包含在java.lang.annotation包中，它是附加在代碼中的一些元信息，將一個(gè)類的外部信息與內(nèi)部成員聯(lián)系起來(lái)，在編 譯、運(yùn)行時(shí)進(jìn)行解析和使用。

Java內(nèi)置了一些注解（如@Override、@Deprecated等），還支持自定義注解，一些知名的框架 Struts、Hibernate、Spring都有自己實(shí)現(xiàn)的自定義注解，也可以自己定義注解供使用。

Annotation十分類似public、final這樣的修飾符。每個(gè)Annotation具有一個(gè)名字和成員個(gè)數(shù)>=0。

每個(gè)Annotation的成員具有被稱為name=value對(duì)的名字和值（就像javabean一樣），name=value裝載了Annotation的信息。

Annotation類(java.lang.reflect.Annotation)：

Annotation類型定義了Annotation的名字、類型、成員默認(rèn)值。一個(gè)Annotation類型可以說(shuō)是一個(gè)特殊的java接口，它的成員變量是受限制的，而聲明Annotation類型時(shí)需要使用新語(yǔ)法。當(dāng)我們通過(guò)java反射api訪問(wèn)Annotation時(shí)，返回值將是一個(gè)實(shí)現(xiàn)了該 annotation類型接口的對(duì)象，通過(guò)訪問(wèn)這個(gè)對(duì)象我們能方便的訪問(wèn)到其Annotation成員。后面的章節(jié)將提到在java5.0的 java.lang包里包含的3個(gè)標(biāo)準(zhǔn)Annotation類型。其子類如下圖所示：

注解處理器類庫(kù)(java.lang.reflect.AnnotatedElement)：

Java使用Annotation接口來(lái)代表程序元素前面的注解，該接口是所有Annotation類型的父接口。除此之外，Java在java.lang.reflect 包下新增了AnnotatedElement接口，該接口代表程序中可以接受注解的程序元素，該接口主要有如下幾個(gè)實(shí)現(xiàn)類：

• Class：類定義
• Constructor：構(gòu)造器定義
• Field：累的成員變量定義
• Method：類的方法定義
• Package：類的包定義

java.lang.reflect 包下主要包含一些實(shí)現(xiàn)反射功能的工具類，實(shí)際上，java.lang.reflect 包所有提供的反射API擴(kuò)充了讀取運(yùn)行時(shí)Annotation信息的能力。當(dāng)一個(gè)Annotation類型被定義為運(yùn)行時(shí)的Annotation后，該注解才能是運(yùn)行時(shí)可見(jiàn)，當(dāng)class文件被裝載時(shí)被保存在class文件中的Annotation才會(huì)被虛擬機(jī)讀取。

AnnotatedElement 接口是所有程序元素（Class、Method和Constructor）的父接口，所以程序通過(guò)反射獲取了某個(gè)類的AnnotatedElement對(duì)象之后，程序就可以調(diào)用該對(duì)象的如下四個(gè)個(gè)方法來(lái)訪問(wèn)Annotation信息：

方法1：<T extends Annotation> T getAnnotation(Class<T> annotationClass): 返回改程序元素上存在的、指定類型的注解，如果該類型注解不存在，則返回null。

方法2：Annotation[] getAnnotations():返回該程序元素上存在的所有注解。

方法3：boolean is AnnotationPresent(Class<?extends Annotation> annotationClass):判斷該程序元素上是否包含指定類型的注解，存在則返回true，否則返回false.

方法4：Annotation[] getDeclaredAnnotations()：返回直接存在于此元素上的所有注釋。與此接口中的其他方法不同，該方法將忽略繼承的注釋。（如果沒(méi)有注釋直接存在于此元素上，則返回長(zhǎng)度為零的一個(gè)數(shù)組。）該方法的調(diào)用者可以隨意修改返回的數(shù)組；這不會(huì)對(duì)其他調(diào)用者返回的數(shù)組產(chǎn)生任何影響。

注解類型

注解的一般格式是[修飾符] @interface [名稱]{元素}， 元素是無(wú)方法體的方法聲明，可以有默認(rèn)值，如@Target的注解如下所示：

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

元注解的作用就是負(fù)責(zé)注解其他注解。Java5.0定義了4個(gè)標(biāo)準(zhǔn)的meta-annotation類型，它們被用來(lái)提供對(duì)其它 annotation類型作說(shuō)明。

Java5.0定義的元注解：

1.@Target,

2.@Retention,

3.@Documented,

4.@Inherited這些類型和它們所支持的類在java.lang.annotation包中可以找到。

下面我們看一下每個(gè)元注解的作用和相應(yīng)分參數(shù)的使用說(shuō)明。

@Target：

@Target說(shuō)明了Annotation所修飾的對(duì)象范圍：Annotation可被用于 packages、types（類、接口、枚舉、Annotation類型）、類型成員（方法、構(gòu)造方法、成員變量、枚舉值）、方法參數(shù)和本地變量（如循環(huán)變量、catch參數(shù)）。在Annotation類型的聲明中使用了target可更加明晰其修飾的目標(biāo)。

作用：用于描述注解的使用范圍（即：被描述的注解可以用在什么地方）

取值(ElementType)是來(lái)源于Java.lang.annotation.ElementType中的枚舉類型元素：

1.CONSTRUCTOR:用于描述構(gòu)造器

2.FIELD:用于描述域

3.LOCAL_VARIABLE:用于描述局部變量

4.METHOD:用于描述方法

5.PACKAGE:用于描述包

6.PARAMETER:用于描述參數(shù)

7.TYPE:用于描述類、接口(包括注解類型) 或enum聲明

@Retention：

@Retention定義了該Annotation被保留的時(shí)間長(zhǎng)短：某些Annotation僅出現(xiàn)在源代碼中，而被編譯器丟棄；而另一些卻被編譯在class文件中；編譯在class文件中的Annotation可能會(huì)被虛擬機(jī)忽略，而另一些在class被裝載時(shí)將被讀?。ㄕ?qǐng)注意并不影響class的執(zhí)行，因?yàn)锳nnotation與class在使用上是被分離的）。使用這個(gè)meta-Annotation可以對(duì) Annotation的“生命周期”限制。

作用：表示需要在什么級(jí)別保存該注釋信息，用于描述注解的生命周期（即：被描述的注解在什么范圍內(nèi)有效）

取值（RetentionPoicy）來(lái)源于java.lang.annotation.RetentionPolicy的枚舉類型值：

1.SOURCE:在源文件中有效（即源文件保留）

2.CLASS:在class文件中有效（即class保留）

3.RUNTIME:在運(yùn)行時(shí)有效（即運(yùn)行時(shí)保留）

@Documented:

@Documented用于描述其它類型的annotation應(yīng)該被作為被標(biāo)注的程序成員的公共API，因此可以被例如javadoc此類的工具文檔化。

Documented是一個(gè)標(biāo)記注解，沒(méi)有成員。

@Inherited：

@Inherited 元注解是一個(gè)標(biāo)記注解，@Inherited闡述了某個(gè)被標(biāo)注的類型是被繼承的。如果一個(gè)使用了@Inherited修飾的annotation類型被用于一個(gè)class，則這個(gè)annotation將被用于該class的子類。

注意：@Inherited annotation類型是被標(biāo)注過(guò)的class的子類所繼承。類并不從它所實(shí)現(xiàn)的接口繼承annotation，方法并不從它所重載的方法繼承annotation。

當(dāng)@Inherited annotation類型標(biāo)注的annotation的Retention是RetentionPolicy.RUNTIME，則反射API增強(qiáng)了這種繼承性。

如果我們使用java.lang.reflect去查詢一個(gè)@Inherited annotation類型的annotation時(shí)，反射代碼檢查將展開(kāi)工作：檢查class和其父類，直到發(fā)現(xiàn)指定的annotation類型被發(fā)現(xiàn)，或者到達(dá)類繼承結(jié)構(gòu)的頂層。

注解實(shí)現(xiàn)實(shí)例

實(shí)現(xiàn)注解需要三個(gè)條件：注解聲明、使用注解的元素、操作注解使其起作用(注解處理器)。

定一個(gè)MyTag注解類：

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.METHOD,ElementType.FIELD})
@Inherited
@Retention(RetentionPolicy.RUNTIME)
public @interface MyTag {
	String name() default "車";
	int size() default 10;
}

定義一個(gè)實(shí)體Car類：

public class Car {
	private String name;
	private int size;
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	public int getSize() {
		return size;
	}
	public void setSize(int size) {
		this.size = size;
	}
	public Car(){
	}
	public Car(String name, int size){
		this.size = size;
		this.name = name;
	}
	@Override
	public String toString() {
		return "Car [name=" + name + ", size=" + size + "]";
	}
}

定義一個(gè)使用注解的類AnnotationDemo類：

public class AnnotationDemo{
	@MyTag(name = "audi", size = 10)
	private Car car;
	public Car getCar() {
		return car;
	}
	public void setCar(Car car) {
		this.car = car;
	}
	@Override
	public String toString() {
		return "Annotation [car=" + car + "]";
	}
}

定義一個(gè)操作注解即讓注解起作用的類AnnotationProccessor類：

import java.lang.reflect.Field;
public class AnnotationProccessor {
	public  static void annoProcess(AnnotationDemo annotation){
		for(Field field : annotation.getClass().getDeclaredFields()){
			if(field.isAnnotationPresent(MyTag.class)){  //如果存在MyTag標(biāo)簽
				MyTag myTag = field.getAnnotation(MyTag.class);
				annotation.setCar(new Car(myTag.name(),myTag.size()));
			}
		}
	}
	public static void main(String[] args) {
		AnnotationDemo ann = new AnnotationDemo();
		annoProcess(ann);
		System.out.println(ann.getCar());
	}
}

到此這篇關(guān)于Java的注解原理詳解的文章就介紹到這了,更多相關(guān)Java注解原理內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論