J2SE1.5 注释语法
程序员文章站
2024-02-22 08:54:22
说起注解语法,对于任何一个java开发人员来说都已经耳熟能详了,我们每天都在使用着 @author, @param,等等编写注释,然后用javadoc生成文档。java的这...
说起注解语法,对于任何一个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(){
}
使用标签最终是为了帮助开发人员提取注释信息,然后根据不同需求做进一步处理,下面我们来看看如何获取注释信息。
=============================================================================
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
好了,tiger新的注释语法基本用法就这么简单,基本用法虽然简单,但是获取注释信息之后如何处理确很值得推敲,我们可以用他们来做一些语法检查,文件相关性检查,进行各种统计等等。关于更多的tiger新注释语法的信息,可以访问[link=http://java.sun.com/j2se/1.5.0/docs/guide/language/annotations.html]。
以上代码在win2k + j2se5 ga下通过。
我们先谈谈注释语法本身,它有时候也称为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(){
}
使用标签最终是为了帮助开发人员提取注释信息,然后根据不同需求做进一步处理,下面我们来看看如何获取注释信息。
=============================================================================
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
好了,tiger新的注释语法基本用法就这么简单,基本用法虽然简单,但是获取注释信息之后如何处理确很值得推敲,我们可以用他们来做一些语法检查,文件相关性检查,进行各种统计等等。关于更多的tiger新注释语法的信息,可以访问[link=http://java.sun.com/j2se/1.5.0/docs/guide/language/annotations.html]。
以上代码在win2k + j2se5 ga下通过。