Java中注解的使用与实例

注解相当于一种标记，在程序中加了注解就等于为程序打上了某种标记，没加，则等于没有某种标记。 以后，javac编译器，开发工具和其他程序可以用反射来了解你的类及各种元素上有无何种标记，看你有什么标记，就去干相应的事 。标记可以加在包，类，字段，方法，方法的参数以及局部变量上。

注解的语法比较简单，除了@符号的使用之外，它基本与Java固有语法一致。

Java SE5内置了三种标准注解：

@Override，表示当前的方法定义将覆盖超类中的方法。

@Deprecated，使用了注解为它的元素编译器将发出警告，因为注解@Deprecated是不赞成使用的代码，被弃用的代码。

@SuppressWarnings，关闭不当编译器警告信息。

上面这三个注解多少我们都会在写代码的时候遇到。Java还提供了4中注解，专门负责新注解的创建。

@Target	表示该注解可以用于什么地方，可能的ElementType参数有： CONSTRUCTOR：构造器的声明 FIELD：域声明（包括enum实例） LOCAL_VARIABLE：局部变量声明 METHOD：方法声明 PACKAGE：包声明 PARAMETER：参数声明 TYPE：类、接口（包括注解类型）或enum声明 ANNOTATION_TYPE： TYPE_PARAMETER： TYPE_USE：
@Retention	表示需要在什么级别保存该注解信息。可选的RetentionPolicy参数包括： SOURCE：注解将被编译器丢弃 CLASS：注解在class文件中可用，但会被VM丢弃 RUNTIME：VM将在运行期间保留注解，因此可以通过反射机制读取注解的信息。
@Document	将注解包含在Javadoc中
@Inherited	允许子类继承父类中的注解

定义一个注解的方式：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
  
}

除了@符号，注解很像是一个接口。定义注解的时候需要用到元注解，上面用到了@Target和@RetentionPolicy，它们的含义在上面的表格中已近给出。 

在注解中一般会有一些元素以表示某些值。注解的元素看起来就像接口的方法，唯一的区别在于可以为其制定默认值。没有元素的注解称为标记注解，上面的@MyAnnotation就是一个标记注解。 

注解的可用的类型包括以下几种：所有基本类型、String、Class、enum、Annotation、以上类型的数组形式。元素不能有不确定的值，即要么有默认值，要么在使用注解的时候提供元素的值。而且元素不能使用null作为默认值。注解在只有一个元素且该元素的名称是value的情况下，在使用注解的时候可以省略“value=”，直接写需要的值即可。 

1.定义了元素的注解

/**
 * 枚举，模拟注解中添加枚举属性
 */
public enum Gender {
	MAN {
		public String getName() {
			return "男";
		}
	},
	WOMEN {
		public String getName() {
			return "女";
		}
	};

	public abstract String getName();
}

/**
 * 定义一个注解，模拟注解中添加注解属性
 */
public @interface MetaAnnotation {

	String birthday();

}

@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.METHOD, ElementType.TYPE })
public @interface MyAnnotation {
	
	String color();

	String value() default "这是个注解"; // 为属性提供默认值

	int[] array() default { 1, 2, 3 };

	Gender gender() default Gender.MAN; // 添加一个枚举属性值

	MetaAnnotation metaAnnotation() default @MetaAnnotation(birthday = "我的出身日期为1988/01/29"); // 添加注解属性值

}

2.使用注解

@MyAnnotation(metaAnnotation = @MetaAnnotation(birthday = "我的出身日期为1988/12/12"), color = "red", array = { 23, 26 })
public class AnnotationCaller {

}

3.注解处理器

从原理上讲，注解处理器就是通过反射机制获取被检查方法上的注解信息，然后根据注解元素的值进行特定的处理。

public class AnnotationTest {

	public static void main(String[] args) {
		// 检查类AnnotationTest是否含有@MyAnnotation注解
		if (AnnotationCaller.class.isAnnotationPresent(MyAnnotation.class)) {
			// 若存在就获取注解
			MyAnnotation annotation = (MyAnnotation) AnnotationCaller.class.getAnnotation(MyAnnotation.class);
			System.out.println(annotation);
			
			// 获取注解属性
			System.out.println(annotation.color());
			System.out.println(annotation.value());
			
			// 数组
			int[] arrs = annotation.array();
			for (int arr : arrs) {
				System.out.println(arr);
			}
			
			// 枚举
			Gender gender = annotation.gender();
			System.out.println("性别为：" + gender);
			
			// 获取注解属性
			MetaAnnotation meta = annotation.metaAnnotation();
			System.out.println(meta.birthday());
		}
	}
}

@demo01.MyAnnotation(gender=MAN, metaAnnotation=@demo01.MetaAnnotation(birthday=我的出身日期为1988/12/12), value=这是个注解, array=[23, 26], color=red)
red
这是个注解
23
26
性别为：MAN
我的出身日期为1988/12/12