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

了解annotation

    博客分类:
  • java
阅读更多

Annotationjava的世界正铺天盖地展开,有空写这一篇简单的annotations的文章,算是关于Annotation入门的文章吧,希望能各位们能抛砖,共同学习......

  不讲废话了,实践才是硬道理.

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

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

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

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

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

  第二部分:讲一下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,而不能用classinterface关键字(会不会觉得sun有点吝啬,偏偏搞得与interface这么像).

  2、源文件Retention.java

  代码

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


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

  在上面的文件都用到了RetentionPolicyElementType这两个字段,你可能就会猜到这是两个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文档

  上面一下12的源文件,它们都使用了@Documented,@Documented的目的就是让这一个Annotation类型的信息能够显示在javaAPI说明文档上;没有添加的话,使用javadoc生成API文档的时候就会找不到这一个类型生成的信息.

  另外一点,如果需要把Annotation的数据继承给子类,那么就会用到@Inherited这一个Annotation类型.

第三部分:下面讲的设计一个最简单的Annotation例子,这一例子共用四个文件;

  1Description.java

  代码

package lighter.javaeye.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",后加小括号.:上面的例子就只有一个参数成员.

  2Name.java

  代码

package lighter.javaeye.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();
}


  3JavaEyer.java

  代码

package lighter.javaeye.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.javaeye.com;

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

public class TestAnnotation {
 /**
 * author lighter
 * 说明:具体关天AnnotationAPI的用法请参见javaDoc文档
 */
 public static void main(String[] args) throws Exception {
  String CLASS_NAME = "lighter.javaeye.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());
  }
 }
}

 

分享到:
评论

相关推荐

    自定义的Annotation

    首先,我们要了解Annotation的基本结构。在MapKit框架中,`MKAnnotation`是所有标注的基础协议,它规定了几个关键属性,如坐标(`coordinate`)、标题(`title`)和副标题(`subtitle`)。为了创建自定义的...

    Annotation(注解)详细教程,jdk新特性

    首先,了解Annotation的基本概念。Annotation是一个与程序元素(如类、方法、变量等)关联的元数据标记。它们并不改变程序的运行时行为,但可以被编译器或工具用于生成警告、修改编译过程或执行其他操作。例如,`@...

    Java注解学习1-Java Annotation认知(包括框架图、详细介绍、示例说明)

    首先,了解Annotation的架构至关重要。一个Annotation与一个RetentionPolicy相关联,这意味着每个Annotation实例都有一个特定的保留策略,决定了它在编译过程或运行时的生命周期。例如,SOURCE策略表示注解只在源...

    Annotation HttpClient(如何写Annotation类型的应用框架)

    资源里一共有我的五篇博客组成,主要...博客中描述了主要的流程和思路,对于想了解Annotation如何实现和内部细节的同学会有帮助。此外,提供了Annotation HttpClient的源码,源码中有相应的例子,方便大家进一步理解。

    annotation

    在IT行业中,"annotation"(注解)是一个关键的概念,特别是在Java编程语言中。注解是一种元数据,它提供了在不改变程序代码行为的情况下向编译器或JVM(Java虚拟机)提供信息的方式。注解可以用于简化开发、提供...

    数控编程后处理的系统格式修改.docx

    首先,让我们来了解annotation的概念。Annotation是指在后处理文件中添加的注释,用于描述某些操作或是参数的设置。在上面的内容中,可以看到有很多以#号开头的语句,这些语句都是annotation,系统在执行代码处理时...

    jar包_javax.annotation.zip

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

    自定义annotationProcessor

    首先,让我们了解什么是`annotationProcessor`。`annotationProcessor`,也称为注解处理器,是在Java编译过程中运行的特殊类,它们可以在源代码级别生成额外的Java类。这通常用于实现代码生成,例如根据注解生成DAO...

    Annotation--学习:JDK内建Annotation

    在本篇中,我们将深入探讨JDK内置的Annotation,了解它们的用途、工作原理以及如何在实际开发中应用。 1. **注解的基本概念** 注解是一种特殊类型的声明,可以附加到类、接口、字段、方法、构造器等程序元素上。...

    struts2 使用Annotation 配置的小例子

    首先,让我们了解什么是Annotation。在Java中,Annotation是一种元数据,它提供了一种安全的方式向编译器、JVM或者第三方工具提供信息。在Struts2中,Annotation允许开发者无需XML配置文件就能定义Action、结果类型...

    基于annotation的aop实现

    首先,了解什么是AOP。AOP的核心概念是“切面”(Aspect),它封装了跨越多个对象的行为或责任。切面可以包含通知(Advice)、切点(Pointcut)和织入(Weaving)。通知定义了在特定时刻执行的代码,切点定义了通知...

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

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

    struts annotation Hello World

    首先,让我们了解一下Struts框架。Struts 2是一个基于MVC(Model-View-Controller)设计模式的Web应用框架,旨在简化创建功能丰富的、可维护的Java Web应用程序。它通过提供一套全面的控制层组件,帮助开发者处理...

    自定义Annotation例子

    首先,了解如何定义一个自定义Annotation。在Java中,Annotation定义类似于接口,使用`@interface`关键字。以下是一个简单的自定义Annotation例子: ```java public @interface MyAnnotation { String value() ...

    ArcGIS Annotation

    在探讨“ArcGIS Annotation”这一主题时,我们深入解析了其在地理信息系统(GIS)领域中的应用与价值。...了解和掌握ArcGIS Annotation的使用技巧,对于地理信息系统专业人士而言,是不可或缺的一项技能。

    hibernate annotation 中文文档

    《Hibernate Annotation 中文文档》是Java开发者们的重要参考资料,它详细介绍了如何在Hibernate框架中使用注解进行对象关系映射...阅读《Hibernate Annotation 中文文档》PDF,将帮助你更全面地了解和掌握这些知识点。

    TsignRecgTrain4170Annotation.rar

    首先,我们来了解一下卷积神经网络的基础知识,然后详细解析这个数据集的内容和结构。 卷积神经网络(Convolutional Neural Network,简称CNN)是一种特殊的深度学习模型,它在图像处理和计算机视觉任务中表现出色...

Global site tag (gtag.js) - Google Analytics