J2SE 1.5的注释语法
副标题#e#
说起注解语法,对付任何一个Java开拓人员来说都已经耳熟能详了,我们天天都在利用着 @author, @param,等等编写注释,然后用javadoc生成文档。Java的这种利便的文档生成要领受到了开拓者的普遍赞誉。而从JDK1.5开始,注释语法提供了更为强大的成果。
我们先谈谈注释语法自己,它有时候也称为meta-data :“描写数据的数据” 。一般来说它们可以被用来生成文档,查抄代码间依赖干系,辅佐编译器作语法查抄。时下较量风行的东西有Xdoclet等。对付文档生成早已经有了javadoc东西的完美表示,而对付代码查抄,如今java也提供了语言级的支持。
我们知道,javadoc是通过提取java源文件中的标签信息来生成文档。所以要进修新的注释语法,们首先要熟悉的就是新增的标签。新的注释语法支持两种标签,系统尺度标签和用户自界说标签。标签的标记也原先一样,@标记加上标签名字。我们先从JDK1.5自带的尺度标签说起。
首先先容@override , 也不消多罗嗦,顾名思义了,就是用来说明要领覆载的。我们假设有一个子类必需要覆载父类的要领.
public class Parent{
public void foo(){
System.out.println("Original Implementation of foo");
}
}
public class Child extends Parent{
@Override
public void foo(){
System.out.println("Overide Implementation of foo");
}
}
今朝为止我们看不出来这个@Override给我们带来了任何长处,所以我们先说说加个这个标签后,我们用javac编译的时候编译器执行了些什么呢?编译器会查抄这个要领,然后从父类查找是否有这个要领,不然就编译堕落。这个特性可以辅佐我们制止一些初级错误。上面这个例子,子类想覆载foo()要领,不外你大概一时疏忽把它写成了fob(), 对付这样的”初级错误”,假如你没有在前期就发明的话,到系统集成测试的时候,大概会化上你几个小时甚至一两天去找出这样的bug。此刻好了,编译器在编译的时候就会给堕落误,
Child.java:3: method does not override a method from its superclass
@Override
^
1 error
怎么样,这个成果还不错吧。
看过了尺度标签的利用要领,我们来看看用户自界说标签。首先先容@interface, 它用于界说新的注释范例(annotation type)。新建一个注释范例看起来和界说一Interface 没有什么两样,MyTag.java用于新建一个用户自界说标签,代码如下,
package tiger.annotation;
/**
* 用户自界说标签??MyTag
*/
public @interface MyTag { }
界说了一个tag之后,我们就可以在任何java文件中利用这个tag了,
import tiger.annotation.MyTag;
public class TagTest{
@MyTag
public void testTag(){
}
}
注释范例还可以有成员变量,
package tiger.annotation;
/**
* 用户自界说标签??带有成员变量的MyTag
*/
public @interface MyTag {
String name();
int age();
}
然后我们可以这么利用这个标签,
@MyTag(name="MyTag",age=1)
public void testTag(){
}
#p#副标题#e#
利用标签最终是为了辅佐开拓人员提取注释信息,然后按照差异需求做进一步处理惩罚,下面我们来看看如何获取注释信息。
import java.lang.annotation.Annotation;
import tiger.annotation.MyTag;
public class TagTest{
@MyTag(name="MyTag",age=1)
public void test(){
}
public static void main(String[] args){
TagTest tt = new TagTest();
try {
Annotation[] annotation =tt.getClass().getMethod("test").getAnnotations();
for (Annotation tag :annotation) {
System.out.println("Tag is:" + tag);
System.out.println("tag.name()" + ((MyTag)tag).name());
System.out.println("tag.age()" + ((MyTag)(tag)).age());
}
} catch(NoSuchMethodException e) {
e.printStackTrace();
}
}
}
需要留意的一点是,在执行这段代码之前我们尚有一点小事情要做,还需要给我们的自界说标签MyTag加上一个说明标签,@ Retention, 表白注释信息将可以在运行时刻通过反射机制获得。假如不插手这个标签,上面的代码将没有任何输出。修改今后的MyTag如下:
/**
* 用户自界说标签??带有成员变量的MyTag
*/
@Retention(RetentionPolicy.RUNTIME)
public @interface MyTag {
String name();
int age();
}
然后我们执行TagTest可以获得输出如下,
Tag is:@tiger.annotation.MyTag(name=MyTag, age=1)
tag.name()MyTag
tag.age()1
#p#分页标题#e#
好了,Tiger新的注释语法根基用法就这么简朴,根基用法固然简朴,可是获取注释信息之后如那里理惩罚确很值得推敲,我们可以用他们来做一些语法查抄,文件相关性查抄,举办各类统计等等。关于更多的Tiger新注释语法的信息,可以会见[link=http://java.sun.com/j2se/1.5.0/docs/guide/language/annotations.html]。
以上代码在win2k + j2se5 GA下通过。