`

设计自己的Annotation

    博客分类:
  • java
阅读更多

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

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

  第一部分:了解一下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 {
 /**
 *
 * 说明:具体关天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

分享到:
评论

相关推荐

    Java实战篇:设计自己的Annotation

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

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

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

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

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

    jar包_javax.annotation.zip

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

    基于C#的Ink Canvas Annotation For WSZYZ画板工具设计源码

    本项目是基于C#的Ink Canvas Annotation For WSZYZ画板工具设计源码,包含351个文件,其中包括106个PNG文件、88个CS文件、60个XAML文件、30个SVG文件、28个AI文件、10个DLL文件、9个JPG文件、7个RESX文件和2个ICO...

    Annotation注解的介绍和使用

    ### Annotation注解的深入解析与应用 #### 一、Annotation概览 ##### 1.1 何为元数据 元数据,在计算机科学中,是指用于描述数据的数据,它提供了关于数据本身的附加信息,有助于理解、解释和管理数据。在编程...

    基于annotation的aop实现

    在Java世界中,面向切面编程(AOP)是一种强大的设计模式,它允许程序员将关注点从核心业务逻辑中分离出来,比如日志、事务管理等。基于Annotation的AOP实现是Spring框架的一个重要特性,它极大地简化了AOP的使用。...

    struts annotation Hello World

    Struts 2是一个基于MVC(Model-View-Controller)设计模式的Web应用框架,旨在简化创建功能丰富的、可维护的Java Web应用程序。它通过提供一套全面的控制层组件,帮助开发者处理HTTP请求、业务逻辑和视图展示。 在...

    ArcGIS Annotation

    ArcGIS Annotation不仅是地图设计和信息传达的重要组成部分,也是提升地图交互性和专业性的关键手段。通过合理选择和利用不同的注记类型,地图制作者能够创建出既美观又实用的地图作品,满足各种GIS项目的需求。了解...

    Java Annotation

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

    前端开源库-get-annotation

    "get-annotation"库就是为了简化这一过程而设计的,它能够自动从源代码中抓取这些注释,便于进一步的处理和利用。 这个库支持解析不同类型的注释,包括JSDoc风格的注释,这种注释格式常用于文档生成工具,如JSDoc...

    cnn_annotation.zip

    注释可能解释了网络结构设计的原因、数据预处理的目的或训练过程中的关键参数设置。 7. **异常处理**:在Python中,使用`try-except`语句来捕获并处理可能出现的错误,确保程序的健壮性。 8. **模块导入**:文件...

    TsignRecgTrain4170Annotation.rar

    2. 构建模型:设计一个包含卷积层、池化层和全连接层的CNN架构,可以参考现有的成功模型如VGG、ResNet或Inception系列。 3. 训练模型:使用训练集进行多轮迭代,调整学习率和优化器参数,以最小化损失函数。 4. 验证...

    annotationProcessor.rar

    在Java编程语言中,注解(Annotation)是一种元数据,它提供了一种安全的方法来将信息附加到代码中,而不改变代码的行为。注解处理器则是注解系统的关键组成部分,它们在编译期间运行,可以分析源代码中的注解并自动...

    Hibernate Annotation库

    虽然主要设计用于EJB(Enterprise JavaBeans)环境,但在Hibernate中也常被用到,因为它提供了JPA规范的实现,如`@Column`、`@JoinColumn`等,这些注解允许开发者进一步细化实体属性与数据库列的映射,同时支持查询...

    java annotation demo

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

    安卓Annotation实例

    - 与编程模式结合:注解应与设计模式和最佳实践相结合,提高代码质量。 这个“安卓Annotation实例”应该包括了创建`MyAnnotation`,编写对应的处理器,以及如何在代码中使用和处理该注解的示例。通过深入理解和...

    Hibernate继承映射(annotation)

    **标题:“Hibernate继承映射(Annotation)详解”** 在Java持久化框架Hibernate中,继承映射是一种关键特性,它允许开发者将对象模型的继承结构映射到数据库的表结构。在传统的面向对象编程中,继承是实现代码复用和...

Global site tag (gtag.js) - Google Analytics