科技时代新浪首页 > 科技时代 > 学园 > 正文

Java批注的发明起因及代码应用实例


http://www.sina.com.cn 2006年05月25日 09:46 ZDNet China

  作者: DJ Walker-Morgan

  批注能够消除样板代码,让源代码的可读性更高,并能提供级别更高的错误检查。从EJB3到JUnit4,哪里都在使用它。本文就将告诉你如何使用它。

  Java 5向Java引入了批注(Annotations),它的使用迅速成为现代Java开发中不可缺少
的一部分。在正式开始介绍它之前,看看为什么要发明批注,这是非常值得的。

  自从Java诞生之日起,人们就一直在解决它初期忽视了的一些问题:缺少元数据;缺乏将Java以外的代码嵌入到Java源代码文件里的能力等。当Java面市的时候,针对这些问题而推出的JavaDoc终于让它变完整了。JavaDoc使用了在代码里专门标记注释的概念,从而让它能够提取出额外的信息,说具体点就是文档,并将它转换成为我们熟悉的JavaDoc文档。这是一项简单的技术,人人都可以使用。首先会有Doclet,目的是让人们扩展文档的输出。然后是Xdoclet,它像使用标记一样使用JavaDoc来生成代码,从而将整个过程变得轻而易举。这部分是对J2EE的复杂性的回应。J2EE原来依靠很多样板代码(boilerplate code)把对象捆绑到J2EE框架里。但是这些方案都有一些问题。首先,注释里的标记从来都不会进入最终的源代码,所以除非你生成代码来反映这些标记,否则你无法在运行期间查找到它。其次,它会把整个预处理层加到(在理想情况下应该是)一个简单编译过程里。最后,基于注释的标记在编译期间并不是很容易检查,也无法轻易被很多IDE检查;如果你把注释标记拼写错了,编译器是不会注意到的,编译器只会关注那些它知道确切名字的标记。

  要解决这所有的问题,Java新增了批注。批注是用于Java语言的本机元数据标记。它们的输入严格与Java语言的其他部分类似,可以通过反映被发现,更容易地让IDE和编译器的编写者管理。现在就让我们看一些被批注的代码吧;我们先从BaseExample开始,它是一个简单类,只带有一个方法——myMethod:

  public class BaseExample {

  public BaseExample() {}

  public void myMethod() {

  System.out.println("This is the BaseExample");

  }

  }

  现在,我们想要扩展BaseExample并替代myMethod。下面就是完成这一任务的Example1代码:

  public class Example1 extends BaseExample {

  public Example1() {}

  @Overridepublic void myMethod() {

  System.out.println("This is the Example1");

  }

  }

  这样我们就有了第一个关于myMethod的批注——@Override。这是一系列内置的批注之一。@Override的意思是“方法必须替代其超类中的一个方法;如果做不到这一点,那么就会有东西出错,使得编译器产生错误”。没有@Override,代码照样会正常工作,但是假设有人修改BaseExample,让myMethod带有参数。如果你没有使用@Override批注,代码仍然会被编译,隐藏了子类没有替代超类方法的问题。如果有@Override的话,你会在编译期间看到发生错误。

  你可能会认为“难道语言的扩展没有解决这个问题,额外的关键字可能会吗”,是的,它可能已经实现了这一点,但是这不仅没有给语言带来任何灵活性,还会导致很多源代码兼容性的问题。批注这种方式避免了改变Java语言本身(当然除了增加了@markup),并且还能够放在代码的不同部分里,而不仅仅是在标记方法里。

  关于批注还有一点是,你可以创建自己的批注标记,这正是我们马上要讨论的内容。想一想下面这个问题:我们有一些简单的Java Beans程序,它们都带有不同的字符串字段。我们希望能够有一些通用窗体显示代码,它们能够用其他显示提示(比如宽度)来正确地标示这些字段。现在我们可以编写一个超类,它能够提取出这个数据,比如说从一个在每个类里都带有一些静态支持方法的静态数组里,但是这也意味着要强制给代码分层。利用批注做到这一点就要简单得多了。现在让我们从定义FormLabel.java里的FormLabel的批注开始:

  import java.lang.annotation.*;

  @Retention(RetentionPolicy.RUNTIME)

  @Target(ElementType.METHOD)

  public@interface FormLabel {String label();

  int width() default 40;

  }

  你应该注意到的第一件事是Java使用了它自己内置的一些批注来定批注:@Retention和@Target。@Retention用来定义通过设置RetentionPolicy的值批注能够在构建-运行过程中存留多久。这里我们使用了RUNTIME,这意味着我们定义的批注将会在运行期间被保留在代码里。RetentionPolicy.SOURCE将被用于一个我们希望被编译器使用然后抛弃的批注。RetentionPolicy.CLASS让它们保留在生成的类文件里,但是能够在运行期间被Java虚拟机(JVM)访问到。

  在默认情况下,你可以在代码里的任何地方都应用批注。@Target批注让你能够将它限制在代码的特定部分里。在本文里,我们把目标瞄准了ElementType.METHOD,这意味着它只能够与方法关联在一起。其他ElementTypes有CONSTRUCTOR、FIELD、LOCAL_VARIABLE、PACKAGE、PARAMETER和TYPE,每个都能够把批注限制到该种类型的Java语言元素,所以例如,设置TYPE将只允许批注为定义过的这种类型,比如:

  @OurAnnotation

  public class OurAnnotatedClass {…

  值得注意的是,@Target批注能够接受单个ElementType或者一个ElementType数组,如果你想要将批注限制为一系列语言元素的话。

 [1] [2] [下一页]

发表评论

爱问(iAsk.com) 相关网页共约12,700,000篇。



评论】【论坛】【收藏此页】【 】【多种方式看新闻】【下载点点通】【打印】【关闭




科技时代意见反馈留言板 电话:010-82628888-5595   欢迎批评指正

新浪简介 | About Sina | 广告服务 | 联系我们 | 招聘信息 | 网站律师 | SINA English | 会员注册 | 产品答疑

Copyright © 1996 - 2006 SINA Inc. All Rights Reserved

新浪公司 版权所有