java annotation类型

最新推荐文章于 2024-10-03 17:30:19 发布

ShanRui_

最新推荐文章于 2024-10-03 17:30:19 发布

阅读量1.3k

点赞数

分类专栏： Java

Java 专栏收录该内容

26 篇文章 0 订阅

订阅专栏

本文转载至 http://blog.csdn.net/laixiaonian/article/details/8814100

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

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

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

1、源文件Target.java
  Java代码
  @Documented
  @Retention(RetentionPolicy.RUNTIME)
  @Target(ElementType.ANNOTATION_TYPE)
  public @interface Target {
     ElementType[] value();
  }

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

其中的@interface是一个关键字，在设计annotations的时候必须把一个类型定义为@interface，而不能用class或interface关键字

2、源文件Retention.java
  Java代码
  @Documented
  @Retention(RetentionPolicy.RUNTIME)
  @Target(ElementType.ANNOTATION_TYPE)
  public @interface Retention {
     RetentionPolicy value();
  }

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

3、源文件RetentionPolicy.java
  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
  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
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
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、hzu_OpenSource.java
Java代码
  package lighter.iteye.com;

  @Description("Hzu_OpenSource,做最好的Java就业实训")
  public class hzu_OpenSource {
      @Name(originate="主办方：菏泽学院计算机与信息工程系",community="java就业实训")
      public String getName()
      {
          return null;
      }

      @Name(originate="主办方：北京开源汇智",community="java就业实训")
      public String getName2()
      {
          return "java，我的人生路！";
      }
  }

}
4、最后，写一个可以运行提取hzu_OpenSource信息的类TestAnnotation
Java代码
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.hzu_OpenSource";
       Class test = Class.forName(CLASS_NAME);

       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中去
        Method[] method = test.getMethods();
        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、运行结果