Documented这个注释（Annotation）将作为public API的一部分
Inherited 假设注释（Annotation）定义的时候使用了Inherited那么如果这个注释（Annotation）修饰某个class这个类的子类也被这个注释（Annotation）所修饰
注释的应用
下面各小节显示了在哪些情况下可以使用注释以及如何使用注释
动态查找注释
当我们定义好了注释以后我们可以开发一些分析工具来解释这些注释这里通常要用到Java的反射特性比如说我们希望找到某个对象/方法/域使用了哪些注释或者获得某个特定的注释或者判断是否使用某个特定的注释 我们可以参考下面这个例子
这个例子中定义了两个注释TODO和TOFORMATE在MyCalculator类中TODO用来修饰方法calculateRate而TOFORMATE用来修饰类变量concurrency和debitDate而在类TestCalculator的main函数中通过Java反射特性我们查找到使用这些注释的类变量和方法清单清单分别显示这些类的定义
清单 TODO注释的定义
@Target({ElementTypeMETHOD})
@Retention(RetentionPolicyRUNTIME)
public @interface TODO {
int priority() default ;
}
清单 TOFORMATE的定义
@Target({ElementTypeFIELD})
@Retention(RetentionPolicyRUNTIME)
public @interface TOFORMATE {
}
清单 使用注释的类MyCalculator
public class MyCalculator {
boolean isReady;
@TOFORMATE double concurrency;
@TOFORMATE Date debitDate;
public MyCalculator() {
super();
}
@TODO
public void calculateRate(){
Systemoutprintln(Calculating);
}
}
清单动态查找注释
public class TestCalculator {
public static void main(String[] args) {
MyCalculator cal = new MyCalculator();
calcalculateRate();
try {
Class c = calgetClass();
Method[] methods = cgetDeclaredMethods();
for (Method m: methods) {
// 判断这个方法有没有使用TODO
if (misAnnotationPresent(TODOclass))
Systemoutprintln(Method +mgetName()+: the TODO is present);
}
Field[] fields = cgetDeclaredFields();
for (Field f : fields) {
// 判断这个域有没有使用TOFORMATE
if (fisAnnotationPresent(TOFORMATEclass))
Systemoutprintln
(Field +fgetName()+: the TOFORMATE is present);
}
} catch (Exception exc) {
excprintStackTrace();
}
}
}
下面我们来运行这个例子这个例子的运行结果如图所示
运行结果和我们先前的定义是一致的在运行时我们可以获得注释使用的相关信息
图 运行结果在我们介绍了什么是注释以后你可能会想知道注释可以应用到什么地方呢？使用注释有什么好处呢？在下面的小节中我们将介绍一个稍复杂的例子从这个例子中你将体会到注释所以提供的强大的描述机制（declarative programming）
使用注释替代Visitor模式
在JSE 以前我们在设计应用的时候我们经常会使用Visitor这个设计模式Visitor这个模式一般是用于为我们已经设计好了一组类添加方法而不需要担心改变定义好的类比如说我们已经定义了好了一组类结构但是我们希望将这些类的对象部分数据输出到某种格式的文件中
Vistor模式的实现
使用Vistor模式首先我们在Employee这个类中加入export方法export方法如图所示Export方法接受Exporter对象作为参数并在方法体中调用exporter对象的visit()方法
图 使用Vistor模式实现格式输出在这里我们定义了一个Exporter抽象类我们可以通过继承Exporter类重写其visit方法来实现不同格式的文件输出
图种给出visit方法的实现是一个简单的例子如果要实现输出成XML格式的可以定义Exporter子类XMLExporter如果希望输出成文本的可以定义TXTExporter但是这样做不够灵活的地方在于如果Employee加入其他的域变量那么相应的visitor类也需要进行修改这就违反了面向对象Open for Extension close for Modification的原则
使用注释替代Vistor模式
使用注释（Annotation）也可以完成数据输出的功能首先定义一个新的注释类型@Exportable然后定义一个抽象的解释器ExportableGenerator将Employee 对象传入解释器
在解释器中查找哪些域使用了Exportable这个注释（Annotation）将这些域(Field)按照一定格式输出图给出了Exportable注释的定义
清单注释Exportable的定义
@Target({ElementTypeFIELD})
@Retention(RetentionPolicyRUNTIME)
@Inherited
public @interface Exportable {
}
清单清单中给出了包含数据的这些类的定义以及这些类是如何使用注释Exportable的 图定义了Main函数使用ExporterGenerator来产生输出文件清单给出了使用注释来实现这一功能的两个类ExporterGenerator和TXTExporterGenerator
其中ExporterGenerator定义了一个基本的框架而TXTExporterGenerator继承了ExporterGenerator并且重写了outputField方法在这个方法中实现了特定格式的输出用户可以继承这个ExporterGenerator并且实现其中的抽象方法来定义自己期望的格式
清单 Employee的类定义
public abstract class Employee {
public abstract String getName();
public abstract String getEmpNo();
public Employee() {
super();
}
}
清单 Regular的类定义
public class Regular extends Employee{
@Exportable String name;
@Exportable String address;
@Exportable String title;
@Exportable String phone;
@Exportable String location;
@Exportable Date onboardDate;
@Exportable ArrayList team;
String empNo;
public Regular(String name String address String title String phone
String location Date date) {
super();
thisname = name;
thisaddress = address;
thistitle = title;
thisphone = phone;
thislocation = location;
onboardDate = date;
team = new ArrayList();
}
public void addMemeber(Employee e){
teamadd(e);
}
@Override
public String getName() {
// TODO Autogenerated method stub
return name;
}
}
