2.2.1注释的类型
从上面的例子中,我们可以看出,按照使用者所需要传入的参数数目, 注释(Annotation)的类型可以分为三种。
第一种是标记注释类型:
标记注释(Marker)是最简单的注释, 不需要定义任何域。下面要介绍的Override和DePRecated都是标记类型的。当然,假如一个注释类型提供了所有域的缺省值,那么这个注释类型也可以认为是一个注释类型。使用标记类型的语法很简单。
清单7 标记注释的用法
@MarkerAnnotation
第二种是单值注释类型:单值注释类型只有一个域。语法也很简单:
清单8 单值注释的用法
@SingleValueAnnotation("some value")
第三种是全值注释类型。 全注释类型其实并不算是一个真正的类型,只是使用注释类型完整的语法:
清单9 全值注释的用法
@MultipleValueAnnotation(
key1=value1,
key2=value2,
key3=value3,
)
2.2.2 J2SE的内建注释(build-in annotation)
在程序中不仅可以使用自己定义的注释,还可以使用J2SE5.0中内建的注释类型。下面我们就具体来介绍J2SE5.0提供的注释类型。J2SE 5.0中预定义了三种注释注释类型:
Override :java.lang.Override 表示当前的方法重写了父类的某个方法,假如父类的对应的方法并不存在,将会发生编译错误。
Deprecated:java.lang.Deprecated 表示 并不鼓励使用当前的方法或者域变量。
SuppressWarnings: java.lang.SuppressWarnings关闭编译器告警,这样,在编译1.5之前的代码的时候,不会出现大量不关心的无关的告警。
下面举一个使用Override的例子。Override这个注释类型在使用模板方法(Template Method,图3)非常有用。熟悉设计模式的读者们一定知道,模板方法中通常定义了抽象类,并且这个抽象类中定义了主要的控制流。
子类就是通过重写父类中控制流中所调用的方法来实现自己的逻辑。有的时候,父类会将这些方法定义为抽象方法,但是有的时候也会提供缺省实现。在后者的情况下,子类可以不实现这个方法。
这样就带来一个问题,假如你希望在子类中重写这个方法,但是无意中写错了方法的名字,这个错误是很难被发现的。
因为你希望重写的这个方法,会被编译器当作一个新的方法而不是重写父类的方法。而现在使用@Override,这个担心就是不必要的。假如你拼错了你希望重写的方法,编译器会报错,告诉你父类没有相应的方法。
图3 模板方法的类图
清单10给出了模板方法的一个例子。这个例子中有定义了两个类,SubClass和BaseClass。其中SubClass继续了BaseClass,并且希望重写BaseClass的方法doPartII()。
然而SubClass中错误的拼写了这个方法的名称。图3显示了SubClass中的编译错误。熟悉eclipse的读者会看到在编辑器里出现了Error Marker,说明这一行有编译错误。将鼠标指向这行,显示了错误信息。
清单10 模板方法
public abstract class BaseClass{ //模板方法的基类
public void doWork(){
doPartI(); //先调用doPartI()方法
doPartII();//之后调用doPartII()方法
}
public abstract void doPartI();
public void doPartII(){
}
}
public class SubClass extend BaseClass{
public void doPartI(){
};
@Override
public void doPortII(){//拼写错误,产生编译错误
System.out.println("override the method of superclass");
}
}
图4 Override应用的例子
2.2.3 注释的注释
值得注重的是,J2SE5.0还提供了四种用于注释的注释类型。有以下的四种:
1. Target:用来指定这个注释(Annotation)是为哪种类型而定义的。比如,这个类型可能只是为method定义的。比如override,不能用@override来修饰class或者field。
比如清单11中定义了一个注释:TODO,而这个注释定义了Target为ElementType.method。因此,TODO只能用来修饰方法,不能用来修饰类或者类变量。图5中给出了一个非法使用TODO的例子。
在MyCalculator中,定义了一个布尔型的变量 isReady,假如用TODO来修饰这个类变量的话,会出现编译错误。而用TODO来修饰方法calculateRate(),则不会出现编译错误。这是因为TODO的定义已经规定了,只能用来修饰方法。
清单11 Target的用法
@Target({ElementType.METHOD})
public @interface TODO {
int priority() default 0;
}
图5 TODO注释的非法使用
2.Retention:Retention的策略可以从以下三种中选取:
RetentionPolicy.SOURCE:编译器编译之后会会从class file中除去注释(Annotation)。
Retention.CLASS:注释(Annotation)保留在class file中,但是VM不会处理。
RetentionPolicy.RUNTIME,:注释(Annotation)保留在class file,VM会进行处理。
请注重,假如你希望在运行时查找到这些注释在什么地方被用到,一定要在定义注释的时候,选择RetentionPolicy.RUNTIME,否则即使你用注释修饰了类变量或者方法,在运行时也没有办法获得这个信息的。