一、什么是注释 说起注释,得先提一提什么是元数据(metadata)。所谓元数据就是数据的数据。也就是说,元数据是描述数据的。就象数据表中的字段一样,每个字段描述了这个字段下的数据的含义。而J2SE5.0中提供的注释就是java源代码的元数据,也就是说注释是描述java源代码的。在J2SE5.0中可以自定义注释。使用时在@后面跟注释的名字。 二、J2SE5.0中预定义的注释 在J2SE5.0的java.lang包中预定义了三个注释。它们是Override、Deprecated和SuppressWarnings。下面分别解释它们的含义。 Override 这个注释的作用是标识某一个方法是否覆盖了它的父类的方法。那么为什么要标识呢?让我们来看看如果不用Override标识会发生什么事情。 | |
假设有两个类Class1和ParentClass1,用Class1中的myMethod1方法覆盖ParentClass1中的myMethod1方法。
<!-- Code highlighting produced by Actipro CodeHighlighter (freeware) http://www.CodeHighlighter.com/ -->
class
ParentClass1
![]() ![]() } class Class1 extends ParentClass1 ![]() ![]() }
<!-- Code highlighting produced by Actipro CodeHighlighter (freeware) http://www.CodeHighlighter.com/ -->
ParentClass1 c1
=
new
Class1(); c1.myMethod1();
如果我们使用Override来修饰Class1中的myMethod1方法,当myMethod1被误写成别的方法时,编译器就会报错。因此,就可以避免这类错误。
<!-- Code highlighting produced by Actipro CodeHighlighter (freeware) http://www.CodeHighlighter.com/ -->
class
Class1 extends ParentClass1
![]() ![]() }
<!-- Code highlighting produced by Actipro CodeHighlighter (freeware) http://www.CodeHighlighter.com/ -->
class
Class1 extends ParentClass1
![]() ![]() } Deprecated 这个注释是一个标记注释。所谓标记注释,就是在源程序中加入这个标记后,并不影响程序的编译,但有时编译器会显示一些警告信息。
<!-- Code highlighting produced by Actipro CodeHighlighter (freeware) http://www.CodeHighlighter.com/ -->
class
Class1
![]() ![]() } class Class2 extends Class1 ![]() ![]() }
1
1
运行javac test.java 出现如下警告:
注意:test.java 使用或覆盖了已过时的 API。 注意:要了解详细信息,请使用 -Xlint:deprecation 重新编译 使用-Xlint:deprecation显示更详细的警告信息: test.java:4: 警告:[deprecation] Class1 中的 myMethod() 已过时 public void myMethod() ^ 1 警告 这些警告并不会影响编译,只是提醒你一下尽量不要用myMethod方法。 SuppressWarnings 这个世界的事物总是成对出现。即然有使编译器产生警告信息的,那么就有抑制编译器产生警告信息的。 SuppressWarnings注释就是为了这样一个目的而存在的。让我们先看一看如下的代码。
<!-- Code highlighting produced by Actipro CodeHighlighter (freeware) http://www.CodeHighlighter.com/ -->
public
void
myMethod()
![]() 注意:Testannotation.java 使用了未经检查或不安全的操作。 注意:要了解详细信息,请使用 -Xlint:unchecked 重新编译。 这两行警告信息表示List类必须使用范型才是安全的,才可以进行类型检查。如果想不显示这个警告信息有两种方法。一个是将这个方法进行如下改写:
1
public void myMethod(){ List<String> wordList = new ArrayList<String>(); wordList.add("foo"); } 另外一种方法就是使用@SuppressWarnings。 @SuppressWarnings (value={"unchecked"}) public void myMethod() { List wordList = new ArrayList(); wordList.add("foo"); } 要注意的是SuppressWarnings和前两个注释不一样。这个注释有一个属性。当然,还可以抑制其它警告,如: @SuppressWarnings (value={"unchecked", "fallthrough"}) 三、如何自定义注释
<!-- Code highlighting produced by Actipro CodeHighlighter (freeware) http://www.CodeHighlighter.com/ -->
public
@interface MyAnnotation
![]() 当然,也可以定义有属性的注释。
<!-- Code highlighting produced by Actipro CodeHighlighter (freeware) http://www.CodeHighlighter.com/ -->
public
@interface MyAnnotation
![]()
<!-- Code highlighting produced by Actipro CodeHighlighter (freeware) http://www.CodeHighlighter.com/ -->
@MyAnnotation("abc")
public
void
myMethod()
![]() 除了可以省略属性名,还可以省略属性值。这就是默认值。
<!-- Code highlighting produced by Actipro CodeHighlighter (freeware) http://www.CodeHighlighter.com/ -->
public
@interface MyAnnotation
![]() ![]()
<!-- Code highlighting produced by Actipro CodeHighlighter (freeware) http://www.CodeHighlighter.com/ -->
@MyAnnotation
//
使用默认值xyz
public void myMethod() ![]()
<!-- Code highlighting produced by Actipro CodeHighlighter (freeware) http://www.CodeHighlighter.com/ -->
@MyAnnotation(myMethod
=
”abc”)
public
void
myMethod()
![]() 如果要使用多个属性的话。可以参考如下代码。
<!-- Code highlighting produced by Actipro CodeHighlighter (freeware) http://www.CodeHighlighter.com/ -->
public
@interface MyAnnotation
![]() ![]() ![]() ![]() } @MyAnnotation(value1 = MyAnnotation.MyEnum.A, value2 = “xyz”) public void myMethod() ![]()
1
四、如何对注释进行注释 这一节的题目读起来虽然有些绕口,但它所蕴涵的知识却对设计更强大的java程序有很大帮助。 在上一节讨论了自定义注释,由此我们可知注释在J2SE5.0中也和类、接口一样。是程序中的一个基本的组成部分。既然可以对类、接口进行注释,那么当然也可以对注释进行注释。 使用普通注释对注释进行注释的方法和对类、接口进行注释的方法一样。所不同的是,J2SE5.0为注释单独提供了4种注释。它们是Target、Retention、Documented和Inherited。下面就分别介绍这4种注释。 Target 这个注释理解起来非常简单。由于target的中文意思是“目标”,因此,我们可能已经猜到这个注释和某一些目标相关。那么这些目标是指什么呢?大家可以先看看下面的代码。
<!-- Code highlighting produced by Actipro CodeHighlighter (freeware) http://www.CodeHighlighter.com/ -->
![]() ![]() @MyAnnotation // 错误的使用 public class Class1 ![]() ![]() } 说到这,大家可能已经基本明白了。原来target所指的目标就是java的语言元素。如类、接口、方法等。当然,Target还可以对其它的语言元素进行限制,如构造函数、字段、参数等。如只允许对方法和构造函数进行注释可以写成:
<!-- Code highlighting produced by Actipro CodeHighlighter (freeware) http://www.CodeHighlighter.com/ -->
![]() ![]() 既然可以自定义注释,当然也可以读取程序中的注释(如何读取注释将在下一节中讨论)。但是注释只有被保存在class文件中才可以被读出来。而Retention就是为设置注释是否保存在class文件中而存在的。下面的代码是Retention的详细用法。
<!-- Code highlighting produced by Actipro CodeHighlighter (freeware) http://www.CodeHighlighter.com/ -->
@Retention(RetentionPolicy.SOURCE)
![]() @Retention(RetentionPolicy.CLASS) ![]() @Retention(RetentionPolicy.RUNTIME) ![]() Documented 这个注释和它的名子一样和文档有关。在默认的情况下在使用javadoc自动生成文档时,注释将被忽略掉。如果想在文档中也包含注释,必须使用Documented为文档注释。
<!-- Code highlighting produced by Actipro CodeHighlighter (freeware) http://www.CodeHighlighter.com/ -->
![]() @MyAnnotation class Class1 ![]() ![]() }
<!-- Code highlighting produced by Actipro CodeHighlighter (freeware) http://www.CodeHighlighter.com/ -->
class
Class1extends java.lang.Object 而如果这样定义MyAnnotation将会出现另一个结果。 @Documented
![]() 生成的文档: @MyAnnotation // 这行是在加上@Documented后被加上的 class Class1extends java.lang.Object 继承是java主要的特性之一。在类中的protected和public成员都将会被子类继承,但是父类的注释会不会被子类继承呢?很遗憾的告诉大家,在默认的情况下,父类的注释并不会被子类继承。如果要继承,就必须加上Inherited注释。
<!-- Code highlighting produced by Actipro CodeHighlighter (freeware) http://www.CodeHighlighter.com/ -->
@Inherited
![]() @MyAnnotation ![]() ![]() 在以上代码中ChildClass和ParentClass一样都已被MyAnnotation注释了。 五、如何使用反射读取注释
<!-- Code highlighting produced by Actipro CodeHighlighter (freeware) http://www.CodeHighlighter.com/ -->
Method method
=
TestAnnotation.
class
.getMethod(
"
myMethod
"
,
null
); Annotation annotation
=
method.getAnnotation(MyAnnotation.
class
); 注:要想使用反射得到注释信息,这个注释必须使用 @Retention(RetentionPolicy.RUNTIME)进行注释。
总结 |
J2SE5.0中的注解
最新推荐文章于 2023-04-07 17:19:50 发布