Java中自定义注解,以及通过反射获得注解

元注解：

　 　元注解的作用就是负责注解其他注解 。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解：

　　　　1.@Target,

　　　　2.@Retention,

　　　　3.@Documented,

　　　　4.@Inherited

　　这些类型和它们所支持的类在java.lang.annotation包中可以找到。下面我们看一下每个元注解的作用和相应分参数的使用说明。

@Target：

　　　@Target说明了Annotation所修饰的对象范围：Annotation可被用于 packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。

　 　 作用：用于描述注解的使用范围（即：被描述的注解可以用在什么地方）

　 　取值(ElementType)有：

　　　　1.CONSTRUCTOR:用于描述构造器

　　　　2.FIELD:用于描述域

　　　　3.LOCAL_VARIABLE:用于描述局部变量

　　　　4.METHOD:用于描述方法

　　　　5.PACKAGE:用于描述包

　　　　6.PARAMETER:用于描述参数

　　　　7.TYPE:用于描述类、接口(包括注解类型) 或enum声明

　 @Retention：

　 　@Retention 定义了该Annotation被保留的时间长短：某些Annotation仅出现在源代码中，而被编译器丢弃；而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。

　　 作用：表示需要在什么级别保存该注释信息，用于描述注解的生命周期（即：被描述的注解在什么范围内有效）

　 　取值（RetentionPoicy）有：

　　 　　1.SOURCE:在源文件中有效（即源文件保留）

　　　　2.CLASS:在class文件中有效（即class保留）

　　　　3.RUNTIME:在运行时有效（即运行时保留）

　　Retention meta-annotation类型有唯一的value作为成员，它的取值来自java.lang.annotation.RetentionPolicy的枚举类型值

@Documented:

　　@ Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解，没有成员。

@Inherited：

　 　 @Inherited 元注解是一个标记注解，@Inherited阐述了某个被标注的类型是被继承的 。如果一个使用了 @Inherited修饰的annotation类型被用于一个class，则这个annotation将被用于该class的子类。

　　注意：@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation，方法并不从它所重载的方法继承annotation。

　　当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME，则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时，反射代码检查将展开工作：检查class和其父类，直到发现指定的annotation类型被发现，或者到达类继承结构的顶层。

自定义注解：

　　使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。 @interface 用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。

　　 定义注解格式：

　　public @interface 注解名 {定义体}

　　 注解参数的可支持数据类型：

　　　　 1.所有基本数据类型（int,float,boolean,byte,double,char,long,short)

　　　　2.String类型

　　　　3.Class类型

　　　　4.enum类型

　　　　5.Annotation类型

　　　　6.以上所有类型的数组

　　Annotation类型里面的参数该怎么设定: 

　　第一,只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型；　 　

　　第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String;　　

　　第三,如果只有一个参数成员,最好把参数名称设为"value",后加小括号.例:下面的例子FruitName注解就只有一个参数成员。

1.新建Interface，建完在名字前加@，就成了自定义的注解

[java]   view plain   copy

1. import java.lang.annotation.Documented;  
2. import java.lang.annotation.ElementType;  
3. import java.lang.annotation.Retention;  
4. import java.lang.annotation.RetentionPolicy;  
5. import java.lang.annotation.Target;  
6.   
7. /** 
8.  * 定义一个注解 
9.  */  
10. @Target(ElementType.METHOD) // 这是一个对方法的注解，还可以是包、类、变量等很多东西  
11. @Retention(RetentionPolicy.RUNTIME) // 保留时间，一般注解就是为了框架开发时代替配置文件使用，JVM运行时用反射取参数处理，所以一般都为RUNTIME类型  
12. @Documented // 用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化  
13. public @interface OneAnnotation {  
14.   
15.     // 定义注解的参数，类型可以为基本类型以及String、Class、enum、数组等，default为默认值  
16.     String parameter1() default "";  
17.     int parameter2() default -1;  
18. }  

2.使用注解的类

[java]   view plain   copy

1. /** 
2.  * 一个用到了自定义的注解的类 
3.  */  
4. public class OneClass {  
5.       
6.     @OneAnnotation(parameter1="YES", parameter2=10000)  
7.     public void oneMethod () {  
8.     }  
9. }  

3.提取注解参数

[java]   view plain   copy

1. import java.lang.reflect.Method;  
2.   
3.   
4. public class TestThis {  
5.   
6.     public static void main(String[] args) throws Exception {  
7.         // 提取到被注解的方法Method，这里用到了反射的知识  
8.         Method method = Class.forName("OneClass").getDeclaredMethod("oneMethod");  
9.         // 从Method方法中通过方法getAnnotation获得我们设置的注解  
10.         OneAnnotation oneAnnotation = method.getAnnotation(OneAnnotation.class);  
11.           
12.         // 得到注解的俩参数  
13.         System.out.println(oneAnnotation.parameter1());  
14.         System.out.println(oneAnnotation.parameter2());  
15.     }  
16. }  

测试结果：

YES

10000