摘要:
网管bitscn_com
本文针对java初学者或者annotation初次使用者全面地说明了annotation的使用方法、定义方式、分类。初学者可以通过以上的说明制作简单的annotation程序,但是对于一些高级的annotation应用(例如使用自定义annotation生成javabean映射xml文件)还需要进一步的研究和探讨。涉及到深入annotation的内容,作者将在后文《Java Annotation高级应用》中谈到。 网管u家u.bitscn@com
同时,annotation运行存在两种方式:运行时、编译时。上文中讨论的都是在运行时的annotation应用,但在编译时的annotation应用还没有涉及, 网管网www_bitscn_com
一、为什么使用Annotation:
在JAVA应用中,我们常遇到一些需要使用模版代码。例如,为了编写一个JAX-RPC web service,我们必须提供一对接口和实现作为模版代码。如果使用annotation对远程访问的方法代码进行修饰的话,这个模版就能够使用工具自动生成。 网管u家u.bitscn@com
另外,一些API需要使用与程序代码同时维护的附属文件。例如,JavaBeans需要一个BeanInfo Class与一个Bean同时使用/维护,而EJB则同样需要一个部署描述符。此时在程序中使用annotation来维护这些附属文件的信息将十分便利而且减少了错误。
二、Annotation工作方式:
网管有家bitscn.net
在5.0版之前的Java平台已经具有了一些ad hoc annotation机制。比如,使用transient修饰符来标识一个成员变量在序列化子系统中应被忽略。而@deprecated这个javadoc tag也是一个ad hoc annotation用来说明一个方法已过时。从Java5.0版发布以来,5.0平台提供了一个正式的annotation功能:允许开发者定义、使用自己的annoatation类型。此功能由一个定义annotation类型的语法和一个描述annotation声明的语法,读取annotaion的API,一个使用annotation修饰的class文件,一个annotation处理工具(apt)组成。 网管网www_bitscn_com
annotation并不直接影响代码语义,但是它能够工作的方式被看作类似程序的工具或者类库,它会反过来对正在运行的程序语义有所影响。annotation可以从源文件、class文件或者以在运行时反射的多种方式被读取。 网管u家www.bitscn.net
当然annotation在某种程度上使javadoc tag更加完整。一般情况下,如果这个标记对java文档产生影响或者用于生成java文档的话,它应该作为一个javadoc tag;否则将作为一个annotation. 网管联盟bitsCN@com
三、Annotation使用方法: 网管u家bitscn.net
1.类型声明方式:
中国网管论坛bbs.bitsCN.com
通常,应用程序并不是必须定义annotation类型,但是定义annotation类型并非难事。Annotation类型声明于一般的接口声明极为类似,区别只在于它在interface关键字前面使用"@"符号。 网管下载dl.bitscn.com
annotation类型的每个方法声明定义了一个annotation类型成员,但方法声明不必有参数或者异常声明;方法返回值的类型被限制在以下的范围:primitives、String、Class、enums、annotation和前面类型的数组;方法可以有默认值。
下面是一个简单的annotation类型声明: 网管朋友网www_bitscn_net
清单1: 网管bitscn_com
网管联盟bitsCN_com
/**
* Describes the Request-For-Enhancement(RFE) that led
* to the presence of the annotated API element.
*/
public @interface RequestForEnhancement {
int id();
String synopsis();
String engineer() default "[unassigned]";
String date(); default "[unimplemented]";
} 网管u家u.bitscn@com
代码中只定义了一个annotation类型RequestForEnhancement.
2.修饰方法的annotation声明方式: 网管网www.bitscn.com
annotation是一种修饰符,能够如其它修饰符(如public、static、final)一般使用。习惯用法是annotaions用在其它的修饰符前面。annotations由"@+annotation类型+带有括号的成员-值列表"组成。这些成员的值必须是编译时常量(即在运行时不变)。
网管u家u.bitsCN.com
A:下面是一个使用了RequestForEnhancement annotation的方法声明:
清单2: 网管有家bitscn.net
作为上面没有成员的annotation类型声明的简写方式: 网管联盟bitsCN@com
中国网管论坛bbs.bitsCN.com
清单4:
网管下载dl.bitscn.com
@Preliminary public class TimeTravel { ... }
网管bitscn_com
C:如果在annotations中只有唯一一个成员,则该成员应命名为value: 网管联盟bitsCN@com
清单5:
网管朋友网www_bitscn_net
网管下载dl.bitscn.com
/** 网管bitscn_com
* Associates a copyright notice with the annotated API element.
*/
public @interface Copyright {
String value();
}
网管联盟bitsCN_com
网管u家u.bitsCN.com
清单6: 网管网www_bitscn_com
@Copyright("2002 Yoyodyne Propulsion Systems") 网管下载dl.bitscn.com
public class OscillationOverthruster { ... }
3.一个使用实例: 网管论坛bbs_bitsCN_com
网管u家u.bitscn@com
结合上面所讲的,我们在这里建立一个简单的基于annotation测试框架。首先我们需要一个annotation类型来表示某个方法是一个应该被测试工具运行的测试方法。
清单7:
import java.lang.annotation.*; 网管bitscn_com
/**
* Indicates that the annotated method is a test method.
* This annotation should be used only on parameterless static methods.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Test { }
网管网www.bitscn.com
在上面的代码中,@Retention(RetentionPolicy.RUNTIME)这个meta-annotation表示了此类型的annotation将被虚拟机保留使其能够在运行时通过反射被读取。而@Target(ElementType.METHOD)表示此类型的annotation只能用于修饰方法声明。 网管bitscn_com
网管有家www.bitscn.net
下面是一个简单的程序,其中部分方法被上面的annotation所标注:
网管联盟bitsCN_com
清单8:
网管网www.bitscn.com
public class Foo {
@Test public static void m1() { }
public static void m2() { }
@Test public static void m3() {
throw new RuntimeException("Boom");
}
public static void m4() { }
@Test public static void m5() { }
public static void m6() { }
@Test public static void m7() {
throw new RuntimeException("Crash");
}
public static void m8() { }
}
Here is the testing tool: 网管有家bitscn.net
import java.lang.reflect.*;
public class RunTests {
public static void main(String[] args) throws Exception {
int passed = 0, failed = 0;
for (Method m : Class.forName(args[0]).getMethods()) {
if (m.isAnnotationPresent(Test.class)) {
try {
m.invoke(null);
passed++;
} catch (Throwable ex) {
System.out.printf("Test %s failed: %s %n", m, ex.getCause());
failed++;
}
}
}
System.out.printf("Passed: %d, Failed %d%n", passed, failed);
}
}
中国网管论坛bbs.bitsCN.com
网管网www_bitscn_com
下面文字表示了如何运行这个基于annotation的测试工具:
网管网www_bitscn_com
网管u家u.bitscn@com
清单9: 网管u家u.bitscn@com
网管u家u.bitscn@com
$ java RunTests Foo 中国网管联盟bitsCN.com
Test public static void Foo.m3() failed: java.lang.RuntimeException: Boom
Test public static void Foo.m7() failed: java.lang.RuntimeException: Crash
Passed: 2, Failed 2
网管bitscn_com
网管有家bitscn.net
根据annotation的使用方法和用途主要分为以下几类: 网管u家u.bitscn@com
网管有家www.bitscn.net
1.内建Annotation——Java5.0版在java语法中经常用到的内建Annotation:
网管联盟bitsCN@com
@Deprecated用于修饰已经过时的方法;
网管u家www.bitscn.net
@Override用于修饰此方法覆盖了父类的方法(而非重载); 网管网www_bitscn_com
网管下载dl.bitscn.com
@SuppressWarnings用于通知java编译器禁止特定的编译警告。 网管u家bitscn.net
中国网管论坛bbs.bitsCN.com
下面代码展示了内建Annotation类型的用法:
网管bitscn_com
清单10:
中国网管论坛bbs.bitsCN.com
package com.bjinfotech.practice.annotation; 网管u家www.bitscn.net
/**
* 演示如何使用java5内建的annotation
* 参考资料:
* http://java.sun.com/docs/books/tutorial/java/javaOO/annotations.html
* http://java.sun.com/j2se/1.5.0/docs/guide/language/annotations.html
* http://mindprod.com/jgloss/annotations.html
* @author cleverpig
*
*/ 网管论坛bbs_bitsCN_com
import java.util.List;
public class UsingBuiltInAnnotation {
//食物类
class Food{}
//干草类
class Hay extends Food{}
//动物类
class Animal{
Food getFood(){
return null;
} 中国网管论坛bbs.bitsCN.com
//使用Annotation声明Deprecated方法
@Deprecated
void deprecatedMethod(){
}
}
//马类-继承动物类
class Horse extends Animal{
//使用Annotation声明覆盖方法 使用Annotation声明禁止警告
@SuppressWarnings({"deprecation","unchecked"})
void callDeprecatedMethod(List horseGroup){ 网管u家bitscn.net
Animal an=new Animal();
an.deprecatedMethod();
horseGroup.add(an);
}
}
} 网管网www.bitscn.com
@Override
Hay getFood(){
return new Hay();
}
//
2.开发者自定义Annotation:由开发者自定义Annotation类型。 网管u家bitscn.net
网管下载dl.bitscn.com
下面是一个使用annotation进行方法测试的sample: 网管朋友网www_bitscn_net
网管网www_bitscn_com
AnnotationDefineForTestFunction类型定义如下: 中国网管联盟bitsCN.com
中国网管联盟bitsCN.com
清单11:
package com.bjinfotech.practice.annotation; 网管网www.bitscn.com
import java.lang.annotation.*;
/**
* 定义annotation
* @author cleverpig
*
*/
//加载在VM中,在运行时进行映射
@Retention(RetentionPolicy.RUNTIME)
//限定此annotation只能标示方法
@Target(ElementType.METHOD)
public @interface AnnotationDefineForTestFunction{} 网管有家bitscn.net
测试annotation的代码如下:
清单12:
package com.bjinfotech.practice.annotation; 中国网管联盟bitsCN.com
import java.lang.reflect.*;
/**
* 一个实例程序应用前面定义的Annotation:AnnotationDefineForTestFunction
* @author cleverpig
*
*/
public class UsingAnnotation {
@AnnotationDefineForTestFunction public static void method01(){}
public static void method02(){}
@AnnotationDefineForTestFunction public static void method03(){ 中国网管联盟bitsCN.com
throw new RuntimeException("method03");
}
public static void method04(){
throw new RuntimeException("method04");
}
public static void main(String[] argv) throws Exception{
int passed = 0, failed = 0;
//被检测的类名
String className="com.bjinfotech.practice.annotation.UsingAnnotation";
// 逐个检查此类的方法,当其方法使用annotation声明时调用此方法
for (Method m : Class.forName(className).getMethods()) {
if (m.isAnnotationPresent(AnnotationDefineForTestFunction.class)) {
try {
m.invoke(null);
passed++;
} catch (Throwable ex) { 网管朋友网www_bitscn_net
System.out.printf(" 测试 %s 失败 : %s %n", m, ex.getCause());
failed++;
}
}
}
System.out.printf("测试结果:通过: %d, 失败: %d%n", passed, failed);
}
} 网管u家u.bitsCN.com
3.使用第三方开发的Annotation类型
网管bitscn_com
这也是开发人员所常常用到的一种方式。比如我们在使用Hibernate3.0时就可以利用Annotation生成数据表映射配置文件,而不必使用Xdoclet.
网管u家u.bitsCN.com
五、总结: 网管有家www.bitscn.net
1.前面的文字说明了annotation的使用方法、定义方式、分类。初学者可以通过以上的说明制作简单的annotation程序,但是对于一些高级的annotation应用(例如使用自定义annotation生成javabean映射xml文件)还需要进一步的研究和探讨。
网管下载dl.bitscn.com
2.同时,annotation运行存在两种方式:运行时、编译时。上文中讨论的都是在运行时的annotation应用,但在编译时的annotation应用还没有涉及,因为编译时的annotation要使用annotation processing tool.
网管u家www.bitscn.net 中国网管联盟bitsCN.com 四、Annotation分类: 网管联盟bitsCN_com 这个程序从命令行参数中取出类名,并且遍历此类的所有方法,尝试调用其中被上面的测试annotation类型标注过的方法。在此过程中为了找出哪些方法被annotation类型标注过,需要使用反射的方式执行此查询。如果在调用方法时抛出异常,此方法被认为已经失败,并打印一个失败报告。最后,打印运行通过/失败的方法数量。
值得注意的是annotaion类型声明是可以标注自己的,这样的annotation被称为“meta-annotations”。 网管u家www.bitscn.net
更为方便的是对于具有唯一成员且成员名为value的annotation(如上文),在其使用时可以忽略掉成员名和赋值号(=):
@RequestForEnhancement(
id = 2868724,
synopsis = "Enable time-travel",
engineer = "Mr. Peabody",
date = "4/1/3007"
)
public static void travelThroughTime(Date destination) { ... }
B:当声明一个没有成员的annotation类型声明时,可使用以下方式:
清单3:
网管下载dl.bitscn.com
网管论坛bbs_bitsCN_com
/**
* Indicates that the specification of the annotated API element
* is preliminary and subject to change.
*/
public @interface Preliminary { }
中国网管论坛bbs.bitsCN.com