当前页面: 开发资料首页 → J2SE 专题 → J2SE5.0实例---注释(annotation)

J2SE5.0实例---注释(annotation)

摘要: J2SE5.0实例---注释(annotation)

J2SE 5.0通过引入注释(Annotation)的概念添加了对元数据的支持。

一个@xxx形式的注释可以当成一个修饰符来使用，它可以放在任何一个修饰符可以出现的地方。public,static,final都是java语言的修饰符，注释可以写在它们可以出现的任何地方。

举个例子，可以看下面一段代码：

public class AnnotationExample {

public @Override int hashCode() {

return super.hashCode();

}

</td></tr></table>

在这个例子中我们使用了一个java语言API中已经有定义的注释@Override，通过在方法hashCode()中使用这个注释，说明了hashCode是一个覆盖了父类方法的方法。

至于注释的具体含义我们在以后部分会说明。

如果你想使用一个类，你必须首先找到它的定义，或者你自己对它进行定义。注释也是需要定义的，随便在代码中插入一个@XXX之类的注释是不能够通过编译的。

一个最简单的Annotation定义类似于接口的定义，就象下面的代码：

public @interface Info {

}

</td></tr></table>

正如你所看到的，里面什么都没有，但是即使是这样，我们也可以在程序里使用它：

public @Info String information;

</td></tr></table>

这样的一种什么都没有定义的空注释我们称为标记注释（marker annotations）。

我们可以在其中添加一个成员的定义：

public @interface Info {

String author();

}

</td></tr></table>

这里值得注意的一点是，注释类中方法的定义不能是私有的，如果你不在前面加public关键字，编译器会默认为它是公有的。

在添加上author的定义后，原来那种只写了一个@Info的注释就必须修改了，之后的注释必须这样写：

public @Info(author="myname") void afunction() {

}

</td></tr></table>

一个注释的成员可以有默认值：

public @interface Info {

String author() default "myname";

}

</td></tr></table>

使用默认值有什么好处呢？我们可以重新这样写了：

public @Info void afunction() {

}

</td></tr></table>

在做标记时，如果确认某个成员的值和它的默认值相同，我们就可以忽略它，而不必显式地给每个成员赋值，这样就减轻了代码量。

如果我们添加的这个成员名字叫做value的话，也就是：

public @interface Info {

String value();

}

</td></tr></table>

就有了另外一种注释的用法：我们可以直接写出这样的注释@Info(“information”)，而不必写@Info(value=”information”)，括号里的值会自动传递给value。这样的一种注释称为单一值注释（Single-value annotations）

一个注释可以有很多类型不同的成员，这样的一种注释称为完整注释（full annotations）。

一个注释中的成员类型只能够是原生类型，字符串，Class类型，注释类型，枚举类型，或者一维数组。

假设我们现在有一个注释定义：

public @interface Company {

String value();

}

</td></tr></table>

现在我们希望定义另外一个注释，这个注释类型反映了一个人的信息：

public @interface Person {

public enum Gender{MALE,FEMALE};

String name();

int age();

Company company();

Gender gender() default Gender.MALE;

String description() default "";

}

</td></tr></table>

在程序代码中添加这种类型的注释时可以这么写：

@Person(age=23,name="MyName",gender=Person.Gender.FEMALE, company=@Company("Foo Corporation"))

</td></tr></table>

在java.lang包中定义了三种注释，分别是：

n Deprecated：和过去javadoc中@deprecated含义相同

n Override：表示方法覆盖了父类中的方法

n SuppressWarnings：使用这个注释可以使编译器忽略特定类型的警告信息

具体含义可以参照api文档。

我们知道，注释的引入，为java语言添加了元数据的表达方式，而元数据就是关于数据的数据。在java中，还有关于注释的注释，我们相应的称之为元注释（meta-annotations）

在java中，我们可以使用4种预先定义的注释对注释定义进行注释，这4种注释是：

n Target：指明注释可以在哪些代码段中使用，以避免对注释的误用。

n Retention：说明编译器在编译和运行时是否忽略该种注释

n Documented：说明注释是否出现在Javadoc中

n Inherited:当我们在一个类中使用了某种注释，有时候会希望将来它的所有子类中都包含有该种注释信息，如果在注释定义中添加了@Inherited，那么这种注释就会被调用者的子类继承

当我们在一个类中使用注释定义了一系列的元数据之后，我们应该如何获取这些元数据呢？我们通过下面的例子来说明。

Annotation的定义仍然使用列出来的两个，因为我们需要在获得类文件中的注释信息，所以必须在注释定义中添加Retention注释。

首先我们定义两个注释，注释Todo说明了还有什么事情需要做：

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)

public @interface Todo {

String value();

}

</td></tr></table>

注释Author说明了一个方法或者类的定义者：

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)

public @interface Author {

public enum Gender{MALE,FEMALE};

String name();

String email();

Gender gender() default Gender.MALE;

}

</td></tr></table>

然后我们在一个简单的类中添加这两种类型的注释：

public @Todo("delete this class") class Foo {

public void methodA(){}

public @Author(name="B",email="b@Foo.com") void methodB(){

}

public @Author(name="A",email="a@Foo.com") String fieldA;

}

</td></tr></table>

通过下面一段代码我们可以提取相应的元数据：

import java.lang.reflect.Method;

public class GetAnnotations {

public static void main(String[] args) {

try {

Class<?> klass=Class.forName(args[0]);

if(klass.isAnnotationPresent(Todo.class))

{

Todo t=klass.getAnnotation(Todo.class);

System.out.println(t);

}

for(Method m:klass.getMethods())

{

if(m.isAnnotationPresent(Author.class))

{

Author a=m.getAnnotation(Author.class);

System.out.printf("Method:%s,Author:%s%n",m.getName(),a);

}

} catch (ClassNotFoundException e) {

e.printStackTrace();

}

</td></tr></table>

使用下面的命令行运行程序：

java GetAnnotations Foo

</td></tr></table>

运行结果如下：

@Todo(value=delete this class)

Method:methodB,Author:@Author(gender=MALE, name=B, email=b@Foo.com)

</td></tr></table>

↑返回目录
前一篇: J2SE 5.0新功能
后一篇: J2SE 5.0实例---静态引入