Java注解之Retention、Documented、Inherited介绍

retention注解

retention(保留)注解说明,这种类型的注解会被保留到那个阶段. 有三个值:
1.retentionpolicy.source —— 这种类型的annotations只在源代码级别保留,编译时就会被忽略
2.retentionpolicy.class —— 这种类型的annotations编译时被保留,在class文件中存在,但jvm将会忽略
3.retentionpolicy.runtime —— 这种类型的annotations将被jvm保留,所以他们能在运行时被jvm或其他使用反射机制的代码所读取和使用.
示例5演示了 retentionpolicy.runtime 的声明:

java注解的示例1:

@retention(retentionpolicy.runtime)
public @interface test_retention {
   string dotestretention();
}

在这个示例中, @retention(retentionpolicy.runtime)注解表明 test_retention注解将会由虚拟机保留,以便它可以在运行时通过反射读取.

documented 注解

documented 注解表明这个注解应该被 javadoc工具记录. 默认情况下,javadoc是不包括注解的. 但如果声明注解时指定了 @documented,则它会被 javadoc 之类的工具处理, 所以注解类型信息也会被包括在生成的文档中. 示例6进一步演示了使用 @documented:

java注解的示例2:

@documented
public @interface test_documented {
   string dotestdocument();
}

接下来,像下面这样修改testannotations类:

public class testannotations {
   public static void main(string arg[]) {
      new testannotations().dosometestretention();
      new testannotations().dosometestdocumented();
   }
   @test_retention (dotestretention="保留注解信息测试")
   public void dosometestretention() {
      system.out.printf("测试注解类型 'retention'");
   }
   @test_documented(dotestdocument="hello document")
   public void dosometestdocumented() {
      system.out.printf("测试注解类型 'documented'");
   }
}

现在,如果你使用 javadoc命令生成 testannotations.html文件,你将看到类似于图1的结果.

从截图可以看到,文档中没有 dosometestretention() 方法的 annotation-type信息()方法. 但是, dosometestdocumented() 方法的文档提供了注解的描述信息. 这是因为 @documented标签被加到了test_documented注解上. 之前的注解test_retention并没有指定 @documented 标记(tag).

inherited 注解(这段可能有问题...)

这是一个稍微复杂的注解类型. 它指明被注解的类会自动继承. 更具体地说,如果定义注解时使用了 @inherited 标记,然后用定义的注解来标注另一个父类, 父类又有一个子类(subclass),则父类的所有属性将被继承到它的子类中. 在示例7中,你会看到使用 @inherited 标签的好处.

java注解的示例3

首先,定义你的注解:

@inherited
public @interface myparentobject {
      boolean isinherited() default true;
      string dosomething() default "do what?";
}

接下来,使用注解标注了一个类:

@myparentobject
public class mychildobject {
}

正如你看到的,你不需要在实现类中定义接口方法. 因为使用 @inherited标记，这些都自动继承了. 如果你使用一种古老的方式定义实现类,会是什么样子呢? 看看下面这张 古老的实现方式吧:

public class mychildobject implements myparentobject {
   public boolean isinherited() {
      return false;
   }
   public string dosomething() {
      return "";
   }
   public boolean equals(object obj) {
      return false;
   }
   public int hashcode() {
      return 0;
   }
   public string tostring() {
      return "";
   }
   public class annotationtype() {
      return null;
   }
}

看到的区别吗? 可以看到,你必须实现父接口的所有方法. 除了isinherited()和从myparentobject dosomething()方法外,你还需要实现 java.lang.object的 equals(),tostring()和hascode()方法. 还有 java.lang.annotation.annotation 类的 annotationtype()方法. 不管你是不是想要实现这些方法,你必须在继承的对象中包含这些.

结论

本文向你展示了如何通过使用jdk5的注解功能使开发更容易. 注解不直接影响程序的语义. 开发和部署工具可以以某种方式阅读这些注解并处理它们,使用包含注解的程序可以替代额外的java源文件、xml文档或其他古老的构件.  使用注解可以使用更少的代码完成同样的事情,并且有更好的编译时错误检测机制. 注解的目的是花更少的时间在那些死硬无用的细节中,更多地关注业务逻辑规则. 本文是java注解系列的第一部分. 在第二部分中,你将了解如何使用注解来开发一个简单的web应用程序. 最后,在第三部分中,你会看到一个包括多个数据库表的复杂示例.