java 自定义注解 解析器_Annotation之三：自定义注解示例，利用反射进行解析

Java使用java.lang.annotation.Annotation接口来代表程序元素前面的注解，该接口是所有Annotation类型的父接口。除此之外，Java在java.lang.reflect 包下新增了AnnotatedElement接口，该接口代表程序中可以接受注解的程序元素，该接口主要有如下几个实现类：

Class：类定义

Constructor：构造器定义

Field：累的成员变量定义

Method：类的方法定义

Package：类的包定义

java.lang.reflect 包下主要包含一些实现反射功能的工具类，实际上，java.lang.reflect 包所有提供的反射API扩充了读取运行时Annotation信息的能力。当一个Annotation类型被定义为运行时的Annotation后，该注解才能是运行时可见，当class文件被装载时被保存在class文件中的Annotation才会被虚拟机读取。

AnnotatedElement 接口是所有程序元素(Class、Method和Constructor)的父接口，所以程序通过反射获取了某个类的AnnotatedElement对象之后，程序就可以调用该对象的如下四个个方法来访问Annotation信息：

方法1： T getAnnotation(Class annotationClass): 返回改程序元素上存在的、指定类型的注解，如果该类型注解不存在，则返回null。

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

方法3：boolean isAnnotationPresent(Class<?extends Annotation> annotationClass):判断该程序元素上是否包含指定类型的注解，存在则返回true，否则返回false.

方法4：Annotation[] getDeclaredAnnotations()：返回直接存在于此元素上的所有注释。与此接口中的其他方法不同，该方法将忽略继承的注释。(如果没有注释直接存在于此元素上，则返回长度为零的一个数组。)该方法的调用者可以随意修改返回的数组；这不会对其他调用者返回的数组产生任何影响。

程序通过反射获取了某个类的AnnotatedElement对象之后,使用上面的4个方法访问Annotation信息

Field[] fields =clazz.getDeclaredFields();for(Field field :fields){if(field.isAnnotationPresent(FruitName.class)){//...

Field类

public final

class Field extends AccessibleObject implements Member {

AccessibleObject

public class AccessibleObject implementsAnnotatedElement {//...

示例：一个简单的自定义注解及注解处理器对该注解的解析：

1、水果的名称、颜色、供应商注解

packagecom.dxz.annotation.demo4;importjava.lang.annotation.Documented;importjava.lang.annotation.ElementType;importjava.lang.annotation.Retention;importjava.lang.annotation.RetentionPolicy;importjava.lang.annotation.Target;/*** 水果名称注解*/@Target(ElementType.FIELD)

@Retention(RetentionPolicy.RUNTIME)

@Documentedpublic @interfaceFruitName {

String value()default "";

}packagecom.dxz.annotation.demo4;importjava.lang.annotation.Documented;importjava.lang.annotation.ElementType;importjava.lang.annotation.Retention;importjava.lang.annotation.RetentionPolicy;importjava.lang.annotation.Target;/*** 水果颜色注解*/@Target(ElementType.FIELD)

@Retention(RetentionPolicy.RUNTIME)

@Documentedpublic @interfaceFruitColor {/*** 颜色枚举

*@authorpeida

**/

public enumColor{ BULE,RED,GREEN};/*** 颜色属性

*@return

*/Color fruitColor()defaultColor.GREEN;

}packagecom.dxz.annotation.demo4;importjava.lang.annotation.Documented;importjava.lang.annotation.ElementType;importjava.lang.annotation.Retention;importjava.lang.annotation.RetentionPolicy;importjava.lang.annotation.Target;/*** 水果供应者注解*/@Target(ElementType.FIELD)

@Retention(RetentionPolicy.RUNTIME)

@Documentedpublic @interfaceFruitProvider {/*** 供应商编号

*

*@return

*/

public int id() default -1;/*** 供应商名称

*

*@return

*/

public String name() default "";/*** 供应商地址

*

*@return

*/

public String address() default "";

}

2、使用注解(标注注解)

packagecom.dxz.annotation.demo4;importcom.dxz.annotation.demo4.FruitColor.Color;public classApple {

@FruitName("Apple")privateString appleName;

@FruitColor(fruitColor=Color.RED)privateString appleColor;

@FruitProvider(id= 1, name = "陕西红富士集团", address = "陕西省西安市延安路89号红富士大厦")privateString appleProvider;public voidsetAppleColor(String appleColor) {this.appleColor =appleColor;

}publicString getAppleColor() {returnappleColor;

}public voidsetAppleName(String appleName) {this.appleName =appleName;

}publicString getAppleName() {returnappleName;

}public voidsetAppleProvider(String appleProvider) {this.appleProvider =appleProvider;

}publicString getAppleProvider() {returnappleProvider;

}public voiddisplayName() {

System.out.println("水果的名字是：苹果");

}

}

3、解析器解析

packagecom.dxz.annotation.demo4;importjava.lang.reflect.Field;public classFruitInfoUtil {public static void getFruitInfo(Class>clazz){

String strFruitName=" 水果名称：";

String strFruitColor=" 水果颜色：";

String strFruitProvicer="供应商信息：";

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=" 供应商编号："+fruitProvider.id()+" 供应商名称："+fruitProvider.name()+" 供应商地址："+fruitProvider.address();

System.out.println(strFruitProvicer);

}

}

}

}

测试类：

packagecom.dxz.annotation.demo4;public classTest {public static voidmain(String[] args) {

FruitInfoUtil.getFruitInfo(Apple.class);

}

}

结果：

水果名称：Apple

水果颜色：RED

供应商编号：1 供应商名称：陕西红富士集团 供应商地址：陕西省西安市延安路89号红富士大厦

Java注解的基础知识点(见下面导图)基本都过了一遍，下一篇我们通过设计一个基于注解的简单的ORM框架，来综合应用和进一步加深对注解的各个知识点的理解和运用。