`
menjoy
  • 浏览: 422180 次
  • 性别: Icon_minigender_1
社区版块
存档分类
最新评论

实战篇:设计自己的Annotation

    博客分类:
  • Java
阅读更多

From:http://lighter.iteye.com

第一部分:了解一下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>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>render_code();</script>

 

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

3、源文件RetentionPolicy.java

代码
  1. public enum RetentionPolicy {   
  2.  SOURCE,   
  3.  CLASS,   
  4.  RUNTIME   
  5. }  
<script>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>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>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>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>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 = </method>new HashSet<method>();   </method>
  26.         for(int i=0;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>render_code();</script>
5、运行结果:
描述:javaeye,做最棒的软件开发交流社区
-----------------
创始人:robbin
创建的社区:javaEye
创始人:江南白衣
创建的社区:springside

 

参考资料:
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.pdf

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

    Java 语言程序设计-进阶篇(原书第10版).pdf

    《Java 语言程序设计-进阶篇》是学习Java编程的高级教程,源自原书第10版,针对已经掌握了Java基础知识的读者,深入探讨了Java的高级特性和技术。这本书涵盖了多个关键知识点,旨在帮助开发者提升Java编程技能,...

    Spring3.x企业应用开发实战(完整版) part1

    第5篇 测试及实战 第16章 实战型单元测试 16.1 单元测试概述 16.1.1 为什么需要单元测试 16.1.2 单元测试之误解 16.1.3 单元测试之困境 16.1.4 单元测试基本概念 16.2 JUnit 4快速进阶 16.2.1 JUnit 4概述 16.2.2 ...

    Spring.3.x企业应用开发实战(完整版).part2

    第5篇 测试及实战 第16章 实战型单元测试 16.1 单元测试概述 16.1.1 为什么需要单元测试 16.1.2 单元测试之误解 16.1.3 单元测试之困境 16.1.4 单元测试基本概念 16.2 JUnit 4快速进阶 16.2.1 JUnit 4概述 16.2.2 ...

    Java学习材料(499篇文章)

    这个压缩包中的499篇文章应该会详细地解释这些知识点,并通过实例代码和实战项目帮助学习者理解和掌握Java编程。对于初学者,可以从基础部分开始,逐步深入;对于有经验的开发者,可以查找特定主题的文章进行深入...

    王者归来之经典篇—ThinkInJava4Th中文版课后习题答案

    通过学习《王者归来之经典篇—ThinkInJava4Th中文版课后习题答案》,无论是初学者还是经验丰富的开发者,都能从中受益,深化对Java编程的理解,提升实战能力。这份资料不仅提供了问题的答案,更是一个学习和探讨Java...

    Android实战——Dagger2一场老板与员工的故事会

    本篇将通过一个“老板与员工的故事”来深入浅出地解析Dagger2的核心概念和使用方法。 首先,我们来理解一下依赖注入(Dependency Injection,简称DI)的基本思想。在软件设计中,对象之间的依赖关系通常会导致代码...

    java核心技术I-II

    11. **设计模式**:常见的设计模式如单例、工厂、观察者、装饰者等及其在实际项目中的应用。 这个压缩包不仅包含了理论知识,还附带了代码示例,这对于理解和掌握Java编程至关重要。通过实战练习,你可以更好地消化...

    Android-框架知识整理之AndroidAOP编程思想

    在Android开发中,AOP(Aspect Oriented Programming,面向切面编程)是一种强大的设计模式,它允许开发者将关注点从核心业务逻辑中分离出来。在本篇内容中,我们将深入探讨Android AOP的概念、实现方式以及它在实际...

    JAVA视频学习顺序

    本篇文章旨在提供一份详尽的JAVA自学指南,根据尚学堂与浪曦视频的学习推荐顺序,帮助初学者高效地掌握JAVA编程技能,避免学习过程中的盲目性和无效努力。通过以下章节的详细介绍,我们将涵盖JAVA学习的基础、进阶...

    springboot-zookeeper-demo.zip

    本篇将详细讲解如何在SpringBoot项目中集成Zookeeper,通过实例代码带你深入理解这一整合过程。 一、Zookeeper基础 Zookeeper是Apache Hadoop的一个子项目,它提供了一种树型的命名空间和分布式同步服务。Zookeeper...

    java顶尖高级技术

    本篇将深入探讨Java的一些关键知识点,旨在帮助开发者提升技能,达到顶尖水平。 1. **并发处理**:Java提供了丰富的并发API,如线程池(ExecutorService)、并发集合(ConcurrentHashMap、CopyOnWriteArrayList)...

    springmybatis

    mybatis实战教程mybatis in action之一开发环境搭建 mybatis实战教程mybatis in action之二以接口的方式编程 mybatis实战教程mybatis in action之三实现数据的增删改查 mybatis实战教程mybatis in action之四实现...

    Java实习报告

    这篇Java实习报告将详细阐述实习过程中的学习与实践经历,以及Java技术在实际项目中的应用。 在实习期间,首先接触的是Java的基础语法,包括数据类型(如基本类型与引用类型)、控制结构(如if语句、for循环、while...

Global site tag (gtag.js) - Google Analytics