java注解詳解.doc

JAVA 注解的幾大作用及使用方法詳解注解（Annotation）1、Annotation的工作原理：JDK5.0中提供了注解的功能，允許開(kāi)發(fā)者定義和使用自己的注解類(lèi)型。該功能由一個(gè)定義注解類(lèi)型的語(yǔ)法和描述一個(gè)注解聲明的語(yǔ)法，讀取注解的API，一個(gè)使用注解修飾的class文件和一個(gè)注解處理工具組成。Annotation并不直接影響代碼的語(yǔ)義，但是他可以被看做是程序的工具或者類(lèi)庫(kù)。它會(huì)反過(guò)來(lái)對(duì)正在運(yùn)行的程序語(yǔ)義有所影響。Annotation可以從源文件、class文件或者在運(yùn)行時(shí)通過(guò)反射機(jī)制多種方式被讀取。常見(jiàn)的作用有以下幾種:1,生成文檔。這是最常見(jiàn)的，也是java 最早提供的注解。常用的有see param return 等2,跟蹤代碼依賴性，實(shí)現(xiàn)替代配置文件功能。比較常見(jiàn)的是spring 2.5 開(kāi)始的基于注解配置。作用就是減少配置?，F(xiàn)在的框架基本都使用了這種配置來(lái)減少配置文件的數(shù)量。3,在編譯時(shí)進(jìn)行格式檢查。如override 放在方法前，如果你這個(gè)方法并不是覆蓋了超類(lèi)方法，則編譯時(shí)就能檢查出。*interface用來(lái)聲明一個(gè)注解，其中的每一個(gè)方法實(shí)際上是聲明了一個(gè)配置參數(shù)。*方法的名稱就是參數(shù)的名稱，返回值類(lèi)型就是參數(shù)的類(lèi)型。*可以通過(guò)default來(lái)聲明參數(shù)的默認(rèn)值。父類(lèi),接口Java.lang.annotation包 java.lang.annotation 中包含所有已定義或自定義注解所需用到的原注解和接口。如接口 java.lang.annotation.Annotation 是所有注解繼承的接口,并且是自動(dòng)繼承，不需要定義時(shí)指定，類(lèi)似于所有類(lèi)都自動(dòng)繼承Object。該包同時(shí)定義了四個(gè)元注解;常見(jiàn)注解Override注解：注釋類(lèi)型 OverrideTarget(value=METHOD)Retention(value=SOURCE)public interface OverrideOverride注解表示子類(lèi)要重寫(xiě)父類(lèi)的對(duì)應(yīng)方法。下面是一個(gè)使用Override注解的例子：class A private String id; A(String id) this.id = id; Override public String toString() return id; Deprecated注解：注釋類(lèi)型 DeprecatedDocumentedRetention(value=RUNTIME)public interface DeprecatedDeprecated注解表示方法是不被建議使用的。下面是一個(gè)使用Deprecated注解的例子：class A private String id; A(String id) this.id = id; Deprecated public void execute() System.out.println(id); public static void main(String args) A a = new A(a123); a.execute(); SuppressWarnings注解：注釋類(lèi)型 SuppressWarningsTarget(value=TYPE,FIELD,METHOD,PARAMETER,CONSTRUCTOR,LOCAL_VARIABLE)Retention(value=SOURCE)public interface SuppressWarnings指示應(yīng)該在注釋元素（以及包含在該注釋元素中的所有程序元素）中取消顯示指定的編譯器警告。注意，在給定元素中取消顯示的警告集是所有包含元素中取消顯示的警告的超集。例如，如果注釋一個(gè)類(lèi)來(lái)取消顯示某個(gè)警告，同時(shí)注釋一個(gè)方法來(lái)取消顯示另一個(gè)警告，那么將在此方法中同時(shí)取消顯示這兩個(gè)警告。下面是一個(gè)使用SuppressWarnings注解的例子：SuppressWarnings(unchecked)public static void main(String args) List list = new ArrayList(); list.add(abc);自定義注解使用interface自定義注解時(shí)，自動(dòng)繼承了java.lang.annotation.Annotation接口，由編譯程序自動(dòng)完成其他細(xì)節(jié)。在定義注解時(shí)，不能繼承其他的注解或接口。1,自定義最簡(jiǎn)單的注解：public interface MyAnnotation 使用自定義注解：public class AnnotationTest2 MyAnnotation public void execute() System.out.println(method); 2,添加變量：public interface MyAnnotation String value1();使用自定義注解：public class AnnotationTest2 MyAnnotation(value1=abc) public void execute() System.out.println(method); 添加默認(rèn)值：public interface MyAnnotation String value1() default abc;3、多變量使用枚舉：public interface MyAnnotation String value1() default abc; MyEnum value2() default MyEnum.Sunny;enum MyEnum Sunny,Rainy使用自定義注解：public class AnnotationTest2 MyAnnotation(value1=a, value2=MyEnum.Sunny) public void execute() System.out.println(method); 4、數(shù)組變量：public interface MyAnnotation String value1() default abc;使用自定義注解：public class AnnotationTest2 MyAnnotation(value1=a,b) public void execute() System.out.println(method); 當(dāng)注解中使用的屬性名為value時(shí)，對(duì)其賦值時(shí)可以不指定屬性的名稱而直接寫(xiě)上屬性值接口；除了value意外的變量名都需要使用name=value的方式賦值。5、限定注解的使用：限定注解使用Target。DocumentedRetention(value=RUNTIME)Target(value=ANNOTATION_TYPE)public interface Target指示注釋類(lèi)型所適用的程序元素的種類(lèi)。如果注釋類(lèi)型聲明中不存在 Target 元注釋，則聲明的類(lèi)型可以用在任一程序元素上。如果存在這樣的元注釋，則編譯器強(qiáng)制實(shí)施指定的使用限制。 例如，此元注釋指示該聲明類(lèi)型是其自身，即元注釋類(lèi)型。它只能用在注釋類(lèi)型聲明上：Target(ElementType.ANNOTATION_TYPE) public interface MetaAnnotationType . 此元注釋指示該聲明類(lèi)型只可作為復(fù)雜注釋類(lèi)型聲明中的成員類(lèi)型使用。它不能直接用于注釋：Target() public interface MemberType . 這是一個(gè)編譯時(shí)錯(cuò)誤，它表明一個(gè) ElementType 常量在 Target 注釋中出現(xiàn)了不只一次。例如，以下元注釋是非法的：Target(ElementType.FIELD, ElementType.METHOD, ElementType.FIELD) public interface Bogus . public enum ElementTypeextends Enum程序元素類(lèi)型。此枚舉類(lèi)型的常量提供了 Java 程序中聲明的元素的簡(jiǎn)單分類(lèi)。這些常量與 Target 元注釋類(lèi)型一起使用，以指定在什么情況下使用注釋類(lèi)型是合法的。ANNOTATION_TYPE注釋類(lèi)型聲明CONSTRUCTOR構(gòu)造方法聲明FIELD字段聲明（包括枚舉常量）LOCAL_VARIABLE局部變量聲明METHOD方法聲明PACKAGE包聲明PARAMETER參數(shù)聲明TYPE類(lèi)、接口（包括注釋類(lèi)型）或枚舉聲明注解的使用限定的例子：Target(ElementType.METHOD)public interface MyAnnotation String value1() default abc;元注解元注解是指注解的注解。包括 Retention Target Document Inherited四種。Target 表示該注解用于什么地方，可能的值在枚舉類(lèi) ElemenetType 中，包括： Target(ElementType.TYPE) /接口、類(lèi)、枚舉、注解Target(ElementType.FIELD) /字段、枚舉的常量Target(ElementType.METHOD) /方法Target(ElementType.PARAMETER) /方法參數(shù)Target(ElementType.CONSTRUCTOR) /構(gòu)造函數(shù)Target(ElementType.LOCAL_VARIABLE)/局部變量Target(ElementType.ANNOTATION_TYPE)/注解 Target(ElementType.PACKAGE) /包 packag注解必須在package-info.java 中聲明Retention 表示在什么級(jí)別保存該注解信息?？蛇x的參數(shù)值在枚舉類(lèi)型 RetentionPolicy 中，包括： Retention(RetentionPolicy.SOURCE) /注解僅存在于源碼中，在class字節(jié)碼文件中不包含 Retention(RetentionPolicy.CLASS) / 默認(rèn)的保留策略，注解會(huì)在class字節(jié)碼文件中存在，但運(yùn)行時(shí)無(wú)法獲得， Retention(RetentionPolicy.RUNTIME) / 注解會(huì)在class字節(jié)碼文件中存在，在運(yùn)行時(shí)可以通過(guò)反射獲取到Documented 將此注解包含在 javadoc 中 ，它代表著此注解會(huì)被javadoc工具提取成文檔。在doc文檔中的內(nèi)容會(huì)因?yàn)榇俗⒔獾男畔?nèi)容不同而不同。相當(dāng)與see,param 等。 Inherited 允許子類(lèi)繼承父類(lèi)中的注解TargetTarget用來(lái)聲明注解可以被添加在哪些類(lèi)型的元素上，如類(lèi)型、方法和域等。 例:Target(TYPE,METHOD,FIELD,CONSTRUCTOR)public interface TestA /這里定義了一個(gè)空的注解。 這個(gè)類(lèi)專門(mén)用來(lái)測(cè)試注解使用TestA /使用了類(lèi)注解public class UserAnnotation TestA /使用了類(lèi)成員注解 private Integer age; TestA /使用了構(gòu)造方法注解 public UserAnnotation() TestA /使用了類(lèi)方法注解 public void a() TestA /使用了局部變量注解 Map m = new HashMap(0); TestA /使用了方法參數(shù)注解 public void b(TestA Integer a) RetentionRetention用來(lái)聲明注解的保留策略，有CLASS、RUNTIME和SOURCE這三種，分別表示注解保存在類(lèi)文件、JVM運(yùn)行時(shí)刻和源代碼中。只有當(dāng)聲明為RUNTIME的時(shí)候，才能夠在運(yùn)行時(shí)刻通過(guò)反射API來(lái)獲取到注解的信息。無(wú)屬性注解Retention 參數(shù) RetentionPolicy。這個(gè)注解還沒(méi)有特殊的屬性值。 簡(jiǎn)單演示下如何使用： import java.lang.annotation.ElementType;import java.lang.annotation.Target;/* * 定義注解 Test * 首先使用ElementType.TYPE(需要在package-info.java中聲明)* 運(yùn)行級(jí)別定為 運(yùn)行時(shí)，以便后面測(cè)試解析 */ Target(ElementType.TYPE)Retention(RetentionPolicy.RUNTIME)public interface TestA 有屬性注解interface用來(lái)聲明一個(gè)注解，其中的每一個(gè)方法實(shí)際上是聲明了一個(gè)配置參數(shù)。方法的名稱就是參數(shù)的名稱，返回值類(lèi)型就是參數(shù)的類(lèi)型（返回值類(lèi)型只能是基本類(lèi)型、Class、String、enum）。可以通過(guò)default來(lái)聲明參數(shù)的默認(rèn)值。代碼：/* * 定義注解 Test * 為方便測(cè)試：注解目標(biāo)為類(lèi) 方法，屬性及構(gòu)造方法 * 注解中含有三個(gè)元素 id ,name和 gid; * id 元素 有默認(rèn)值 0*/ Target(TYPE,METHOD,FIELD,CONSTRUCTOR)Retention(RetentionPolicy.RUNTIME)public interface TestA String name();int id() default 0;Class gid();測(cè)試類(lèi)import java.util.HashMap;import java.util.Map; /* 這個(gè)類(lèi)專門(mén)用來(lái)測(cè)試注解使用*/ TestA(name=type,gid=Long.class) /類(lèi)成員注解public class UserAnnotation TestA(name=param,id=1,gid=Long.class) /類(lèi)成員注解private Integer age;TestA (name=construct,id=2,gid=Long.class)/構(gòu)造方法注解public UserAnnotation()TestA(name=public method,id=3,gid=Long.class) /類(lèi)方法注解public void a()Map m = new HashMap(0);TestA(name=protected method,id=4,gid=Long.class) /類(lèi)方法注解protected void b()Map m = new HashMap(0);TestA(name=private method,id=5,gid=Long.class) /類(lèi)方法注解private void c()Map m = new HashMap(0);public void b(Integer a) 讀取定義注解內(nèi)容import java.lang.annotation.Annotation;import java.lang.reflect.Constructor;import java.lang.reflect.Method; public class ParseAnnotation /*A 簡(jiǎn)單打印出UserAnnotation 類(lèi)中所使用到的類(lèi)注解* 該方法只打印了 Type 類(lèi)型的注解* throws ClassNotFoundException*/public static void parseTypeAnnotation() throws ClassNotFoundException Class clazz = Class.forName(com.tmser.annotation.UserAnnotation); Annotation annotations = clazz.getAnnotations(); for (Annotation annotation : annotations) TestA testA = (TestA)annotation;System.out.println(id= +testA.id()+; name= +testA.name()+; gid = +testA.gid(); /結(jié)果為id=0;name=type;gid =classjava.lang.Long/* B簡(jiǎn)單打印出UserAnnotation 類(lèi)中所使用到的方法注解* 該方法只打印了 Method 類(lèi)型的注解* throws ClassNotFoundException*/public static void parseMethodAnnotation()Method methods = UserAnnotation.class.getDeclaredMethods(); for (Method method : methods) / 判斷方法中是否有指定注解類(lèi)型的注解 boolean hasAnnotation = method.isAnnotationPresent(TestA.class); if (hasAnnotation) /根據(jù)注解類(lèi)型返回方法的指定類(lèi)型注解 TestA annotation = method.getAnnotation(TestA.class); System.out.println(method = + method.getName() + ; id = + annotation.id() + ; description = + () + ; gid= +annotation.gid(); method = c ; id = 5 ; description = private method; gid= class java.lang.Longmethod = a ; id = 3 ; description = public method; gid= class java.lang.Longmethod = b ; id = 4 ; description = protected method; gid= class java.lang.Long/* C簡(jiǎn)單打印出UserAnnotation 類(lèi)中所使用到的構(gòu)造方法注解* 該方法只打印了 Method 類(lèi)型的注解* throws ClassNotFoundException*/public static void parseConstructAnnotation()Constructor constructors = UserAnnotation.class.getConstructors(); for (Constructor constructor : constructors) /判斷構(gòu)造方法中是否有指定注解類(lèi)型的注解 boolean hasAnnotation = constructor.isAnnotationPresent(TestA.class); if (hasAnnotation) /根據(jù)注解類(lèi)型返回方法的指定類(lèi)型注解 TestA annotation =(TestA) constructor.getAnnotation(TestA.class); System.out.println(constructor = + constructor.getName() + ; id = + annotation.id() + ; description = + () + ; gid= +annotation.gid(); constructor=com.tmser.annotation.UserAnnotation;id=2;description =construct;gid=classjava.lang.Longpublic static void main(String args) throws ClassNotFoundException parseTypeAnnotation();parseMethodAnnotation();parseConstructAnnotation();/field是一樣的,省略之Documented 在幫助文檔中加入注解：要想在制作JavaDoc文件的同時(shí)將注解信息加入到API文件中，可以使用java.lang.annotation.Documented。在自定義注解中聲明構(gòu)建注解文檔：Documentedpublic interface MyAnnotation String value1() default abc;使用自定義注解：public class AnnotationTest2 MyAnnotation(value1=a,b) public void execute() System.out.println(method); Inherited 在注解中使用繼承：默認(rèn)情況下注解并不會(huì)被繼承到子類(lèi)中，可以在自定義注解時(shí)加上java.lang.annotation.Inherited注解聲明使用繼承。DocumentedRetention(value=RUNTIME)Target(value=ANNOTATION_TYPE)public interface Inherited指示注釋類(lèi)型被自動(dòng)繼承。如果在注釋類(lèi)型聲明中存在 Inherited 元注釋，并且用戶在某一類(lèi)聲明中查詢?cè)撟⑨岊?lèi)型，同時(shí)該類(lèi)聲明中沒(méi)有此類(lèi)型的注釋，則將在該類(lèi)的超類(lèi)中自動(dòng)查詢?cè)撟⑨岊?lèi)型。此過(guò)程會(huì)重復(fù)進(jìn)行，直到找到此類(lèi)型的注釋或到達(dá)了該類(lèi)層次結(jié)構(gòu)的頂層 (Object) 為止。如果沒(méi)有超類(lèi)具有該類(lèi)型的注釋，則查詢將指示當(dāng)前類(lèi)沒(méi)有這樣的注釋。注意，如果使用注釋類(lèi)型注釋類(lèi)以外的任何事物，此元注釋類(lèi)型都是無(wú)效的。還要注意，此元注釋僅促成從超類(lèi)繼承注釋；對(duì)已實(shí)現(xiàn)接口的注釋無(wú)效。自定義注解案例實(shí)例1:下面是使用反射讀取RUNTIME保留策略的Annotation信息的例子：自定義注解：Retention(RetentionPolicy.RUNTIME)public interface MyAnnotation String value1() default abc;使用自定義注解：public class AnnotationTest2 MyAnnotation(value1=a,b) Deprecated public void execute() System.out.println(method); 讀取注解中的信息：public static void main(String args) throws SecurityException, NoSuchMethodException, IllegalArgumentException, IllegalAccessException, InvocationTargetException AnnotationTest2 annotationTest2 = new AnnotationTest2(); /獲取AnnotationTest2的Class實(shí)例 Class c = AnnotationTest2.class; /獲取需要處理的方法Method實(shí)例 Method method = c.getMethod(execute, new Class); /判斷該方法是否包含MyAnnotation注解 if(method.isAnnotationPresent(MyAnnotation.class) /獲取該方法的MyAnnotation注解實(shí)例 MyAnnotation myAnnotation = method.getAnnotation(MyAnnotation.class); /執(zhí)行該方法 method.invoke(annotationTest2, new Object); /獲取myAnnotation String value1 = myAnnotation.value1(); System.out.println(value10); /獲取方法上的所有注解 Annotation annotations = method.getAnnotations(); for(Annotation annotation : annotations) System.out.println(annotation); 實(shí)例2:DocumentedTarget(ElementType.TYPE,ElementType.METHOD)Retention(RetentionPolicy.RUNTIME)public interface Yts public enum YtsTypeutil,entity,service,model; public YtsType classType() default YtsType.util;Documented Retention(RetentionPolicy.RUNTIME) Target(ElementType.METHOD) Inherited public interface HelloWorld public String name()default ; public class ParseAnnotation public void parseMethod(Class clazz) throws IllegalArgumentException, IllegalAccessException,InvocationTargetException,SecurityException, NoSuchMethodException, InstantiationException Object obj = clazz.getConstructor(new Class).newInstance(new Object); for(Method method : clazz.getDeclaredMethods() HelloWorld say = method.getAnnotation(HelloWorld.class); String name = ; if(say != nul