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);
	}

}

執行結果