Java注解处理器简单实例
如果没有用来读取注解的方法和工作,那么注解也就不会比注释更有用处了。使用注解的过程中,很重要的一部分就是创建于使用注解处理器。javase5扩展了反射机制的api,以帮助程序员快速的构造自定义注解处理器。
注解处理器类库(java.lang.reflect.annotatedelement):
java使用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:<textendsannotation>tgetannotation(class<t>annotationclass):返回改程序元素上存在的、指定类型的注解,如果该类型注解不存在,则返回null。
方法2:annotation[]getannotations():返回该程序元素上存在的所有注解。
方法3:booleanisannotationpresent(class<?extendsannotation>annotationclass):判断该程序元素上是否包含指定类型的注解,存在则返回true,否则返回false.
方法4:annotation[]getdeclaredannotations():返回直接存在于此元素上的所有注释。与此接口中的其他方法不同,该方法将忽略继承的注释。(如果没有注释直接存在于此元素上,则返回长度为零的一个数组。)该方法的调用者可以随意修改返回的数组;这不会对其他调用者返回的数组产生任何影响。
一个简单的注解处理器:
/***********注解声明***************/ /** * 水果名称注解 * @author peida * */ @target(elementtype.field) @retention(retentionpolicy.runtime) @documented public @interface fruitname { string value() default ""; } /** * 水果颜色注解 * @author peida * */ @target(elementtype.field) @retention(retentionpolicy.runtime) @documented public @interface fruitcolor { /** * 颜色枚举 * @author peida * */ public enum color{ bule,red,green } ; /** * 颜色属性 * @return */ color fruitcolor() default color.green; } /** * 水果供应者注解 * @author peida * */ @target(elementtype.field) @retention(retentionpolicy.runtime) @documented public @interface fruitprovider { /** * 供应商编号 * @return */ public int id() default -1; /** * 供应商名称 * @return */ public string name() default ""; /** * 供应商地址 * @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="供应商信息:"; 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); } } } } /***********输出结果***************/ public class fruitrun { /** * @param args */ public static void main(string[] args) { fruitinfoutil.getfruitinfo(apple.class); } } ==================================== 水果名称:apple 水果颜色:red 供应商编号:1 供应商名称:陕西红富士集团 供应商地址:陕西省西安市延安路89号红富士大厦
java注解的基础知识点(见下面导图)基本都过了一遍,下一篇我们通过设计一个基于注解的简单的orm框架,来综合应用和进一步加深对注解的各个知识点的理解和运用。
总结
以上就是本文关于java注解处理器简单实例的全部内容,希望对大家有所帮助。感兴趣的朋友可以继续参阅本站其他相关专题,如有不足之处,欢迎留言指出。感谢朋友们对本站的支持!