自定義註解 annotation 總結

要深入學習註解，我們就必須能定義自己的註解，並使用註解，在定義自己的註解之前，我們就必須要了解Java爲我們提供的元註解和相關定義註解的語法。所以這篇文章我會首先和大家介紹一下一些必要了解的基本概念，然後我再用代碼演示一下，最後再做一下簡單的歸納總結。

 

一、必要了解的基本概念

1、元註解：元註解的作用就是負責註解其他註解。Java5.0定義了4個標準的meta-annotation類型，它們被用來提供對其它 annotation類型作說明。Java5.0定義的元註解：　1.@Target,
2.@Retention,
3.@Documented,
4.@Inherited
   　這些類型和它們所支持的類在java.lang.annotation包中可以找到。下面簡單介紹一下每個元註解的作用和相應分參數的使用說明。

@Target： @Target說明了Annotation所修飾的對象範圍：Annotation可被用於 packages、types（類、接口、枚舉、Annotation類型）、類型成員（方法、構造方法、成員變量、枚舉值）、方法參數和本地變量（如循環變量、catch參數）。在Annotation類型的聲明中使用了target可更加明晰其修飾的目標。

　　作用：用於描述註解的使用範圍（即：被描述的註解可以用在什麼地方）

　　取值(ElementType)有：

1.CONSTRUCTOR:用於描述構造器
2.FIELD:用於描述實例屬性、成員變量
3.LOCAL_VARIABLE:用於描述局部變量
4.METHOD:用於描述方法
5.PACKAGE:用於描述包
6.PARAMETER:用於描述參數
7.TYPE:用於描述類、接口(包括註解類型) 或enum聲明

}

---

@Retention： @Retention定義了該Annotation被保留的時間長短：某些Annotation僅出現在源代碼中，而被編譯器丟棄；而另一些卻被編譯在class文件中；編譯在class文件中的Annotation可能會被虛擬機忽略，而另一些在class被裝載時將被讀取（請注意並不影響class的執行，因爲Annotation與class在使用上是被分離的）。使用這個meta-Annotation可以對 Annotation的“生命週期”限制。

　　作用：表示需要在什麼級別保存該註釋信息，用於描述註解的生命週期（即：被描述的註解在什麼範圍內有效）

　　取值（RetentionPoicy）有：

1.SOURCE:在源文件中有效（即源文件保留）
2.CLASS:在class文件中有效（即class保留）
3.RUNTIME:在運行時有效（即運行時保留）

@Documented: @Documented用於描述其它類型的annotation應該被作爲被標註的程序成員的公共API，因此可以被例如javadoc此類的工具文檔化。Documented是一個標記註解，沒有成員。

@Inherited： @Inherited 元註解是一個標記註解，@Inherited闡述了某個被標註的類型是被繼承的。如果一個使用了@Inherited修飾的annotation類型被用於一個class，則這個annotation將被用於該class的子類。

　　注意：@Inherited annotation類型是被標註過的class的子類所繼承。類並不從它所實現的接口繼承annotation，方法並不從它所重載的方法繼承annotation。

　　當@Inherited annotation類型標註的annotation的Retention是RetentionPolicy.RUNTIME，則反射API增強了這種繼承性。如果我們使用java.lang.reflect去查詢一個@Inheritedannotation類型的annotation時，反射代碼檢查將展開工作：檢查class和其父類，直到發現指定的annotation類型被發現，或者到達類繼承結構的頂層。

二、現在用代碼演示一下怎麼自定義註解：

定義一個@table註解

package com.gaox.annotataion;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author gaox
 * @createTime 2017年5月24日 下午2:25:11
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Table {
	public String value() default "";
	public String descrip() default "";
}

定義一個@id註解

package com.gaox.annotataion;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author gaox
 * @createTime 2017年5月24日 下午3:07:10
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Id {
	public String value( ) default "";
}

定義一個@column註解

package com.gaox.annotataion;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author gaox
 * @createTime 2017年5月24日 下午3:07:55
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {
	public String name();
	public String descrip();
}

然後我們在看看註解怎麼用：

package com.gaox.entity;

import java.io.Serializable;
import java.util.Date;

import com.gaox.annotataion.Column;
import com.gaox.annotataion.Id;
import com.gaox.annotataion.Table;

/**
 * @author gaox
 * @createTime 2017年5月24日 下午2:22:32
 */
@Table("This is an annotation")
public class Person implements Serializable{
	@Id("id")
	private Integer id;
	@Column(name="gaox",descrip="姓名")
	private String name;
	private String sex;
	private String address;
	private Date born;
	
	
	public Integer getId() {
		return id;
	}
	public void setId(Integer id) {
		this.id = id;
	}
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	public String getSex() {
		return sex;
	}
	public void setSex(String sex) {
		this.sex = sex;
	}
	public String getAddress() {
		return address;
	}
	public void setAddress(String address) {
		this.address = address;
	}
	public Date getBorn() {
		return born;
	}
	public void setBorn(Date born) {
		this.born = born;
	}
	public Person(String name, String sex, String address, Date born) {
		super();
		this.name = name;
		this.sex = sex;
		this.address = address;
		this.born = born;
	}
	public Person() {
		super();
	}
	
}

測試一下看看，自定義的註解有沒有作用

測試一：取出類上的@Table的參數值

package test;

import java.lang.annotation.Annotation;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import com.gaox.entity.Person;

/**
 * @author gaox
 * @createTime 2017年5月24日 下午2:35:07
 */
public class Test {
	public static void main(String[] args) {
	Annotation[]annotations=Person.class.getAnnotations();
	for (Annotation a : annotations) {
		Method[] methods=a.annotationType().getDeclaredMethods();
		for (Method method : methods) {
			if(method.isAccessible()){
			method.setAccessible(true);
			}
			try {
				System.out.println(method.invoke(a, null));
			} catch (IllegalAccessException e) {
				// TODO Auto-generated catch block
				e.printStackTrace();
			} catch (IllegalArgumentException e) {
				// TODO Auto-generated catch block
				e.printStackTrace();
			} catch (InvocationTargetException e) {
				// TODO Auto-generated catch block
				e.printStackTrace();
			}
		}
	}
	}
}

測試結果輸出了:This is anannotation

測試二：獲取@cloumn的參數

package test;

import java.lang.reflect.Field;

import com.gaox.annotataion.Column;
import com.gaox.entity.Person;

/**
 * @author gaox
 * @createTime 2017年5月24日 下午3:16:59
 */
public class Test2 {

	public static void main(String[] args) {
		Field[] fields=Person.class.getDeclaredFields();
		for (Field field : fields) {
			if(!field.isAccessible()){
				field.setAccessible(true);
			}
			if(field.isAnnotationPresent(Column.class)){
				System.out.println("@Column的name:"+field.getAnnotation(Column.class).name());
				System.out.println("@Column的descrip:"+field.getAnnotation(Column.class).descrip());
				}
		}
	}
}

測試結果輸出：

@Column的name:gaox

@Column的descrip:姓名

三、總結一下：　　使用@interface自定義註解時，自動繼承了java.lang.annotation.Annotation接口，由編譯程序自動完成其他細節。在定義註解時，不能繼承其他的註解或接口。@interface用來聲明一個註解，其中的每一個方法實際上是聲明瞭一個配置參數。方法的名稱就是參數的名稱，返回值類型就是參數的類型（返回值類型只能是基本類型、Class、String、enum）。可以通過default來聲明參數的默認值。

　　定義註解格式：
public @interface註解名 {定義體}

　　註解參數的可支持數據類型：

1.所有基本數據類型（int,float,boolean,byte,double,char,long,short)
2.String類型
3.Class類型
4.enum類型
5.Annotation類型
6.以上所有類型的數組

Annotation類型裏面的參數該怎麼設定: 
　　第一,只能用public或默認(default)這兩個訪問權修飾.例如,Stringvalue();這裏把方法設爲defaul默認類型；　
　　第二,參數成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數據類型和String,Enum,Class,annotations等數據類型,以及這一些類型的數組.例如,String value();這裏的參數成員就爲String;
　　第三,如果只有一個參數成員,最好把參數名稱設爲"value",後加小括號.

 

註解元素的默認值：

　　註解元素必須有確定的值，要麼在定義註解的默認值中指定，要麼在使用註解時指定，非基本類型的註解元素的值不可爲null。因此, 使用空字符串或0作爲默認值是一種常用的做法。這個約束使得處理器很難表現一個元素的存在或缺失的狀態，因爲每個註解的聲明中，所有元素都存在，並且都具有相應的值，爲了繞開這個約束，我們只能定義一些特殊的值，例如空字符串或者負數，一次表示某個元素不存在，在定義註解時，這已經成爲一個習慣用法。

 　定義了註解，並在需要的時候給相關類，類屬性加上註解信息，如果沒有響應的註解信息處理流程，註解可以說是沒有實用價值。如何讓註解真真的發揮作用，主要就在於註解處理方法，下一步我們將學習註解信息的獲取和處理！