java学习之路 之 枚举类&注解-注解(Annotation)及练习题

注解 (Annotation) 概述

从 JDK 5.0 开始, Java 增加了对元数据(MetaData) 的支持, 也就是 Annotation(注解)
Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理. 通过使用 Annotation, 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息.
Annotation 可以像修饰符一样被使用, 可用于修饰包,类, 构造器, 方法, 成员变量, 参数, 局部变量的声明, 这些信息被保存在 Annotation 的 “name=value” 对中.
Annotation 能被用来为程序元素(类, 方法, 成员变量等) 设置元数据

基本的 Annotation

使用 Annotation 时要在其前面增加 @ 符号, 并把该 Annotation 当成一个修饰符使用。用于修饰它支持的程序元素
三个基本的 Annotation:
@Override: 限定重写父类方法, 该注释只能用于方法
@Deprecated: 用于表示某个程序元素(类, 方法等)已过时
@SuppressWarnings: 抑制编译器警告

自定义 Annotation

定义新的 Annotation 类型使用 @interface 关键字
Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明. 其方法名和返回值定义了该成员的名字和类型. 
可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始值可使用 default 关键字
public @interface MyAnnotation{      
String name() default “Java";       
}
没有成员定义的 Annotation 称为标记; 包含成员变量的 Annotation 称为元数据 Annotation

提取 Annotation 信息
JDK 5.0 在 java.lang.reflect 包下新增了 AnnotatedElement 接口, 该接口代表程序中可以接受注解的程序元素
当一个 Annotation 类型被定义为运行时 Annotation 后, 该注释才是运行时可见, 当 class 文件被载入时保存在 class 文件中的 Annotation 才会被虚拟机读取
程序可以调用 AnnotationElement 对象的如下方法来访问 Annotation 信息

JDK 的元 Annotation
JDK 的元 Annotation 用于修饰其他 Annotation 定义
JDK5.0提供了专门在注解上的注解类型，分别是：
Retention
Target
Documented
Inherited
元数据:String name = “Java”;

@Retention: 只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 可以保留多长时间, @Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用 @Rentention 时必须为该 value 成员变量指定值:
RetentionPolicy.SOURCE: 编译器直接丢弃这种策略的注释
RetentionPolicy.CLASS: 编译器将把注释记录在 class 文件中. 当运行 Java 程序时, JVM 不会保留注解。 这是默认值
RetentionPolicy.RUNTIME:编译器将把注释记录在 class 文件中. 当运行 Java 程序时, JVM 会保留注释. 程序可以通过反射获取该注释

@Target: 用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于修饰哪些程序元素. @Target 也包含一个名为 value 的成员变量.
@Documented: 用于指定被该元 Annotation 修饰的 Annotation 类将被 javadoc 工具提取成文档.定义为Documented的注解必须设置Retention值为RUNTIME。

@Inherited: 被它修饰的 Annotation 将具有继承性.如果某个类使用了被 @Inherited 修饰的 Annotation, 则其子类将自动具有该注解实际应用中，使用较少.

练习题

/**
 * 注解 : 给运行时看的注释性质的内容, 可以加在指定的元素上
 * 可以加在类,属性,方法,局部变量
 * 
 * 注解的处理只能通过反射来处理
 * 
 * @Override注解的使用 只能适用于方法覆盖
 * @author 文件的作者 提醒javaDoc本类的作者是谁
 * @version 1.0 
 * @Deprecated 注解是过时的意思 
 * @SuppressWarnings(数据) 作用是抑制警告, 并且这个注解还可以接收数据
 * @SuppressWarnings({数据1, 数据2, 数据3}) 作用是抑制警告, 并且这个注解还可以接收数据
 */

// 自定义注解, 写法特别像接口, 但是注解不是接口
// 指定此注解只能用于属性和方法,其他位置不允许使用
@Target({ElementType.FIELD, ElementType.METHOD}) // 注解的注解, 元注解
@Retention(RetentionPolicy.RUNTIME) // 指定此注解可以在程序运行时也可以使用, 必须通过反射才能使用
@interface MyAnnotation {
	public String name(); // 属性的写法像方法
	public int age() default 10; // 属性可以有默认值
}

// 写一个自定义注解MyAnn, 可以给任意的元素加注解
// 包含属性value和id id属性有默认值100
// 再写一个普通类, 测试注解可以使用在哪里

//@Override 不可以给类加这个注解
@Deprecated
//@SuppressWarnings("unused")
//@MyAnnotation(name = "张三", age = 30)
public class Teacher {
	
	@SuppressWarnings("unused")
	private int x;
	@MyAnnotation(name="test")
	private int y;
	
	//@Override 不可以给属性加这个注解
	@Deprecated
	private String name;
	@MyAnnotation(name = "张三", age = 40)
	private int age;
	@MyAnnotation(name = "张三")
	private String gender;
	
	@Deprecated
	//@MyAnnotation(name = "张三")
	public Teacher() {
		// TODO Auto-generated constructor stub
	}
	
	//@Override
	public Teacher(@Deprecated String name, int age, String gender) {
		super();
		this.name = name;
		this.age = age;
		this.gender = gender;
	}

	@Deprecated
	@MyAnnotation(name = "张三")
	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	@Deprecated
	public int getAge() {
		return age;
	}

	public void setAge(int age) {
		this.age = age;
	}

	public String getGender() {
		return gender;
	}

	//@Override 专用于方法覆盖时使用
	public void setGender(String gender) {
		this.gender = gender;
	}
	
	@SuppressWarnings({ "unused", "rawtypes" }) // 接收到的数据会被运行时识别
	public void test() {
		int a;
		int b;
		Class class1;
	}

	@Override public String toString() {
		return "Teacher [name=" + name + ", age=" + age + ", gender=" + gender + "]";
	}
}