`
hanqunfeng
  • 浏览: 1543461 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

JDK5 Annotation(注释)的用法

    博客分类:
  • JAVA
阅读更多

原文地址:http://hi.baidu.com/gaoyaodi/blog/item/4cee6cf4706f2dddf3d385cd.html

第一部分:了解一下java1.5起默认的三个annotation类型:

  一个是@Override:只能用在方法之上的,用来告诉别人这一个方法是改写父类的。

  一个是@Deprecated:建议别人不要使用旧的API的时候用的,编译的时候会用产生警告信息,可以设定在程序里的所有的元素上.

  一个是@SuppressWarnings:这一个类型可以来暂时把一些警告信息消息关闭.

  如果不清楚上面三个类型的具体用法,各位可以baidu或google一下的,很简单的。

第二部分:讲一下annotation的概念,再来讲一下怎样设计自己的annotation.

  首先在jdk自带的java.lang.annotation包里,打开如下几个源文件:

  1、源文件Target.java

  代码

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
 ElementType[] value();
}


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

  2、源文件Retention.java

  代码

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention {
 RetentionPolicy value();
}


  看到这里,大家可能都模糊了,都不知道在说什么,别急,往下看一下.

  在上面的文件都用到了RetentionPolicy,ElementType这两个字段,你可能就会猜到这是两个java文件.的确,这两个文件的源代码如下:

  3、源文件RetentionPolicy.java

  代码

public enum RetentionPolicy {
 SOURCE,
 CLASS,
 RUNTIME
}


  这是一个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

  代码

public enum ElementType {
 TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR,
 LOCAL_VARIABLE, ANNOTATION_TYPE,PACKAGE
}


  @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

  代码

package lighter.iteye.com;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Description {
 String value();
}


  说明:所有的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

  代码

package lighter.iteye.com;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

//注意这里的@Target与@Description里的不同,参数成员也不同
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Name {
 String originate();
 String community();
}


  3、JavaEyer.java

  代码

package lighter.iteye.com;

@Description("javaeye,做最棒的软件开发交流社区")
public class JavaEyer {
 @Name(originate="创始人:robbin",community="javaEye")
 public String getName()
 {
  return null;
 }

 @Name(originate="创始人:江南白衣",community="springside")
 public String getName2()
 {
  return "借用两位的id一用,写这一个例子,请见谅!";
 }
}


  4、最后,写一个可以运行提取JavaEyer信息的类TestAnnotation

  代码

package lighter.iteye.com;

import java.lang.reflect.Method;
import java.util.HashSet;
import java.util.Set;

public class TestAnnotation {
 /**
 * author lighter
 * 说明:具体关天Annotation的API的用法请参见javaDoc文档
 */
 public static void main(String[] args) throws Exception {
  String CLASS_NAME = "lighter.iteye.com.JavaEyer";
  Class test = Class.forName(CLASS_NAME);
  Method[] method = test.getMethods();
  boolean flag = test.isAnnotationPresent(Description.class);
  if(flag)
  {
   Description des = (Description)test.getAnnotation(Description.class);
   System.out.println("描述:"+des.value());
   System.out.println("-----------------");
  }

  //把JavaEyer这一类有利用到@Name的全部方法保存到Set中去
  Set<Method> set = new HashSet<Method>();
  for(int i=0;i<method.length;i++)
  {
   boolean otherFlag = method[i].isAnnotationPresent(Name.class);
   if(otherFlag) set.add(method[i]);
  }
  for(Method m: set)
  {
   Name name = m.getAnnotation(Name.class);
   System.out.println(name.originate());
   System.out.println("创建的社区:"+name.community());
  }
 }
}


  5、运行结果:

  描述:javaeye,做最棒的软件开发交流社区
  -----------------
  创始人:robbin
  创建的社区:javaEye
  创始人:江南白衣
  创建的社区:springside

分享到:
评论

相关推荐

    java1.5 annotation注释源代码

    然后在类、方法或变量上使用这个注解: ```java @MyAnnotation(value = "Hello, Annotation!") public class MyClass { // ... } ``` 通过反射API获取注解信息: ```java Class&lt;MyClass&gt; clazz = MyClass.class;...

    jdk注释讲解

    ### JDK注释详解:深入理解Java中的注解 在Java开发中,注解(Annotation)是一种重要的元数据机制,用于向编译器、工具或框架提供额外的信息,从而增强代码的功能性和可读性。本文将从JDK源注释出发,深入解析三种...

    JDK1.5 注释语法(Annotations)新鲜试用

    在本文中,我们将深入探讨JDK 1.5的注释语法,并通过实例来理解其用法。 注释的三种类型: 1. **保留注解(Retention)**:根据保留策略,注释可以存在于源代码、字节码或运行时。`@Retention(RetentionPolicy....

    jdk1.5 tiger java5 新特性

    此外,Java 5引入了注解(Annotation),用于在代码中添加元数据。例如,`@Override`注解确保方法覆盖父类方法,`@Deprecated`标记过时的方法,`@ SuppressWarnings`则可以抑制特定类型的编译警告。注释处理允许工具...

    离线JDK9中文版 | API_jdk-9.CHM

    Java开发工具包(Java ...开发者可以使用这个离线CHM文件快速查询任何Java 9 API的功能、用法和示例,为日常开发工作提供便利。通过深入理解和熟练运用这些API,可以提高代码质量,减少错误,同时提升开发效率。

    Annotation与Javadoc比较1

    Annotation是Java中的元数据,从JDK5开始引入,它为代码提供了附加信息,这些信息可以被编译器、构建工具或运行时环境使用。Annotation可以用来进行编译时检查,如`@Override`用于确保方法覆盖了超类方法,`@...

    JDK中文版API

    **注解(Annotation)**是JDK5引入的新特性,如`@Override`表示方法重写,`@Deprecated`标记过时的方法,`@ SuppressWarnings`抑制编译器警告。 总的来说,**JDK中文版API**是学习和掌握Java技术体系的重要资源,它...

    北京圣思园 Annotation pdf文档

    根据给定的文件信息,我们将介绍Java注解(Annotation)的相关知识点,包括其定义、使用方法、内建注解以及高级特性。 首先,我们来看看Java注解的由来。在Java 5.0版本发布之前,程序员通常需要使用注释(Comments...

    java Annotation 注解

    Java Annotation,也称为注解,是Java编程语言中的一种元数据机制,自JDK 5.0开始引入。注解提供了在源代码中嵌入元数据的能力,这些元数据可以被编译器、构建工具或者运行时环境用来处理代码。它们在代码中看起来...

    Java JDK实例宝典

    全部代码出自电子工业出版社夏先波的《Java JDK实例宝典》一书,本书以J2SE 5.0为开发环境,选取Java应用的典型实例,循序渐进地介绍了Java语言的各种开发方法和技巧,实例代码注释详细规范,思路清晰。 第1章 ...

    java的开发类库jdk的帮助文档

    5. **注释类型(Annotation Types)**:注释是元数据的一种形式,可以附加到代码的各种元素上,以提供编译器或工具使用的额外信息。例如,`@Override`注释用于表明方法是重写父类方法的。 6. **异常(Exceptions)*...

    第-章-JAVA反射和注释优秀文档.pptx

    注释(Annotation)是Java提供的一种元数据,用于向编译器或JVM提供关于代码的额外信息。注释可以用于配置、编译时检查、运行时处理等。Java提供了预定义的注释类型,如@Override、@Deprecated,同时也允许用户...

    java初学者完整代码+注释2

    Java编程语言是软件开发领域广泛使用的编程语言,尤其适合初学者入门。这个“java初学者完整代码+注释2”压缩包提供了21课的学习内容,涵盖了Java的基础知识,包括语法、数据类型、控制结构、类与对象等关键概念。 ...

    JDK_API_1_6_zh_CN_downcc.com.zip 良心一级分

    java.lang.annotation 为 Java 编程语言注释设施提供库支持。 java.lang.instrument 提供允许 Java 编程语言代理检测运行在 JVM 上的程序的服务。 java.lang.management 提供管理接口,用于监视和管理 Java 虚拟机...

    JDK_1_6 API

    java.awt.im.spi 提供启用可以与 Java 运行时环境一起使用的输入方法开发的接口。 java.awt.image 提供创建和修改图像的各种类。 java.awt.image.renderable 提供用于生成与呈现无关的图像的类和接口。 java.awt....

    想自己写框架?不了解Java注解(Annotation)机制可不行,来跟我一起通过源码深入Java注解机制

    它可以声明在包、类、字段、方法、局部变量、方法参数等的前面,用来对这些元素进行说明,注释。 在JDK中定义了许多注解,其作用大致可以分为以下几类: 编写文档:通过代码里标识的元数据生成文档【生成文档doc文档...

    [Java参考文档].JDK_API 1.6

    java.awt.im.spi 提供启用可以与 Java 运行时环境一起使用的输入方法开发的接口。 java.awt.image 提供创建和修改图像的各种类。 java.awt.image.renderable 提供用于生成与呈现无关的图像的类和接口。 java.awt....

    全面解析Java注解

     对于Java开发人员来说,在编写代码时,除了源程序以外,我们还会使用Javadoc标签对类、方法或成员变量进行注释,以便使用Javadoc工具生成和源代码配套的Javadoc文档。这些@param、@return等Javadoc标签是注解标签...

    Java Annotation Overview详解

    自JDK 5开始,Java引入了元数据支持,即注解。我们可以通过自定义注解来扩展其功能。 创建自定义注解的步骤如下: 1. 使用`@interface`关键字定义注解,如: ```java public @interface MyAnnotation { String ...

Global site tag (gtag.js) - Google Analytics