Java注解入门

概念

Annotation(注解)是 Java 提供的一种对元程序中元素关联信息和元数据(metadata)的途径
和方法。Annatation(注解)是一个接口,程序可以通过反射来获取指定程序中元素的 Annotation
对象,然后通过该 Annotation 对象来获取注解中的元数据信息。

4 种标准元注解

元注解的作用是负责注解其他注解。 Java5.0 定义了 4 个标准的 meta-annotation 类型,它们被
用来提供对其它 annotation 类型作说明。

1. @Target 修饰的对象范围
   @Target 说明了 Annotation 所修饰的对象范围: Annotation 可被用于 packages、types(类、
   接口、枚举、Annotation 类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数
   和本地变量(如循环变量、catch 参数)。在 Annotation 类型的声明中使用了 target 可更加明晰
   其修饰的目标
2. @Retention 定义 被保留的时间长短
   Retention 定义了该 Annotation 被保留的时间长短:表示需要在什么级别保存注解信息,用于描
   述注解的生命周期(即:被描述的注解在什么范围内有效),取值(RetentionPoicy)由:
   ① SOURCE:在源文件中有效(即源文件保留)
   ② CLASS:在 class 文件中有效(即 class 保留)
   ③ RUNTIME:在运行时有效(即运行时保留)
3. @Documented 描述-javadoc
   @ Documented 用于描述其它类型的 annotation 应该被作为被标注的程序成员的公共 API,因
   此可以被例如 javadoc 此类的工具文档化。
4. @Inherited 阐述了某个被标注的类型是被继承的
   @Inherited 元注解是一个标记注解,@Inherited 阐述了某个被标注的类型是被继承的。如果一
   个使用了@Inherited 修饰的 annotation 类型被用于一个 class,则这个 annotation 将被用于该
   class 的子类。

注解处理器

如果没有用来读取注解的方法和工作,那么注解也就不会比注释更有用处了。使用注解的过程中,
很重要的一部分就是创建于使用注解处理器。Java SE5 扩展了反射机制的 API,以帮助程序员快速
的构造自定义注解处理器。下面实现一个注解处理器。

//1、定义注解
Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface PersonName {

	String value() default "";

}

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface PersonAge {

	int value() default 0;

}

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface PersonAddress {

	String value() default "";

}
//2、使用注解
public class Person {

	@PersonName("zfm")
	String name;

	@PersonAge(18)
	int age;

	@PersonAddress("上海市")
	String address;


	public String getName() {
		return name;
	}

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

	public int getAge() {
		return age;
	}

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

	public String getAddress() {
		return address;
	}

	public void setAddress(String address) {
		this.address = address;
	}
}
//3、注解处理器
public class AnnotationUtils {

	public static void getPersonInfo(Class<?> clazz) {
		Field[] declaredFields = clazz.getDeclaredFields();
		for (Field declaredField : declaredFields) {
			if (declaredField.isAnnotationPresent(PersonName.class)) {
				System.out.println("名称：" + declaredField.getAnnotation(PersonName.class).value());
			} else if (declaredField.isAnnotationPresent(PersonAge.class)) {
				System.out.println("年龄：" + declaredField.getAnnotation(PersonAge.class).value());
			} else if (declaredField.isAnnotationPresent(PersonAddress.class)) {
				System.out.println("住址：" + declaredField.getAnnotation(PersonAddress.class).value());
			}
		}
	}

}

@SpringBootTest
public class TestAnnotation {

	@Test
	public void testAnnotation() {
		AnnotationUtils.getPersonInfo(Person.class);
	}

}

执行结果