2. 注释类型
2.1注释类型简介
J2SE 5.0提供了很多新的特性。其中的一个很重要的特性,就是对元数据(Metadata)的支持。在J2SE5.0中,这种元数据叫作注释(Annotation)。通过使用注释, 程序开发人员可以在不改变原有逻辑的情况下,在源文件嵌入一些补充的信息。
代码分析工具,开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。举个例子,比如说你希望某个方法的参数或者返回值不为空,虽然我们可以在java doc中说明,但是表达同样意思的说法有很多,比如"The return value should not be null"或者"null is not allowed here"。
测试工具很难根据这些语言来分析出程序员所期望的前提条件(PRe-condition)和执行后的条件(Post-condition)。 而使用注释(Annotation),这个问题就可以轻而易举的解决了。
2.2定义注释
J2SE5.0支持用户自己定义注释。定义注释很简单,注释是由@Interface要害字来声明的。比如下面是一个最简单的注释(Annotation)。
清单1一个最简单的注释
public @interface TODO{}
除了定义清单1中的注释以外,我们还可以在注释(Annotation)中加入域定义。方法很简单,不需定义Getter和Setter方法,而只需一个简单的方法,比如:
清单2 为注释加入域
public @interface TODO{
String priority();
}
定义了这个注释之后,我们在程序中引用就可以使用这个注释了。
清单3 使用自定义的注释
@TODO(
priority="high"
)
public void calculate(){
//body omission
}
由于TODO中只定义了一个域,使用TODO的时候,可以简写为
清单4 单域注释的简写
@TODO("high")
类似的,你可以在你的注释(Annotation)类型中定义多个域,也可以为每个域定义缺省值。比如:
清单5定义缺省值
public @interface TODO{
String priority();
String owner();
boolean testable() default true;
}
假如定义了缺省值,在使用的时候可以不用再赋值。比如:
清单6使用定义了缺省值的注释
@TODO(
priority="high",
owner="Catherine"
)
public void calculate(){
//body omission
}
在这个例子中,testable用缺省值true。和上文一样,我们使用Eclipse 3.1作为集成的编译运行环境。Eclipse 3.1提供了向导帮助用户来定义注释。
1.首先我们创建一个Plug-in 项目,com.catherine.lab.annotation.demo。在Package EXPlorer中选中包package com.catherine.lab.annotation.demo。
2.点击New-Other-Java-Annotation,弹出了下面的对话框。4.输入注释的名称,在这里例子中输入TODO, 点击Finish, 图2中的注释就生成了。
图1 创建注释向导
图2 注释向导生成的代码