`
xiaobian
  • 浏览: 588049 次
  • 来自: 北京
社区版块
存档分类
最新评论

设计自己的Annotation Java

阅读更多

http://www.duduwolf.com/wiki/2006/104.html

 

设计自己的Annotation Java

Annotation在java的世界正铺天盖地展开,有空写这一篇简单的annotations的文章,算是关于Annotation入门的文章吧,希望能各位们能抛砖,共同学习......
不讲废话了,实践才是硬道理.

第一部分:了解一下java1.5起默认的三个annotation类型:
一个是@Override:只能用在方法之上的,用来告诉别人这一个方法是改写父类的。
一个是@Deprecated:建议别人不要使用旧的API的时候用的,编译的时候会用产生警告信息,可以设定在程序里的所有的元素上.
一个是@SuppressWarnings:这一个类型可以来暂时把一些警告信息消息关闭.
如果不清楚上面三个类型的具体用法,各位可以baidu或google一下的,很简单的。

第二部分:讲一下annotation的概念先,再来讲一下怎样设计自己的annotation.
首先在jdk自带的java.lang.annotation包里,打开如下几个源文件:

1、源文件Target.java

代码
 
  1. @Documented   
  2. @Retention (RetentionPolicy.RUNTIME)   
  3. @Target (ElementType.ANNOTATION_TYPE)   
  4. public   @interface  Target {   
  5.    ElementType[] value();   
  6. }  
<script type="text/javascript">render_code();</script>

其中的@interface是一个关键字,在设计annotations的时候必须把一个类型定义为@interface,而不能用class或interface关键字(会不会觉得sun有点吝啬,偏偏搞得与interface这么像).

2、源文件Retention.java
代码
 
  1. @Documented   
  2. @Retention (RetentionPolicy.RUNTIME)   
  3. @Target (ElementType.ANNOTATION_TYPE)   
  4. public   @interface  Retention {   
  5.    RetentionPolicy value();   
  6. }  
<script type="text/javascript">render_code();</script>

 

看到这里,大家可能都模糊了,都不知道在说什么,别急,往下看一下.
在上面的文件都用到了RetentionPolicy,ElementType这两个字段,你可能就会猜到这是两个java文件.的确,这两个文件的源代码如下:

3、源文件RetentionPolicy.java

代码
 
  1. public   enum  RetentionPolicy {   
  2.  SOURCE,   
  3.  CLASS,   
  4.  RUNTIME   
  5. }  
<script type="text/javascript">render_code();</script>
这是一个enum类型,共有三个值,分别是SOURCE,CLASS 和 RUNTIME.
SOURCE代表的是这个Annotation类型的信息只会保留在程序源码里,源码如果经过了编译之后,Annotation的数据就会消失,并不会保留在编译好的.class文件里面。
ClASS 的意思是这个Annotation类型的信息保留在程序源码里,同时也会保留在编译好的.class文件里面,在执行的时候,并不会把这一些信息加载到虚 拟机(JVM)中去.注意一下,当你没有设定一个Annotation类型的Retention值时,系统默认值是CLASS.
第三个,是RUNTIME,表示在源码、编译好的.class文件中保留信息,在执行的时候会把这一些信息加载到JVM中去的.
  举一个例子,如@Override里面的Retention设为SOURCE,编译成功了就不要这一些检查的信息;相反,@Deprecated里面的 Retention设为RUNTIME,表示除了在编译时会警告我们使用了哪个被Deprecated的方法,在执行的时候也可以查出该方法是否被 Deprecated.

 

4、源文件ElementType.java

代码
 
  1. public   enum  ElementType {   
  2.  TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR,   
  3.  LOCAL_VARIABLE, ANNOTATION_TYPE,PACKAGE   
  4. }  
<script type="text/javascript">render_code();</script>
@Target里面的ElementType是用来指定Annotation类型可以用在哪一些元素上的.说明一下:TYPE(类型), FIELD(属性), METHOD(方法), PARAMETER(参数), CONSTRUCTOR(构造函数),LOCAL_VARIABLE(局部变量), ANNOTATION_TYPE,PACKAGE(包),其中的TYPE(类型)是指可以用在Class,Interface,Enum和 Annotation类型上.
另外,从1的源代码可以看出,@Target自己也用了自己来声明自己,只能用在ANNOTATION_TYPE之上.
如果一个Annotation类型没有指明@Target使用在哪些元素上,那么它可以使用在任何元素之上,这里的元素指的是上面的八种类型.
举几个正确的例子:
@Target(ElementType.METHOD)
@Target(value=ElementType.METHOD)
@Target(ElementType.METHOD,ElementType.CONSTRUCTOR)
具体参考一下javadoc文档

上面一下1和2的源文件,它们都使用了@Documented,@Documented的目的就是让这一个Annotation类型的信息能够显示在javaAPI说明文档上;没有添加的话,使用javadoc生成API文档的时候就会找不到这一个类型生成的信息.
另外一点,如果需要把Annotation的数据继承给子类,那么就会用到@Inherited这一个Annotation类型.

第三部分:下面讲的设计一个最简单的Annotation例子,这一例子共用四个文件;
1、Description.java
代码
 
  1. package  lighter.iteye.com;   
  2.   
  3. import  java.lang.annotation.Documented;   
  4. import  java.lang.annotation.ElementType;   
  5. import  java.lang.annotation.Retention;   
  6. import  java.lang.annotation.RetentionPolicy;   
  7. import  java.lang.annotation.Target;   
  8.   
  9. @Target (ElementType.TYPE)   
  10. @Retention (RetentionPolicy.RUNTIME)   
  11. @Documented   
  12. public   @interface  Description {   
  13.     String value();   
  14. }  
<script type="text/javascript">render_code();</script>

说明:所有的Annotation会自动继承java.lang.annotation这一个接口,所以不能再去继承别的类或是接口.
最重要的一点,Annotation类型里面的参数该怎么设定:
第一,只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型.
第 二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String.
第三,如果只有一个参数成员,参数名称一定要为"value",后加小括号.例:上面的例子就只胡一个参数成员.

 

2、Name.java

代码
 
  1. package  lighter.iteye.com;   
  2.   
  3. import  java.lang.annotation.Documented;   
  4. import  java.lang.annotation.ElementType;   
  5. import  java.lang.annotation.Retention;   
  6. import  java.lang.annotation.RetentionPolicy;   
  7. import  java.lang.annotation.Target;   
  8.   
  9.   //注意这里的@Target与@Description里的不同,参数成员也不同   
  10. @Target (ElementType.METHOD)   
  11. @Retention (RetentionPolicy.RUNTIME)   
  12. @Documented   
  13. public   @interface  Name {   
  14.     String originate();   
  15.     String community();   
  16. }  
<script type="text/javascript">render_code();</script>

 

3、JavaEyer.java

代码
 
  1. package  lighter.iteye.com;   
  2.   
  3. @Description ( "javaeye,做最棒的软件开发交流社区" )   
  4. public   class  JavaEyer {   
  5.      @Name (originate= "创始人:robbin" ,community= "javaEye" )   
  6.      public  String getName()   
  7.     {   
  8.          return   null ;   
  9.     }   
  10.        
  11.      @Name (originate= "创始人:江南白衣" ,community= "springside" )   
  12.      public  String getName2()   
  13.     {   
  14.          return   "借用两位老大的id,写这一个例子,请见谅!" ;   
  15.     }   
  16. }  
<script type="text/javascript">render_code();</script>
4、最后,写一个可以运行提取JavaEyer信息的类TestAnnotation
代码
 
  1.   package  lighter.iteye.com;   
  2.   
  3.    import  java.lang.reflect.Method;   
  4.    import  java.util.HashSet;   
  5.    import  java.util.Set;   
  6.   
  7.    public   class  TestAnnotation {   
  8.      /**  
  9.      * author lighter  
  10.      * 说明:具体关天Annotation的API的用法请参见javaDoc文档  
  11.      */   
  12.         public   static   void  main(String[] args)  throws  Exception {   
  13.        String  CLASS_NAME =  "lighter.iteye.com.JavaEyer" ;   
  14.        Class  test = Class.forName(CLASS_NAME);   
  15.        Method[] method = test.getMethods();   
  16.         boolean  flag = test.isAnnotationPresent(Description. class );   
  17.          if (flag)   
  18.         {   
  19.             Description des = (Description)test.getAnnotation(Description. class );   
  20.             System.out.println( "描述:" +des.value());   
  21.             System.out.println( "-----------------" );   
  22.         }   
  23.            
  24.          //把JavaEyer这一类有利用到@Name的全部方法保存到Set中去   
  25.         Set<Method> set =  new  HashSet<Method>();   
  26.          for ( int  i= 0 ;i<method.length;i++)   
  27.         {   
  28.              boolean  otherFlag = method[i].isAnnotationPresent(Name. class );   
  29.              if (otherFlag) set.add(method[i]);   
  30.         }   
  31.          for (Method m: set)   
  32.         {   
  33.             Name name = m.getAnnotation(Name. class );   
  34.             System.out.println(name.originate());   
  35.             System.out.println( "创建的社区:" +name.community());   
  36.         }   
  37.      }   
  38. }  
<script type="text/javascript">render_code();</script>
5、运行结果:
描述:javaeye,做最棒的软件开发交流社区
-----------------
创始人:robbin
创建的社区:javaEye
创始人:江南白衣
创建的社区:springside

 

这一篇文章写了两个小时有多啦,也算是一篇关于设计自定的Annotation的入门篇啦;另外,特在处声明,如果转载请注明出处:http://lighter.iteye.com。
参考资料:
1、http://java.sun.com/j2se/1.5.0/docs/guide/language/annotations.html
2、http://caterpillar.onlyfun.net/Gossip/
3、http://calvin.iteye.com/blog/33210

分享到:
评论

相关推荐

    Java实战篇:设计自己的Annotation

    ### Java实战篇:设计自己的Annotation #### 一、Java中的内置Annotation类型介绍 在Java的世界里,Annotation(注解)的应用越来越广泛。本文将重点介绍Java 1.5及以后版本中内置的三种常用注解类型及其应用方式...

    Java Annotation

    ### Java Annotation 概述与应用 #### 一、Java Annotation 的定义及作用 Java Annotation(注解)是自 Java 5.0 开始引入的一种语言元素,它为开发者提供了在代码中添加元数据的能力。简单来说,注解就像是对代码...

    java annotation demo

    通过自定义注解和处理器,开发者可以扩展Java平台的功能,实现更灵活和模块化的代码设计。 总结来说,Java注解是增强代码可读性、简化代码维护和提高开发效率的重要工具。通过创建和使用注解,我们可以将元数据嵌入...

    Java实战篇:设计自己的Annotation.pdf

    ### Java实战篇:设计自己的Annotation #### 一、概述 在Java编程中,注解(Annotation)作为一种元数据,能够为代码提供额外的信息,并且在编译时或运行时可以被处理工具读取和利用。自Java 1.5版本引入以来,...

    jar包_javax.annotation.zip

    Java开发中,`jar`包是Java Archive的缩写,是一种可执行的文件格式,用于封装Java...同时,了解和掌握`javax.annotation`中的其他注解,以及IoC和装配Bean的概念,对于提升Java应用的设计质量和可维护性具有重要意义。

    Java自定义注解Annotation的使用

    ### Java自定义注解Annotation的使用 #### 1. 前言 自从JDK 1.5引入了注解这一特性以来,它已经成为Java开发中的一个重要组成部分。注解最初是为了推动EJB 3.0的普及和发展而设计的,其目的是减少配置文件的使用,...

    Annotation注解的介绍和使用

    Annotation是Java平台提供的一种强大的元数据机制,它不仅简化了代码,还极大地增强了代码的表达力和灵活性。通过合理地使用和设计注解,开发者可以构建出更加清晰、易于维护和扩展的软件系统。

    Java语言程序设计源代码

    通过对这些源代码的学习和实践,你可以逐步提升自己的Java编程技能,并了解如何将理论知识应用于实际问题的解决。此外,书中可能还涉及了一些设计模式和最佳实践,这些都是专业开发者的必备素养。 总而言之,《Java...

    JavaAnnotation实例.docx

    ### Java Annotation 实例详解 #### 一、引言 在现代软件开发中,尤其是Java领域,`Annotation`已经成为一种非常重要的编程技术。它不仅能够帮助开发者简化代码编写过程,还能提高程序的可读性和可维护性。本文将...

    Java_Annotation详解

    ### Java_Annotation详解 #### 元数据的作用与分类 元数据在编程中扮演着至关重要的角色,尤其是在Java中,通过注解(Annotation)这一特性,元数据被广泛应用于多个方面,包括但不限于文档生成、代码分析以及编译...

    annotation httpClient(annotation类型应用程序设计举例)

    文档由五篇博客组成,说明了如何使用代理技术实现Annotation HttpClient通过,阅读这五篇博客,应该能够大致了解如何实现一个Annotation类型应用的框架。此外,配备了相应的Annotation HttpClient的源码,以供大家...

    Java程序设计课件 Java程序设计课件

    13. **Java注解(Annotation)**:注解是一种元数据,可以提供编译时和运行时的信息,用于代码的自解释、编译时验证、运行时处理等。 14. **Java标准库API**:Java API包含了大量预定义的类和方法,如集合、I/O、...

    《新编Java语言程序设计》(清华出版社)习题参考答案.rar

    《新编Java语言程序设计》是清华大学出版社出版的一本经典的Java编程教材,旨在帮助学习者掌握Java编程的基础知识和高级特性。这本书包含了丰富的习题,旨在通过实践加深对理论的理解。提供的RAR压缩文件《新编Java...

    免费下载:自己整理的java学习资料

    javaAnnotation.doc java_xml_api.chm JAVA分页大全.txt JAVA设计模式.chm JAVA配置文件编写说明文档.pdf jboss.pdf log4j使用教程.txt struts_action.txt struts标签.chm swing02.doc Tomcat.chm webAndXml.pdf ...

    《Java设计模式》课后习题参考答案-刘伟(20180723).pdf

    此外,为了确保参考资料的权威性,建议读者查阅原书《Java设计模式》以获得更加详尽的解释和说明。如果有任何意见或建议,可以通过提供的电子邮箱与作者联系。在学习设计模式的过程中,理解每一个模式的意图、结构、...

    JAVA程序设计经典代码

    《JAVA程序设计经典代码》是一本深入探讨Java编程的资源集合,主要以PDF格式呈现,旨在帮助开发者理解和掌握Java编程的精髓。这本书包含了大量精心挑选的源代码示例,覆盖了Java语言的关键特性以及实际开发中的常见...

    JAVA 课程设计资料

    【JAVA 课程设计资料】 Java,作为一种广泛使用的高级编程语言,以其“一次编写,到处运行”的特性赢得了全球程序员的喜爱。本资料集旨在提供一个全面的Java学习资源,帮助初学者和有经验的开发者深入理解Java语言...

    JAVA_API1.6文档(中文)

    java.lang 提供利用 Java 编程语言进行程序设计的基础类。 java.lang.annotation 为 Java 编程语言注释设施提供库支持。 java.lang.instrument 提供允许 Java 编程语言代理检测运行在 JVM 上的程序的服务。 java....

Global site tag (gtag.js) - Google Analytics