作者: Jakob Jenkov 譯者:葉文海(yewenhai@gmail.com)
利用 Java 反射機(jī)制可以在運(yùn)行期獲取 Java 類的注解信息。
注解是 Java 5 的一個(gè)新特性。注解是插入你代碼中的一種注釋或者說是一種元數(shù)據(jù)(meta data)。這些注解信息可以在編譯期使用預(yù)編譯工具進(jìn)行處理(pre-compiler tools),也可以在運(yùn)行期使用 Java 反射機(jī)制進(jìn)行處理。下面是一個(gè)類注解的例子:
@MyAnnotation(name="someName", value = "Hello World")
public class TheClass {
}
在 TheClass 類定義的上面有一個(gè)@MyAnnotation 的注解。注解的定義與接口的定義相似,下面是MyAnnotation注解的定義:
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface MyAnnotation {
public String name();
public String value();
}
在 interface 前面的@符號表名這是一個(gè)注解,一旦你定義了一個(gè)注解之后你就可以將其應(yīng)用到你的代碼中,就像之前我們的那個(gè)例子那樣。 在注解定義中的兩個(gè)指示@Retention(RetentionPolicy.RUNTIME)和@Target(ElementType.TYPE),說明了這個(gè)注解該如何使用。 @Retention(RetentionPolicy.RUNTIME)表示這個(gè)注解可以在運(yùn)行期通過反射訪問。如果你沒有在注解定義的時(shí)候使用這個(gè)指示那么這個(gè)注解的信息不會保留到運(yùn)行期,這樣反射就無法獲取它的信息。 @Target(ElementType.TYPE) 表示這個(gè)注解只能用在類型上面(比如類跟接口)。你同樣可以把Type改為Field或者M(jìn)ethod,或者你可以不用這個(gè)指示,這樣的話你的注解在類,方法和變量上就都可以使用了。 關(guān)于 Java 注解更詳細(xì)的講解可以訪問 Java Annotations tutorial。
你可以在運(yùn)行期訪問類,方法或者變量的注解信息,下是一個(gè)訪問類注解的例子:
Class aClass = TheClass.class;
Annotation[] annotations = aClass.getAnnotations();
for(Annotation annotation : annotations){
if(annotation instanceof MyAnnotation){
MyAnnotation myAnnotation = (MyAnnotation) annotation;
System.out.println("name: " + myAnnotation.name());
System.out.println("value: " + myAnnotation.value());
}
}
你還可以像下面這樣指定訪問一個(gè)類的注解:
Class aClass = TheClass.class;
Annotation annotation = aClass.getAnnotation(MyAnnotation.class);
if(annotation instanceof MyAnnotation){
MyAnnotation myAnnotation = (MyAnnotation) annotation;
System.out.println("name: " + myAnnotation.name());
System.out.println("value: " + myAnnotation.value());
}
下面是一個(gè)方法注解的例子:
public class TheClass {
@MyAnnotation(name="someName", value = "Hello World")
public void doSomething(){}
}
你可以像這樣訪問方法注解:
Method method = ... //獲取方法對象
Annotation[] annotations = method.getDeclaredAnnotations();
for(Annotation annotation : annotations){
if(annotation instanceof MyAnnotation){
MyAnnotation myAnnotation = (MyAnnotation) annotation;
System.out.println("name: " + myAnnotation.name());
System.out.println("value: " + myAnnotation.value());
}
}
你可以像這樣訪問指定的方法注解:
Method method = ... // 獲取方法對象
Annotation annotation = method.getAnnotation(MyAnnotation.class);
if(annotation instanceof MyAnnotation){
MyAnnotation myAnnotation = (MyAnnotation) annotation;
System.out.println("name: " + myAnnotation.name());
System.out.println("value: " + myAnnotation.value());
}
方法參數(shù)也可以添加注解,就像下面這樣:
public class TheClass {
public static void doSomethingElse(
@MyAnnotation(name="aName", value="aValue") String parameter){
}
}
你可以通過 Method對象來訪問方法參數(shù)注解:
Method method = ... //獲取方法對象
Annotation[][] parameterAnnotations = method.getParameterAnnotations();
Class[] parameterTypes = method.getParameterTypes();
int i=0;
for(Annotation[] annotations : parameterAnnotations){
Class parameterType = parameterTypes[i++];
for(Annotation annotation : annotations){
if(annotation instanceof MyAnnotation){
MyAnnotation myAnnotation = (MyAnnotation) annotation;
System.out.println("param: " + parameterType.getName());
System.out.println("name : " + myAnnotation.name());
System.out.println("value: " + myAnnotation.value());
}
}
}
需要注意的是 Method.getParameterAnnotations()方法返回一個(gè)注解類型的二維數(shù)組,每一個(gè)方法的參數(shù)包含一個(gè)注解數(shù)組。
下面是一個(gè)變量注解的例子:
public class TheClass {
@MyAnnotation(name="someName", value = "Hello World")
public String myField = null;
}
你可以像這樣來訪問變量的注解:
Field field = ... //獲取方法對象</pre>
<pre>Annotation[] annotations = field.getDeclaredAnnotations();
for(Annotation annotation : annotations){
if(annotation instanceof MyAnnotation){
MyAnnotation myAnnotation = (MyAnnotation) annotation;
System.out.println("name: " + myAnnotation.name());
System.out.println("value: " + myAnnotation.value());
}
}
你可以像這樣訪問指定的變量注解:
Field field = ...//獲取方法對象</pre>
<pre>
Annotation annotation = field.getAnnotation(MyAnnotation.class);
if(annotation instanceof MyAnnotation){
MyAnnotation myAnnotation = (MyAnnotation) annotation;
System.out.println("name: " + myAnnotation.name());
System.out.println("value: " + myAnnotation.value());
}
本文鏈接地址: Java Reflection(八):注解