Java+Annotation入门Word文件下载.docx

Java+Annotation入门Word文件下载.docx

《Java+Annotation入门Word文件下载.docx》由会员分享，可在线阅读，更多相关《Java+Annotation入门Word文件下载.docx（11页珍藏版）》请在冰点文库上搜索。

annotation可以从源文件、class文件或者以在运行时反射的多种方式被读取。

　当然annotation在某种程度上使javadoctag更加完整。

一般情况下，如果这个标记对java文档产生影响或者用于生成java文档的话，它应该作为一个javadoctag；

否则将作为一个annotation.

　三、Annotation使用方法：

　1.类型声明方式：

　通常，应用程序并不是必须定义annotation类型，但是定义annotation类型并非难事。

Annotation类型声明于一般的接口声明极为类似，区别只在于它在interface关键字前面使用"

@"

符号。

　annotation类型的每个方法声明定义了一个annotation类型成员，但方法声明不必有参数或者异常声明；

方法返回值的类型被限制在以下的范围：

primitives、String、Class、enums、annotation和前面类型的数组；

方法可以有默认值。

　下面是一个简单的annotation类型声明：

　清单1：

/**

*DescribestheRequest-For-Enhancement（RFE）thatled

*tothepresenceoftheannotatedAPIelement.

*/

public@interfaceRequestForEnhancement{

int 

id（）;

Stringsynopsis（）;

Stringengineer（）default"

[unassigned]"

;

Stringdate（）;

default"

[unimplemented]"

}

　代码中只定义了一个annotation类型RequestForEnhancement.

　2.修饰方法的annotation声明方式：

　annotation是一种修饰符，能够如其它修饰符（如public、static、final）一般使用。

习惯用法是annotaions用在其它的修饰符前面。

annotations由"

@+annotation类型+带有括号的成员-值列表"

组成。

这些成员的值必须是编译时常量（即在运行时不变）。

　A：

下面是一个使用了RequestForEnhancementannotation的方法声明：

　清单2：

@RequestForEnhancement（

id 

=2868724,

synopsis="

Enabletime-travel"

engineer="

Mr.Peabody"

date 

="

4/1/3007"

）

publicstaticvoidtravelThroughTime（Datedestination）{...}

　B：

当声明一个没有成员的annotation类型声明时，可使用以下方式：

清单3：

*IndicatesthatthespecificationoftheannotatedAPIelement

*ispreliminaryandsubjecttochange.

public@interfacePreliminary{}

　作为上面没有成员的annotation类型声明的简写方式：

　清单4：

@PreliminarypublicclassTimeTravel{...}

　C：

如果在annotations中只有唯一一个成员，则该成员应命名为value：

　清单5：

*AssociatesacopyrightnoticewiththeannotatedAPIelement.

public@interfaceCopyright{

Stringvalue（）;

　更为方便的是对于具有唯一成员且成员名为value的annotation（如上文），在其使用时可以忽略掉成员名和赋值号（=）：

　清单6：

@Copyright（"

2002YoyodynePropulsionSystems"

publicclassOscillationOverthruster{...}

　3.一个使用实例：

　结合上面所讲的，我们在这里建立一个简单的基于annotation测试框架。

首先我们需要一个annotation类型来表示某个方法是一个应该被测试工具运行的测试方法。

　清单7：

importjava.lang.annotation.*;

*Indicatesthattheannotatedmethodisatestmethod.

*Thisannotationshouldbeusedonlyonparameterlessstaticmethods.

@Retention（RetentionPolicy.RUNTIME）

@Target（ElementType.METHOD）

public@interfaceTest{}

　值得注意的是annotaion类型声明是可以标注自己的，这样的annotation被称为“meta-annotations”。

　在上面的代码中，@Retention（RetentionPolicy.RUNTIME）这个meta-annotation表示了此类型的annotation将被虚拟机保留使其能够在运行时通过反射被读取。

而@Target（ElementType.METHOD）表示此类型的annotation只能用于修饰方法声明。

　下面是一个简单的程序，其中部分方法被上面的annotation所标注：

　清单8：

publicclassFoo{

@Testpublicstaticvoidm1（）{}

publicstaticvoidm2（）{}

@Testpublicstaticvoidm3（）{

thrownewRuntimeException（"

Boom"

）;

publicstaticvoidm4（）{}

@Testpublicstaticvoidm5（）{}

publicstaticvoidm6（）{}

@Testpublicstaticvoidm7（）{

Crash"

publicstaticvoidm8（）{}

Hereisthetestingtool:

importjava.lang.reflect.*;

publicclassRunTests{

publicstaticvoidmain（String[]args）throwsException{

intpassed=0,failed=0;

for（Methodm:

Class.forName（args[0]）.getMethods（））{

if（m.isAnnotationPresent（Test.class））{

try{

m.invoke（null）;

passed++;

}catch（Throwableex）{

System.out.printf（"

Test%sfailed:

%s%n"

m,ex.getCause（））;

failed++;

}

System.out.printf（"

Passed:

%d,Failed%d%n"

passed,failed）;

　这个程序从命令行参数中取出类名，并且遍历此类的所有方法，尝试调用其中被上面的测试annotation类型标注过的方法。

在此过程中为了找出哪些方法被annotation类型标注过，需要使用反射的方式执行此查询。

如果在调用方法时抛出异常，此方法被认为已经失败，并打印一个失败报告。

最后，打印运行通过/失败的方法数量。

　下面文字表示了如何运行这个基于annotation的测试工具：

　清单9：

$javaRunTestsFoo

TestpublicstaticvoidFoo.m3（）failed:

java.lang.RuntimeException:

Boom

TestpublicstaticvoidFoo.m7（）failed:

Crash

2,Failed2

　四、Annotation分类：

　根据annotation的使用方法和用途主要分为以下几类：

　1.内建Annotation——Java5.0版在java语法中经常用到的内建Annotation：

　@Deprecated用于修饰已经过时的方法；

　@Override用于修饰此方法覆盖了父类的方法（而非重载）；

　@SuppressWarnings用于通知java编译器禁止特定的编译警告。

　下面代码展示了内建Annotation类型的用法：

　清单10：

packagecom.bjinfotech.practice.annotation;

*演示如何使用java5内建的annotation

*参考资料：

*

*@authorcleverpig

*

*/

importjava.util.List;

publicclassUsingBuiltInAnnotation{

//食物类

classFood{}

//干草类

classHayextendsFood{}

//动物类

classAnimal{

FoodgetFood（）{

returnnull;

//使用Annotation声明Deprecated方法

@Deprecated

voiddeprecatedMethod（）{

//马类-继承动物类

classHorseextendsAnimal{

//使用Annotation声明覆盖方法

@Override

HaygetFood（）{

returnnewHay（）;

//使用Annotation声明禁止警告

@SuppressWarnings（{"

deprecation"

"

unchecked"

}）

voidcallDeprecatedMethod（ListhorseGroup）{

Animalan=newAnimal（）;

an.deprecatedMethod（）;

horseGroup.add（an）;

　2.开发者自定义Annotation：

由开发者自定义Annotation类型。

　下面是一个使用annotation进行方法测试的sample：

　AnnotationDefineForTestFunction类型定义如下：

　清单11：

*定义annotation

//加载在VM中，在运行时进行映射

//限定此annotation只能标示方法

public@interfaceAnnotationDefineForTestFunction{}

　测试annotation的代码如下：

　清单12：

*一个实例程序应用前面定义的Annotation：

AnnotationDefineForTestFunction

publicclassUsingAnnotation{

@AnnotationDefineForTestFunctionpublicstaticvoidmethod01（）{}

publicstaticvoidmethod02（）{}

@AnnotationDefineForTestFunctionpublicstaticvoidmethod03（）{

method03"

publicstaticvoidmethod04（）{

method04"

publicstaticvoidmain（String[]argv）throwsException{

//被检测的类名

StringclassName="

com.bjinfotech.practice.annotation.UsingAnnotation"

//逐个检查此类的方法，当其方法使用annotation声明时调用此方法

Class.forName（className）.getMethods（））{

if（m.isAnnotationPresent（AnnotationDefineForTestFunction.class））{

测试%s失败:

测试结果：

通过:

%d,失败：

%d%n"

　3.使用第三方开发的Annotation类型

　这也是开发人员所常常用到的一种方式。

比如我们在使用Hibernate3.0时就可以利用Annotation生成数据表映射配置文件，而不必使用Xdoclet.

　五、总结：

1.前面的文字说明了annotation的使用方法、定义方式、分类。

初学者可以通过以上的说明制作简单的annotation程序，但是对于一些高级的annotation应用（例如使用自定义annotation生成javabean映射xml文件）还需要进一步的研究和探讨。

2.同时，annotation运行存在两种方式：

上文中讨论的都是在运行时的annotation应用，但在编译时的annotation应用还没有涉及，因为编译时的annotation要使用annotationprocessingtool.