xml 和 Java Annotation 的优缺点对比

Java Annotation 基础

　　配置文件的好处在于进一步降低耦合，使应用更易于扩展，即使对配置文件进行了修改也不需要对工程进行修改和重新编译。缺点也是显而易见，配置文件读取和解析需要花费一定的时间，配置文件过多时难以管理，IDE 无法对配置的正确性进行校验，给测试增加了难度。基于以上原因，Java 从１.５开始提供了 Annotation （注释，标注），它用来修饰应用程序的元素（类，方法，属性，参数，本地变量，包、元数据），编译器将其与元数据一同存储在 class 文件中，运行期间通过 Java 的反射来处理对其修饰元素的访问。Annotation 仅仅用来修饰元素，而不能影响代码的执行。只有通过其配套的框架或工具才能对其信息进行访问和处理。这一点与 xml 相同，没有 struts api 的 struts.xml 文件对程序不会起来任何作用。

　　Ｑ：如何使用 Annotation ？
　　Ａ：首先让我们从 Java 定义的 Annotation 开始。@Override 可能是我们最常用到的 Annotation 之一了，Eclipse 中当子类中的某个方法覆写的父类中的方法时，会亮黄灯提示。若用 @Override 修饰该方法，黄灯熄灭。再让我们来看一个例子，当我们使用 new java.util.Date(2010, 2, 25); 来初始化日期类时，Eclipse 仍然会亮黄灯提示，这是因为该方法被 @Deprecated 修饰了，表示不推荐使用。从这两个例子我们能够了解到，Annotation 是在编译期校验的。这一点最大的好处是在编译期间就可对错误进行处理。若使用 xml 的话，只有在运行期才能得到错误信息。

　　Ｑ：Java 标准的 Annotation 有哪些？
　　Ａ：@Deprecated 相当于Javadoc的@deprecated，被@Deprecated标注的对象class, method等被注明为不推荐使用。主要用于javac等编译工具。
　　　　@Override 注明对象method重载了父类的方法。javac等编译工具编译时会根据此Annotation判断重载方法是否正确。
　　　　@SuppressWarnings 告诉javac等编译器忽略所指定的特定的警告信息。
　　　　@Target 被定义的annotation可以附加在那些对象上。
　　　　@Retention annotation的作用期间。
　　　　这里我们要重点介绍两个 Annotation ，因为这两个 Annotation 有一点特殊，因为它们并不是用来修饰代码，而是用来修饰 Annotation 的。
　　@Target 用来标注定义的 Annotation 可以附加在那些对象上。可选参数包括CONSTRUCTOR（构造器）、FIELD（属性及enum实例）LOCAL_VARIABLE（局部变量）、METHOD（方法）、PACKAGE（包）、PARAMETER（参数）以及TYPE（类、接口、注解类型、enum）。下例定义的 Annotation 被 @Target 修饰，表示该 Annotation 可以用来修饰属性和参数。

view plain copy to clipboard print ?

1. @Target( { FIELD,  PARAMETER})  
2. public @interface Resource {  
3. 　　public String id() default "";  
4. }  

　　使用方法：

view plain copy to clipboard print ?

1. public class Mxjava {  
2. 　　@Resource(id="http://www.mxjava.com")  
3. 　　private String url;  
4. 　　public void getLog(@Resource(id="001") String logId) {...}  
5. }  

　　@Retention 用标注在什么级别保存该 Annotation 。可选参数包括SOURCE（编译期会被忽略不做保存）、CLASS（编译后的 class 文件中可用，但虚拟机运行时忽略）、RUNTIME（运行期保留，若要使用反射机制读取 Annotation 信息的话，使用该项。）

view plain copy to clipboard print ?

1. @Target( { FIELD,  PARAMETER})  
2. @Retention(RUNTIME)  
3. public @interface Resource {  
4. 　　public String id() default "";  
5. }  

　　Ｑ：如何定义 Annotation ？
　　Ａ：先让我们来看一个最简单的 Annotation 。

view plain copy to clipboard print ?

1. @Target( { FIELD })  
2. @Retention(RUNTIME)  
3. public @interface Resource {  
4. 　　public String id() default "";  
5. }  

　　　　@Target 是 Java 标准的 Annotation，本例中指定定义的 Annotation 可以附加在属性（Field）上。@Retention 也是 Java 标准的 Annotation，指定作用期间是运行期。@interface 是用来修饰 Annotation 的，请注意，它不是 interface。这个关键字声明隐含了一个信息：它是继承了 java.lang.annotation.Annotation 接口，而不是声明了一个 interface。Annotation 成员的定义看上去很象方法，default “” 表示默认值为空字符串。使用方法如下：

view plain copy to clipboard print ?

1. public class mxjava {  
2. 　　@Resource(id="http://www.mxjava.com")  
3. 　　private String url;  
4. }  

　　　　若没有配套的框架和工具，@Resource 是不起任何作用的。就象前面讲到的那样，它不会对代码的执行有任何影响。

　　Ｑ：什么时候需要自定义 Annotation ？
　　Ａ：一般来说，若不做框架和工具的开发，一般情况下是不需要自定义 Annotation 的。

　　下一篇日志，我们围绕 xml 配置文件和 Annotation 的共同点做进一步讨论。

 

《Java Annotation 基础》中我们简单地介绍了 Java Annotation 的作用以及 Java 标准的 Annotation 。今天我们来了解一下 xml 和 Annotation 各自作为配置项的优缺点。

　　首先说说 xml 。目前 web 应用中几乎都使用 xml 作为配置项，例如我们常用的框架 Struts、Spring、Hibernate、IBatis 等等都采用 xml 作为配置。xml 之所以这么流行，是因为它的很多优点是其它技术的配置所无法替代的。
　　１、xml 作为可扩展标记语言最大的优势在于开发者能够为软件量身定制适用的标记，使代码更加通俗易懂。
　　２、利用 xml 配置能使软件更具扩展性。例如 Spring 将 class 间的依赖配置在 xml 中，最大限度地提升应用的可扩展性。
　　３、具有成熟的验证机制确保程序正确性。利用 Schema 或 DTD 可以对 xml 的正确性进行验证，避免了非法的配置导致应用程序出错。
　　４、修改配置而无需变动现有程序。

　　虽然有如此多的好处，但毕竟没有什么万能的东西，xml 也有自身的缺点。
　　１、需要解析工具或类库的支持。
　　２、解析 xml 势必会影响应用程序性能，占用系统资源。
　　３、配置文件过多导致管理变得困难。
　　４、编译期无法对其配置项的正确性进行验证，或要查错只能在运行期。
　　５、IDE 无法验证配置项的正确性无能为力。
　　６、查错变得困难。往往配置的一个手误导致莫名其妙的错误。
　　７、开发人员不得不同时维护代码和配置文件，开发效率变得低下。
　　８、配置项与代码间存在潜规则。改变了任何一方都有可能影响另外一方。

　　让我们来看看 Annotation 的优点。
　　１、保存在 class 文件中，降低维护成本。
　　２、无需工具支持，无需解析。
　　３、编译期即可验证正确性，查错变得容易。
　　４、提升开发效率。

　　同样 Annotation 也不是万能的，它也有很多缺点。
　　１、若要对配置项进行修改，不得不修改 Java 文件，重新编译打包应用。
　　２、配置项编码在 Java 文件中，可扩展性差。

　　总结：没有一个事物是万能的，同样 xml 和 Java Annotation 都有各自的优缺点。通过以上对比，细心的读者可能已经发现它们的优缺点恰恰是互补的。xml 的强项是 Annotation 所不具备的，而 Annotation 的优势也是 xml 所欠缺的。这也正是时下流行的 xml + Annotation 配置的原因所在。在下一篇日志中，我们将使用 xml 和 Annotation 以及 xml + Annotation 各自完成简单的对象注射功能，使读者更加深入地了解 xml 和 Annotation 的作用。