注解的作用和使用方法Word文件下载.docx
《注解的作用和使用方法Word文件下载.docx》由会员分享，可在线阅读，更多相关《注解的作用和使用方法Word文件下载.docx（22页珍藏版）》请在冰点文库上搜索。
6*可以通过default来声明参数的默认值。
7*在这里可以看到@Retention和@Target这样的元注解，用来声明注解本身的行为。
8*@Retention用来声明注解的保留策略，有CLASS、RUNTIME和SOURCE这三种，
9*分别表示注解保存在类文件、JVM运行时刻和源代码中。
10*只有当声明为RUNTIME的时候，才能够在运行时刻通过反射API来获取到注解的信息。
11*@Target用来声明注解可以被添加在哪些类型的元素上，如类型、方法和域等。
12*就可以定义一个注解了，它将自动继承Annotation
13*/
14public@interfaceTestA{
15//这里定义了一个空的注解，它能干什么呢。
我也不知道，但他能用。
16}
在下面这个程序中使用它：
17packagecom.tmser.annotation;
18
19importjava.util.HashMap;
20importjava.util.Map;
21
22/**
23*这个类专门用来测试注解使用
24*@authortmser
25*/
26@TestA//使用了类注解
27publicclassUserAnnotation{
28
29@TestA//使用了类成员注解
30privateIntegerage;
31
32@TestA//使用了构造方法注解
33publicUserAnnotation（）{
34
35}
36@TestA//使用了类方法注解
37publicvoida（）{
38@TestA//使用了局部变量注解
39Mapm=newHashMap（0）;
40}
41
42publicvoidb（@TestAIntegera）{//使用了方法参数注解
43
44}
45}
编译没有报错，ok，一个注解实验完成。
这个注解也太简单了吧，好像什么信息也不能传递。
别急下面就来一步步完善它，也该四位元注解依次开始上场了。
四个元注解分别是：
@Target,@Retention,@Documented,@Inherited，再次强调下元注解是javaAPI提供，是专门用来定义注解的注解，其作用分别如下。
@Target表示该注解用于什么地方，可能的值在枚举类ElemenetType中，包括：
ElemenetType.CONSTRUCTOR构造器声明
ElemenetType.FIELD域声明（包括enum实例）
ElemenetType.LOCAL_VARIABLE局部变量声明
ElemenetType.ANNOTATION_TYPE作用于注解量声明
ElemenetType.METHOD方法声明
ElemenetType.PACKAGE包声明
ElemenetType.PARAMETER参数声明
ElemenetType.TYPE类，接口（包括注解类型）或enum声明
@Retention表示在什么级别保存该注解信息。
可选的参数值在枚举类型RetentionPolicy中，包括：
RetentionPolicy.SOURCE注解将被编译器丢弃
RetentionPolicy.CLASS注解在class文件中可用，但会被VM丢弃
RetentionPolicy.RUNTIMEVM将在运行期也保留注释，因此可以通过反射机制读取注解的信息。
@Documented将此注解包含在javadoc中，它代表着此注解会被javadoc工具提取成文档。
在doc文档中的内容会因为此注解的信息内容不同而不同。
相当与@see,@param等。
@Inherited允许子类继承父类中的注解，例子中补充。
学习最忌好高骛远，我们就一个一个来实验。
第一个：
@Target，动手在前面我们编写的注解上加上元注解。
∙packagecom.tmser.annotation;
∙
∙importjava.lang.annotation.ElementType;
∙importjava.lang.annotation.Target;
∙/*
∙*定义注解Test
∙*首先使用ElementType.TYPE
∙*/
∙@Target（ElementType.PACKAGE）
∙public@interfaceTestA{
∙}
ctrl+s保存，今天电脑比较给力，我们的测试类那边立马出现了一堆错误，除了类注解。
我想到这，聪明的你立刻明白了这个元注解的意义了。
是不是想当然的偷起懒来了。
？
难道还有意外？
细心的朋友应该发现了，我们的测试类少了一个属性没用，就是ElemenetType.PACKAGE。
在我们的注解加上这个属性的元注解后，我们测试程序的元注解全部阵亡，不对，还有一个没加呢，好加上。
package包，想当然是加载package前面。
即
∙@TestApackagecom.tmser.annotation;
什么也报错。
这就搞不明白了，不加在这加哪去呢。
我也不知道了，不过这是编译错误，我们的eclipse将错误给我们指出了，就是
Packageannotationsmustbeinfilepackage-info.java，e文虽然不好，但这个简单的还是难不倒几个人的，package注解必须定义在package-info.java中。
package-info又是什么东西，好了为节省你们的时间帮你XX好了，传送门。
ok,到此target元注解就全部完成了。
第二个元注解：
@Retention参数RetentionPolicy。
有了前面的经验这个注解理解起来就简单多了，并且幸运的是这个注解还没有特殊的属性值。
简单演示下如何使用：
∙*运行级别定为运行时，以便后面测试解析
∙*/
∙@Target（ElementType.PACKAGE）
∙
@Retention（RetentionPolicy.RUNTIME）
第三和第四个元注解就不再举例了。
比较简单，也没有值，相信看过上面的解释也就清楚了。
下面我们还是继续来深入的探讨下注解的使用。
上面的例子都非常简单，注解连属性都没有。
ok，下面我们就来定义一个有属性的注解，并在例子程序中获取都注解中定义的值。
开始之前将下定义属性的规则：
@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。
方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。
可以通过default来声明参数的默认值。
代码：
∙*为方便测试：
注解目标为类方法，属性及构造方法
∙*注解中含有三个元素id,name和gid;
∙*id元素有默认值0
∙@Target（{TYPE,METHOD,FIELD,CONSTRUCTOR}）
∙@Retention（RetentionPolicy.RUNTIME）
∙Stringname（）;
∙intid（）default0;
∙Class<
Long>
gid（）;
下面改下我们的测试类：
∙importjava.util.HashMap;
∙importjava.util.Map;
∙/**
∙*这个类专门用来测试注解使用
∙*@authortmser
∙*/
∙@TestA（name="
type"
gid=Long.class）//类成员注解
∙publicclassUserAnnotation{
param"
id=1,gid=Long.class）//类成员注解
∙privateIntegerage;
∙@TestA（name="
construct"
id=2,gid=Long.class）//构造方法注解
∙publicUserAnnotation（）{
publicmethod"
id=3,gid=Long.class）//类方法注解
∙publicvoida（）{
∙Map<
String,String>
m=newHashMap<
（0）;
protectedmethod"
id=4,gid=Long.class）//类方法注解
∙protectedvoidb（）{
privatemethod"
id=5,gid=Long.class）//类方法注解
∙privatevoidc（）{
∙publicvoidb（Integera）{
下面到了最重要的一步了，就是如何读取我们在类中定义的注解。
只要读取出来了使用的话就简单了。
jdk1.5既然增加了注解，肯定就增加了相关读取的api
在java.lang.reflect包中新增了AnnotatedElement接口，JDK源码如下：
∙publicinterfaceAnnotatedElement{
∙booleanisAnnotationPresent（Class<
?
extendsAnnotation>
annotationClass）;
∙<
TextendsAnnotation>
TgetAnnotation（Class<
T>
∙Annotation[]getAnnotations（）;
∙Annotation[]getDeclaredAnnotations（）;
46isAnnotationPresent：
判断是否标注了指定注解
47getAnnotation：
获取指定注解，没有则返回null
48getAnnotations：
获取所有注解，包括继承自基类的，没有则返回长度为0的数组
49getDeclaredAnnotations：
获取自身显式标明的所有注解，没有则返回长度为0的数组
∙importjava.lang.annotation.Annotation;
∙importjava.lang.reflect.Constructor;
∙importjava.lang.reflect.Method;
∙publicclassParseAnnotation{
∙*简单打印出UserAnnotation类中所使用到的类注解
∙*该方法只打印了Type类型的注解
∙*@throwsClassNotFoundException
∙publicstaticvoidparseTypeAnnotation（）throwsClassNotFoundException{
∙Classclazz=Class.forName（"
com.tmser.annotation.UserAnnotation"
）;
∙Annotation[]annotations=clazz.getAnnotations（）;
∙for（Annotationannotation:
annotations）{
∙TestAtestA=（TestA）annotation;
∙System.out.println（"
id=\"
"
+testA.id（）+"
\"
;
name=\"
+testA.name（）+"
gid="
+testA.gid（））;
∙}
∙*简单打印出UserAnnotation类中所使用到的方法注解
∙*该方法只打印了Method类型的注解
∙publicstaticvoidparseMethodAnnotation（）{
∙Method[]methods=UserAnnotation.class.getDeclaredMethods（）;
∙for（Methodmethod:
methods）{
∙*判断方法中是否有指定注解类型的注解
∙booleanhasAnnotation=method.isAnnotationPresent（TestA.class）;
∙if（hasAnnotation）{
∙*根据注解类型返回方法的指定类型注解
∙TestAannotation=method.getAnnotation（TestA.class）;
method="
+method.getName（）
∙+"
;
id="
+annotation.id（）+"
description="
∙+annotation.name（）+"
gid="
+annotation.gid（））;
∙publicstaticvoidparseConstructAnnotation（）{
∙Constructor[]constructors=UserAnnotation.class.getConstructors（）;
∙for（Constructorconstructor:
constructors）{
∙*判断构造方法中是否有指定注解类型的注解
∙booleanhasAnnotation=constructor.isAnnotationPresent（TestA.class）;
∙TestAannotation=（TestA）constructor.getAnnotation（TestA.class）;
constructor="
+constructor.getName（）
∙publicstaticvoidmain（String[]args）throwsClassNotFoundException{
∙parseTypeAnnotation（）;
∙parseMethodAnnotation（）;
∙parseConstructAnnotation（）;
先别说话，运行：
∙id="
0"
name="
gid=classjava.lang.Long
∙method=c;
id=5;
description=privatemethod;
gid=classjava.lang.Long
∙method=a;
id=3;
description=publicmethod;
∙method=b;
id=4;
description=protectedmethod;
∙constructor=com.tmser.annotation.UserAnnotation;
id=2;
description=construct;
看到了吧，我们定义的注解都完整的输出了，你要使用哪个，直接拿去用就好了。
为了不让这篇文章打开太慢，我省略了类属性注解，及参数注解的解析。
其实都大同小异。
另外，我也没有举使用例子。
因为我认为好的教程是讲的详细的同时，还会留有扩展。
如果我全部写出来，而你只是学习的话，那基本不会自己去动脑了，而是复制粘贴运行一遍完事。
最后提醒下：
1.要用好注解，必须熟悉java的反射机制，从上面的例子可以看出，注解的解析完全依赖于反射。
2.不要滥用注解。
平常我们编程过程很少接触和使用注解，只有做设计，且不想让设计有过多的配置时。
疑问：
即ElementType.ANNOTATION_TYPE：
注解类型，到底什么作用，我发现即使不使用这个类型，我们自定义的注解也可以用来注释其他注解（eclipse报错，但仍可以编译，也仍可以在测试类中读取出报错的注解，使用TYPE编译器都不报错），难道只是标示注解是个元注解，知道的麻烦告知一下。
java注解的使用
annotate
项目会经常解析properies文件，根据key获得value，下面写一个如何使用注解的方式来获得value
1.AnnotateProperties类：
用来获得properties文件的路径
Java代码
∙packageAnnotateSrc;
∙importjava.lang.annotation.Retention;
∙importjava.lang.annotation.RetentionPolicy;
∙@Target（{ElementType.TYPE}）
∙@Retention（RetentionPolicy.RUNTIME）
∙public@interfaceAnnotateProperties{
∙Stringvalue（）;
∙Stringkey（）default"
2.Property类：
用来记录键值对
∙@Target（{ElementType.FIELD}）
∙@Retention（RetentionPolicy.RU
升级会员 