Java注解處理器簡單實例

2024-07-13 10:15:51

字體：大中小

供稿：網(wǎng)友

如果沒有用來讀取注解的方法和工作，那么注解也就不會比注釋更有用處了。使用注解的過程中，很重要的一部分就是創(chuàng)建于使用注解處理器。JavaSE5擴展了反射機制的API，以幫助程序員快速的構(gòu)造自定義注解處理器。

注解處理器類庫(java.lang.reflect.AnnotatedElement)：

Java使用Annotation接口來代表程序元素前面的注解，該接口是所有Annotation類型的父接口。除此之外，Java在java.lang.reflect包下新增了AnnotatedElement接口，該接口代表程序中可以接受注解的程序元素，該接口主要有如下幾個實現(xiàn)類：

Class：類定義

Constructor：構(gòu)造器定義

Field：累的成員變量定義

Method：類的方法定義

Package：類的包定義

java.lang.reflect包下主要包含一些實現(xiàn)反射功能的工具類，實際上，java.lang.reflect包所有提供的反射API擴充了讀取運行時Annotation信息的能力。當(dāng)一個Annotation類型被定義為運行時的Annotation后，該注解才能是運行時可見，當(dāng)class文件被裝載時被保存在class文件中的Annotation才會被虛擬機讀取。

AnnotatedElement接口是所有程序元素（Class、Method和Constructor）的父接口，所以程序通過反射獲取了某個類的AnnotatedElement對象之后，程序就可以調(diào)用該對象的如下四個個方法來訪問Annotation信息：

方法1：<TextendsAnnotation>TgetAnnotation(Class<T>annotationClass):返回改程序元素上存在的、指定類型的注解，如果該類型注解不存在，則返回null。

方法2：Annotation[]getAnnotations():返回該程序元素上存在的所有注解。

方法3：booleanisAnnotationPresent(Class<?extendsAnnotation>annotationClass):判斷該程序元素上是否包含指定類型的注解，存在則返回true，否則返回false.

方法4：Annotation[]getDeclaredAnnotations()：返回直接存在于此元素上的所有注釋。與此接口中的其他方法不同，該方法將忽略繼承的注釋。（如果沒有注釋直接存在于此元素上，則返回長度為零的一個數(shù)組。）該方法的調(diào)用者可以隨意修改返回的數(shù)組；這不會對其他調(diào)用者返回的數(shù)組產(chǎn)生任何影響。

一個簡單的注解處理器：

/***********注解聲明***************//** * 水果名稱注解 * @author peida * */@Target(ElementType.FIELD)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface FruitName {	String value() default "";}/** * 水果顏色注解 * @author peida * */@Target(ElementType.FIELD)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface FruitColor {	/**   * 顏色枚舉   * @author peida   *   */	public enum Color{		BULE,RED,GREEN	}	;	/**   * 顏色屬性   * @return   */	Color fruitColor() default Color.GREEN;}/** * 水果供應(yīng)者注解 * @author peida * */@Target(ElementType.FIELD)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface FruitProvider {	/**   * 供應(yīng)商編號   * @return   */	public int id() default -1;	/**   * 供應(yīng)商名稱   * @return   */	public String name() default "";	/**   * 供應(yīng)商地址   * @return   */	public String address() default "";}/***********注解使用***************/public class Apple {	@FruitName("Apple")	  private String appleName;	@FruitColor(fruitColor=Color.RED)	  private String appleColor;	@FruitProvider(id=1,name="陜西紅富士集團",address="陜西省西安市延安路89號紅富士大廈")	  private String appleProvider;	public void setAppleColor(String appleColor) {		this.appleColor = appleColor;	}	public String getAppleColor() {		return appleColor;	}	public void setAppleName(String appleName) {		this.appleName = appleName;	}	public String getAppleName() {		return appleName;	}	public void setAppleProvider(String appleProvider) {		this.appleProvider = appleProvider;	}	public String getAppleProvider() {		return appleProvider;	}	public void displayName(){		System.out.println("水果的名字是：蘋果");	}}/***********注解處理器***************/public class FruitInfoUtil {	public static void getFruitInfo(Class<?> clazz){		String strFruitName=" 水果名稱：";		String strFruitColor=" 水果顏色：";		String strFruitProvicer="供應(yīng)商信息：";		Field[] fields = clazz.getDeclaredFields();		for (Field field :fields){			if(field.isAnnotationPresent(FruitName.class)){				FruitName fruitName = (FruitName) field.getAnnotation(FruitName.class);				strFruitName=strFruitName+fruitName.value();				System.out.println(strFruitName);			} else if(field.isAnnotationPresent(FruitColor.class)){				FruitColor fruitColor= (FruitColor) field.getAnnotation(FruitColor.class);				strFruitColor=strFruitColor+fruitColor.fruitColor().toString();				System.out.println(strFruitColor);			} else if(field.isAnnotationPresent(FruitProvider.class)){				FruitProvider fruitProvider= (FruitProvider) field.getAnnotation(FruitProvider.class);				strFruitProvicer=" 供應(yīng)商編號："+fruitProvider.id()+" 供應(yīng)商名稱："+fruitProvider.name()+" 供應(yīng)商地址："+fruitProvider.address();				System.out.println(strFruitProvicer);			}		}	}}/***********輸出結(jié)果***************/public class FruitRun {	/**   * @param args   */	public static void main(String[] args) {		FruitInfoUtil.getFruitInfo(Apple.class);	}}==================================== 水果名稱：Apple 水果顏色：RED 供應(yīng)商編號：1 供應(yīng)商名稱：陜西紅富士集團 供應(yīng)商地址：陜西省西安市延安路89號紅富士大廈

Java注解的基礎(chǔ)知識點（見下面導(dǎo)圖）基本都過了一遍，下一篇我們通過設(shè)計一個基于注解的簡單的ORM框架，來綜合應(yīng)用和進(jìn)一步加深對注解的各個知識點的理解和運用。

java,注解,處理器,java自定義注解處理器