获得一个类上的注解

JavaChen — Thu, 16 Sep 2010 12:58:15 +0000

假定有这样一个注解类，如何获得一个类上标注有这个注解的注解内容，比如说value值？

package com.javachen.annotations;
 
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
@Target( { java.lang.annotation.ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Alias {
	public abstract String[] value();
}

咱们可以这样做，通过Class的isAnnotationPresent这个方法可以判断某一个类是否有某一个注解，如果存在，则可以用getAnnotation方法获得该注解，接下来就可以对该注解进行操作，如获得该注解中的属性值。下面的方法，采用了for循环对某一个类从本类到父类遍历是否注有某一个注解.

^?View Code JAVA

package com.javachen.annotations;
 
import java.util.HashSet;
import java.util.Set;
 
public class AliasUtil {
	public static Set< string> getAlias(Class< ?> clazz) {
		assert (clazz != null);
		Set< string> result = new HashSet< string>();
 
		for (Class< ?> superClass = clazz; superClass != Object.class; superClass = 
                      superClass.getSuperclass()) {
			if (superClass.isAnnotationPresent(Alias.class)) {
				Alias alias = superClass.getAnnotation(Alias.class);
				String[] value = alias.value();
				if (value == null)
					break;
				for (String v : value) {
					if (v != null) {
						String s = v.trim();
						if (s.length() == 0)
							continue;
						if (result.contains(s))
							continue;
						result.add(s);
					}
				}
				break;
			}
		}
 
		return result;
	}
}

Here is no comments yet by the time your rss reader get this, Do you want to be the first commentor? Hurry up

Java5中的注释Annotation

JavaChen — Fri, 29 Jan 2010 02:11:43 +0000

注释是java5中的新特性，谈到注释，先的谈谈Java元数据（metadata）。元数据，就是“关于数据的数据”。Java元数据有3种基本类型，还有3个Java内置注释类型，另外还有4中元注释类型。你可能用过Javadoc的注释自动生成文档。这就是元数据功能的一种。总的来说，元数据可以用来创建文档，跟踪代码的依赖性，执行编译时格式检查，代替已有的配置文件（如Hibernate也提供了注释配置）。

注释有3中基本类型
a.标记注释 –没有变量，只有名称标识。例如 @annotation
b.单一值注释 –在标记注释的基础上提供一段数据。如 @annotation（“javachen”）
c.完整注释 –可以包括多个数据成员，每个数据成员由名称和值构成。@annotation(site=”www.javachen.com”,author=”javachen”)

Java中提供3个内置注释类型
a. Override ，只能用于方法（不能用于类，包声明或者其他构造）
作用：可以保证编译时候Override函数的声明正确性
用法：
@Override
public void fun(){..}

b.Deprecated 同样只能作用与方法
作用：对不应再使用的方法进行注解
用法：@Deprecated public void fun{…}

c.SupressWarnings 可以注释一段代码
作用：关闭特定的警告信息，例如你在使用泛型的时候未指定类型
用法： @SupressWarnings(value={“unchecked”})

Java中还提供了四种元注释，专门负责注释其他的注释

@Target 表示该注释可以用于什么地方。可用的ElementType参数包括：
CONSTRUCTOR : 构造器的声明
FIELD : 域声明（包括enum实例）
LOCAL_VARIABLE : 局部变量声明
METHOD : 方法声明
PACKAGE : 包声明
PARAMETER : 参数声明
TYPE : 类、接口（包括注解类型) 或enum声明

@Retention 表示需要在什么级别保存该注释信息。可选的RetentionPoicy参数包括：
SOURCE : 注释将被编译器丢掉
CLASS : 注释在class文件中可用，但会被VM丢弃
RUNTIME : VM将在运行时也保留注释，因此可以通过反射机制读取注释的信息。

@Documented 将注释包含在JavaDoc中
@Inheried 允许子类继承父类中的注释。

在Java中定义自己的注释

Java语言支持一种新的类型——注释类型（annotation type），跟普通类差不多，在类中以符号（ @ ）的形式注释其他 Java 代码，用@interface 申明自定义注释类型。

^?View Code JAVA

package com.javachen.annotation;
 
import java.lang.annotation.Documented;
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;
 
/**
 * 用户自定义标签,带有成员变量的MyTag
 */
@Documented //将注释包含在JavaDoc中
@Inherited //允许子类继承父类中的注释。
@Target(value = {ElementType.METHOD,ElementType.CONSTRUCTOR})//标注这个注释使用的范围
@Retention(value = RetentionPolicy.RUNTIME)//要想使用反射得到注释信息，这个注释必须使用
public @interface MyTag {
	String name()  default "javachen";//给自定义注释类的成员加上默认值
	int age()  default 24;
}

注意：在自定义注释中只有一个成员时，方法名应该为value
使用标签最终是为了帮助开发人员提取注释信息，然后根据不同需求做进一步处理，下面我们来看看如何获取注释信息。

^?View Code JAVA

package com.javachen.annotation;
 
import java.lang.annotation.Annotation;
 
public class TagTest {
	@MyTag(name = "MyTag", age = 1)
	public void test() {
	}
 
	@Override //可以保证编译时候Override函数的声明正确性
	public String toString() {
		return super.toString();
	}
 
	@Deprecated //对不应再使用的方法进行注解
	public String notToUse() {
		return super.toString();
	}
 
	public static void main(String[] args) {
		TagTest tt = new TagTest();
		try {
			Annotation[] annotation = tt.getClass().getMethod("test")
					.getAnnotations();
			for (Annotation tag : annotation) {
				System.out.println("Tag is:" + tag);
				System.out.println("tag.name()" + ((MyTag) tag).name());
				System.out.println("tag.age()" + ((MyTag) (tag)).age());
			}
		} catch (NoSuchMethodException e) {
			e.printStackTrace();
		}
	}
}

需要注意的一点是，在执行这段代码之前我们还有一点小工作要做，还需要给我们的自定义标签MyTag加上一个说明标签，@ Retention, 表明注释信息将可以在运行时刻通过反射机制得到。如果不加入这个标签，上面的代码将没有任何输出。

如何使用反射读取注释

在以前的JDK版本中，我们可以使用反射得到类的方法、方法的参数以及其它的类成员等信息。那么在J2SE5.0中同样也可以象方法一样得到注释的各种信息。
在使用反射之前必须使用import java.lang.reflect.* 来导入和反射相关的类。

如果要得到某一个类或接口的注释信息，可以使用如下代码：
Annotation annotation = TestAnnotation.class.getAnnotation(MyAnnotation.class);

如果要得到全部的注释信息可使用如下语句：
Annotation[] annotations = TestAnnotation.class.getAnnotations();
或
Annotation[] annotations = TestAnnotation.class.getDeclaredAnnotations();

getDeclaredAnnotations与getAnnotations类似，但它们不同的是getDeclaredAnnotations 得到的是当前成员所有的注释，不包括继承的。而getAnnotations得到的是包括继承的所有注释。

如果要得到其它成员的注释，可先得到这个成员，然后再得到相应的注释。如得到myMethod的注释。
Method method = TestAnnotation.class.getMethod(“myMethod”, null);
Annotation annotation = method.getAnnotation(MyAnnotation.class);

注：要想使用反射得到注释信息，这个注释必须使用
@Retention(value = RetentionPolicy.RUNTIME)进行注释。

By the time your rss reader get this post here is 2 comments ,Welcome you come to leave your opinion !

您可能也喜欢：
Java Concurrency Annotations	Java5中的注释Annotation	Jboss Seam的注解	OpenStack架构预览	Drag a item to dhtmlxGrid and add a column
无觅

您可能也喜欢：
Java Concurrency Annotations	Java 反射机制	java.lang.reflect.Array	Java Enumeration	Java Generic Types
来自无觅网络的相关文章：
Java的枚举和接口 (@hui-wang)	Java验证码系列(6):英文字母与数字混合验证码 (@pihai)	Java获取当天后的N天日期 (@pihai)	Java验证码系列(5):纯数字验证码 (@pihai)	Java验证码系列(7):中文验证码 (@pihai)
无觅

JavaChen on JavaAnnotation

获得一个类上的注解

Java5中的注释Annotation