http://blog.csdn.net/xiaoping8411/article/details/5024568
http://blog.csdn.net/liuwenbo0920/article/details/7290586
http://yelinsen.iteye.com/blog/1051772
Java注解(Annotation)博客分类： JAVA基础JavaJVM软件测试编程虚拟机 注解（Annotation） 为我们在代码中天界信息提供了一种形式化的方法，是我们可以在稍后 某个时刻方便地使用这些数据（通过 解析注解 来使用这些数据）。 注解的语法比较简单，除了@符号的使用以外，它基本上与java的固有语法一致，java内置了三种 注解，定义在java.lang包中。 @Override 表示当前方法是覆盖父类的方法。 @Deprecated 表示当前元素是不赞成使用的。 @SuppressWarnings 表示关闭一些不当的编译器警告信息。 下面是一个定义注解的实例 Java代码 package Test_annotation; import java.lang.annotation.Documented; import java.lang.annotation.Inherited; import java.lang.annotation.Retention; import java.lang.annotation.Target; import java.lang.annotation.ElementType; import java.lang.annotation.RetentionPolicy; /* * 元注解@Target,@Retention,@Documented,@Inherited * * @Target 表示该注解用于什么地方，可能的 ElemenetType 参数包括： * ElemenetType.CONSTRUCTOR 构造器声明 * ElemenetType.FIELD 域声明（包括 enum 实例） * ElemenetType.LOCAL_VARIABLE 局部变量声明 * ElemenetType.METHOD 方法声明 * ElemenetType.PACKAGE 包声明 * ElemenetType.PARAMETER 参数声明 * ElemenetType.TYPE 类，接口（包括注解类型）或enum声明 * * @Retention 表示在什么级别保存该注解信息。可选的 RetentionPolicy 参数包括： * RetentionPolicy.SOURCE 注解将被编译器丢弃 * RetentionPolicy.CLASS 注解在class文件中可用，但会被VM丢弃 * RetentionPolicy.RUNTIME VM将在运行期也保留注释，因此可以通过反射机制读取注解的信息。 * * @Documented 将此注解包含在 javadoc 中 * * @Inherited 允许子类继承父类中的注解 * */ @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) @Documented @Inherited /* * 定义注解 Test * 注解中含有两个元素 id 和 description * description 元素 有默认值 "no description" */ public @interface Test { public int id(); public String description() default "no description"; } package Test_annotation; import java.lang.annotation.Documented; import java.lang.annotation.Inherited; import java.lang.annotation.Retention; import java.lang.annotation.Target; import java.lang.annotation.ElementType; import java.lang.annotation.RetentionPolicy; /* * 元注解@Target,@Retention,@Documented,@Inherited * * @Target 表示该注解用于什么地方，可能的 ElemenetType 参数包括： * ElemenetType.CONSTRUCTOR 构造器声明 * ElemenetType.FIELD 域声明（包括 enum 实例） * ElemenetType.LOCAL_VARIABLE 局部变量声明 * ElemenetType.METHOD 方法声明 * ElemenetType.PACKAGE 包声明 * ElemenetType.PARAMETER 参数声明 * ElemenetType.TYPE 类，接口（包括注解类型）或enum声明 * * @Retention 表示在什么级别保存该注解信息。可选的 RetentionPolicy 参数包括： * RetentionPolicy.SOURCE 注解将被编译器丢弃 * RetentionPolicy.CLASS 注解在class文件中可用，但会被VM丢弃 * RetentionPolicy.RUNTIME VM将在运行期也保留注释，因此可以通过反射机制读取注解的信息。 * * @Documented 将此注解包含在 javadoc 中 * * @Inherited 允许子类继承父类中的注解 * */ @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) @Documented @Inherited /* * 定义注解 Test * 注解中含有两个元素 id 和 description * description 元素 有默认值 "no description" */ public @interface Test { public int id(); public String description() default "no description"; } 下面是一个使用注解 和 解析注解的实例 Java代码 package Test_annotation; import java.lang.reflect.Method; public class Test_1 { /* * 被注解的三个方法 */ @Test(id = 1, description = "hello method_1") public void method_1() { } @Test(id = 2) public void method_2() { } @Test(id = 3, description = "last method") public void method_3() { } /* * 解析注解，将Test_1类 所有被注解方法 的信息打印出来 */ public static void main(String[] args) { Method[] methods = Test_1.class.getDeclaredMethods(); for (Method method : methods) { /* * 判断方法中是否有指定注解类型的注解 */ boolean hasAnnotation = method.isAnnotationPresent(Test.class); if (hasAnnotation) { /* * 根据注解类型返回方法的指定类型注解 */ Test annotation = method.getAnnotation(Test.class); System.out.println("Test( method = " + method.getName() + " , id = " + annotation.id() + " , description = " + annotation.description() + " )"); } } } } package Test_annotation; import java.lang.reflect.Method; public class Test_1 { /* * 被注解的三个方法 */ @Test(id = 1, description = "hello method_1") public void method_1() { } @Test(id = 2) public void method_2() { } @Test(id = 3, description = "last method") public void method_3() { } /* * 解析注解，将Test_1类 所有被注解方法 的信息打印出来 */ public static void main(String[] args) { Method[] methods = Test_1.class.getDeclaredMethods(); for (Method method : methods) { /* * 判断方法中是否有指定注解类型的注解 */ boolean hasAnnotation = method.isAnnotationPresent(Test.class); if (hasAnnotation) { /* * 根据注解类型返回方法的指定类型注解 */ Test annotation = method.getAnnotation(Test.class); System.out.println("Test( method = " + method.getName() + " , id = " + annotation.id() + " , description = " + annotation.description() + " )"); } } } } 输出结果如下： Test( method = method_1 , id = 1 , description = hello method_1 ) Test( method = method_2 , id = 2 , description = no description ) Test( method = method_3 , id = 3 , description = last method ) Annotation在java的世界正铺天盖地展开,有空写这一篇简单的annotations的文章,算是关于Annotation入门的文章吧,希望能各位们能抛砖,共同学习...... 不讲废话了,实践才是硬道理. 第一部分:了解一下java1.5起默认的三个annotation类型: 一个是@Override:只能用在方法之上的，用来告诉别人这一个方法是改写父类的。 一个是@Deprecated:建议别人不要使用旧的API的时候用的,编译的时候会用产生警告信息,可以设定在程序里的所有的元素上. 一个是@SuppressWarnings:这一个类型可以来暂时把一些警告信息消息关闭. 如果不清楚上面三个类型的具体用法，各位可以baidu或google一下的,很简单的。 第二部分:讲一下annotation的概念先，再来讲一下怎样设计自己的annotation. 首先在jdk自带的java.lang.annotation包里,打开如下几个源文件: 1、源文件Target.java Java代码 复制代码 1. @Documented 2. @Retention(RetentionPolicy.RUNTIME) 3. @Target(ElementType.ANNOTATION_TYPE) 4. public @interface Target { 5. ElementType[] value(); 6. } @Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.ANNOTATION_TYPE) public @interface Target { ElementType[] value(); } 其中的@interface是一个关键字，在设计annotations的时候必须把一个类型定义为@interface，而不能用class或interface关键字(会不会觉得sun有点吝啬,偏偏搞得与interface这么像). 2、源文件Retention.java Java代码 复制代码 1. @Documented 2. @Retention(RetentionPolicy.RUNTIME) 3. @Target(ElementType.ANNOTATION_TYPE) 4. public @interface Retention { 5. RetentionPolicy value(); 6. } @Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.ANNOTATION_TYPE) public @interface Retention { RetentionPolicy value(); } 看到这里，大家可能都模糊了,都不知道在说什么，别急，往下看一下. 在上面的文件都用到了RetentionPolicy，ElementType这两个字段,你可能就会猜到这是两个java文件.的确，这两个文件的源代码如下： 3、源文件RetentionPolicy.java Java代码 复制代码 1. public enum RetentionPolicy { 2. SOURCE, 3. CLASS, 4. RUNTIME 5. } public enum RetentionPolicy { SOURCE, CLASS, RUNTIME } 这是一个enum类型,共有三个值，分别是SOURCE,CLASS 和 RUNTIME. SOURCE代表的是这个Annotation类型的信息只会保留在程序源码里，源码如果经过了编译之后，Annotation的数据就会消失,并不会保留在编译好的.class文件里面。 ClASS的意思是这个Annotation类型的信息保留在程序源码里,同时也会保留在编译好的.class文件里面,在执行的时候，并不会把这一些信息加载到虚拟机(JVM)中去.注意一下，当你没有设定一个Annotation类型的Retention值时，系统默认值是CLASS. 第三个,是RUNTIME,表示在源码、编译好的.class文件中保留信息，在执行的时候会把这一些信息加载到JVM中去的． 举一个例子，如@Override里面的Retention设为SOURCE,编译成功了就不要这一些检查的信息;相反,@Deprecated里面的 Retention设为RUNTIME,表示除了在编译时会警告我们使用了哪个被Deprecated的方法,在执行的时候也可以查出该方法是否被 Deprecated. 4、源文件ElementType.java Java代码 复制代码 1. public enum ElementType { 2. TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, 3. LOCAL_VARIABLE, ANNOTATION_TYPE,PACKAGE 4. } public enum ElementType { TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE, ANNOTATION_TYPE,PACKAGE } ＠Target里面的ElementType是用来指定Annotation类型可以用在哪一些元素上的.说明一下：TYPE(类型), FIELD(属性), METHOD(方法), PARAMETER(参数), CONSTRUCTOR(构造函数),LOCAL_VARIABLE(局部变量), ANNOTATION_TYPE,PACKAGE(包),其中的TYPE(类型)是指可以用在Class,Interface,Enum和 Annotation类型上. 另外,从1的源代码可以看出,@Target自己也用了自己来声明自己,只能用在ANNOTATION_TYPE之上. 如果一个Annotation类型没有指明@Target使用在哪些元素上,那么它可以使用在任何元素之上,这里的元素指的是上面的八种类型. 举几个正确的例子: @Target(ElementType.METHOD) @Target(value=ElementType.METHOD) @Target(ElementType.METHOD,ElementType.CONSTRUCTOR) 具体参考一下javadoc文档 上面一下1和2的源文件，它们都使用了@Documented,@Documented的目的就是让这一个Annotation类型的信息能够显示在 javaAPI说明文档上;没有添加的话，使用javadoc生成API文档的时候就会找不到这一个类型生成的信息. 另外一点，如果需要把Annotation的数据继承给子类，那么就会用到@Inherited这一个Annotation类型. 第三部分:下面讲的设计一个最简单的Annotation例子,这一例子共用四个文件; 1、Description.java Java代码 复制代码 1. package lighter.javaeye.com; 2. 3. import java.lang.annotation.Documented; 4. import java.lang.annotation.ElementType; 5. import java.lang.annotation.Retention; 6. import java.lang.annotation.RetentionPolicy; 7. import java.lang.annotation.Target; 8. 9. @Target(ElementType.TYPE) 10. @Retention(RetentionPolicy.RUNTIME) 11. @Documented 12. public @interface Description { 13. String value(); 14. } package lighter.javaeye.com; import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Description { String value(); } 说明:所有的Annotation会自动继承java.lang.annotation这一个接口,所以不能再去继承别的类或是接口. 最重要的一点,Annotation类型里面的参数该怎么设定: 第一,只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型. 第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String. 第三,如果只有一个参数成员,最好把参数名称设为"value",后加小括号.例:上面的例子就只有一个参数成员. 2、Name.java Java代码 复制代码 1. package lighter.javaeye.com; 2. 3. import java.lang.annotation.Documented; 4. import java.lang.annotation.ElementType; 5. import java.lang.annotation.Retention; 6. import java.lang.annotation.RetentionPolicy; 7. import java.lang.annotation.Target; 8. 9. //注意这里的@Target与@Description里的不同,参数成员也不同 10. @Target(ElementType.METHOD) 11. @Retention(RetentionPolicy.RUNTIME) 12. @Documented 13. public @interface Name { 14. String originate(); 15. String community(); 16. } package lighter.javaeye.com; import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; //注意这里的@Target与@Description里的不同,参数成员也不同 @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Name { String originate(); String community(); } 3、JavaEyer.java Java代码 复制代码 1. package lighter.javaeye.com; 2. 3. @Description("javaeye,做最棒的软件开发交流社区") 4. public class JavaEyer { 5. @Name(originate="创始人:robbin",community="javaEye") 6. public String getName() 7. { 8. return null; 9. } 10. 11. @Name(originate="创始人:江南白衣",community="springside") 12. public String getName2() 13. { 14. return "借用两位的id一用,写这一个例子,请见谅!"; 15. } 16. } package lighter.javaeye.com; @Description("javaeye,做最棒的软件开发交流社区") public class JavaEyer { @Name(originate="创始人:robbin",community="javaEye") public String getName() { return null; } @Name(originate="创始人:江南白衣",community="springside") public String getName2() { return "借用两位的id一用,写这一个例子,请见谅!"; } } 4、最后，写一个可以运行提取JavaEyer信息的类TestAnnotation Java代码 复制代码 1. package lighter.javaeye.com; 2. 3. import java.lang.reflect.Method; 4. import java.util.HashSet; 5. import java.util.Set; 6. 7. public class TestAnnotation { 8. /** 9. * author lighter 10. * 说明:具体关天Annotation的API的用法请参见javaDoc文档 11. */ 12. public static void main(String[] args) throws Exception { 13. String CLASS_NAME = "lighter.javaeye.com.JavaEyer"; 14. Class test = Class.forName(CLASS_NAME); 15. Method[] method = test.getMethods(); 16. boolean flag = test.isAnnotationPresent(Description.class); 17. if(flag) 18. { 19. Description des = (Description)test.getAnnotation(Description.class); 20. System.out.println("描述:"+des.value()); 21. System.out.println("-----------------"); 22. } 23. 24. //把JavaEyer这一类有利用到@Name的全部方法保存到Set中去 25. Set<Method> set = new HashSet<Method>(); 26. for(int i=0;i<method.length;i++) 27. { 28. boolean otherFlag = method[i].isAnnotationPresent(Name.class); 29. if(otherFlag) set.add(method[i]); 30. } 31. for(Method m: set) 32. { 33. Name name = m.getAnnotation(Name.class); 34. System.out.println(name.originate()); 35. System.out.println("创建的社区:"+name.community()); 36. } 37. } 38. } package lighter.javaeye.com; import java.lang.reflect.Method; import java.util.HashSet; import java.util.Set; public class TestAnnotation { /** * author lighter * 说明:具体关天Annotation的API的用法请参见javaDoc文档 */ public static void main(String[] args) throws Exception { String CLASS_NAME = "lighter.javaeye.com.JavaEyer"; Class test = Class.forName(CLASS_NAME); Method[] method = test.getMethods(); boolean flag = test.isAnnotationPresent(Description.class); if(flag) { Description des = (Description)test.getAnnotation(Description.class); System.out.println("描述:"+des.value()); System.out.println("-----------------"); } //把JavaEyer这一类有利用到@Name的全部方法保存到Set中去 Set<Method> set = new HashSet<Method>(); for(int i=0;i<method.length;i++) { boolean otherFlag = method[i].isAnnotationPresent(Name.class); if(otherFlag) set.add(method[i]); } for(Method m: set) { Name name = m.getAnnotation(Name.class); System.out.println(name.originate()); System.out.println("创建的社区:"+name.community()); } } } 5、运行结果： 描述:javaeye,做最棒的软件开发交流社区 ----------------- 创始人:robbin 创建的社区:javaEye 创始人:江南白衣 创建的社区:springside Java注解(Annotation) Annotation(注释)是JDK5.0及以后版本引入的。它可以用于创建文档，跟踪代码中的依赖性，甚至执行基本编译时检查。注释是以‘@注释名’在代码中存在的，根据注释参数的个数，我们可以将注释分为：标记注释、单值注释、完整注释三类。它们都不会直接影响到程序的语义，只是作为注释（标识）存在，我们可以通过反射机制编程实现对这些元数据的访问。另外，你可以在编译时选择代码里的注释是否只存在于源代码级，或者它也能在class文件中出现。 元数据的作用 如果要对于元数据的作用进行分类，目前还没有明确的定义，不过我们可以根据它所起的作用，大致可分为三类：编写文档：通过代码里标识的元数据生成文档。 代码分析：通过代码里标识的元数据对代码进行分析。 编译检查：通过代码里标识的元数据让编译器能实现基本的编译检查。 1. 基本内置注释 @Override Java代码 package com.iwtxokhtd.annotation; /** * 测试Override注解 * @author Administrator * */ public class OverrideDemoTest { //@Override public String tostring(){ return "测试注释"; } } @Deprecated的作用是对不应该在使用的方法添加注释，当编程人员使用这些方法时，将会在编译时显示提示信息，它与javadoc里的@deprecated标记有相同的功能，准确的说，它还不如javadoc @deprecated，因为它不支持参数，使用@Deprecated的示例代码示例如下： Java代码 package com.iwtxokhtd.annotation; /** * 测试Deprecated注解 * @author Administrator * */ public class DeprecatedDemoTest { public static void main(String[] args) { //使用DeprecatedClass里声明被过时的方法 DeprecatedClass.DeprecatedMethod(); } } class DeprecatedClass{ @Deprecated public static void DeprecatedMethod() { } } @SuppressWarnings,其参数有： deprecation，使用了过时的类或方法时的警告 unchecked，执行了未检查的转换时的警告 fallthrough，当 Switch 程序块直接通往下一种情况而没有 Break 时的警告 path，在类路径、源文件路径等中有不存在的路径时的警告 serial，当在可序列化的类上缺少 serialVersionUID 定义时的警告 finally ，任何 finally 子句不能正常完成时的警告 all，关于以上所有情况的警告 Java代码 package com.iwtxokhtd.annotation; import java.util.ArrayList; import java.util.List; public class SuppressWarningsDemoTest { public static List list=new ArrayList(); @SuppressWarnings("unchecked") public void add(String data){ list.add(data); } } 2. 自定义注释 它类似于新创建一个接口类文件，但为了区分，我们需要将它声明为@interface,如下例： Java代码 package com.iwtxokhtd.annotation; public @interface NewAnnotation { } 使用自定义的注释类型 Java代码 package com.iwtxokhtd.annotation; public class AnnotationTest { @NewAnnotation public static void main(String[] args) { } } 为自定义注释添加变量 Java代码 package com.iwtxokhtd.annotation; public @interface NewAnnotation { String value(); } Java代码 public class AnnotationTest { @NewAnnotation("main method") public static void main(String[] args) { saying(); } @NewAnnotation(value = "say method") public static void saying() { } } 定义一个枚举类型，然后将参数设置为该枚举类型，并赋予默认值 public @interface Greeting { public enum FontColor { BLUE, RED, GREEN }; String name(); FontColor fontColor() default FontColor.RED; } 这里有两种选择，其实变数也就是在赋予默认值的参数上，我们可以选择使用该默认值，也可以重新设置一个值来替换默认值 Java代码 public class AnnotationTest { @NewAnnotation("main method") public static void main(String[] args) { saying(); sayHelloWithDefaultFontColor(); sayHelloWithRedFontColor(); } @NewAnnotation("say method") public static void saying() { } // 此时的fontColor为默认的RED @Greeting(name = "defaultfontcolor") public static void sayHelloWithDefaultFontColor() { } // 现在将fontColor改为BLUE @Greeting(name = "notdefault", fontColor = Greeting.FontColor.BLUE) public static void sayHelloWithRedFontColor() { } } 3. 注释的高级应用 3.1. 限制注释的使用范围 用@Target指定ElementType属性 Java代码(jdk) package java.lang.annotation; public enum ElementType { TYPE, // 用于类，接口，枚举但不能是注释 FIELD, // 字段上，包括枚举值 METHOD, // 方法，不包括构造方法 PARAMETER, // 方法的参数 CONSTRUCTOR, //构造方法 LOCAL_VARIABLE, // 本地变量或catch语句 ANNOTATION_TYPE, // 注释类型(无数据) PACKAGE // Java包 } 3.2. 注解保持性策略 Java代码 //限制注解使用范围 @Target({ElementType.METHOD,ElementType.CONSTRUCTOR}) public @interface Greeting { //使用枚举类型 public enum FontColor{ BLUE,RED,GREEN }; String name(); FontColor fontColor() default FontColor.RED; } 在Java编译器编译时，它会识别在源代码里添加的注释是否还会保留，这就是RetentionPolicy。下面是Java定义的RetentionPolicy枚举： 编译器的处理有三种策略： 将注释保留在编译后的类文件中，并在第一次加载类时读取它 将注释保留在编译后的类文件中，但是在运行时忽略它 按照规定使用注释，但是并不将它保留到编译后的类文件中 Java代码 package java.lang.annotation; public enum RetentionPolicy { SOURCE, // 此类型会被编译器丢弃 CLASS, // 此类型注释会保留在class文件中，但JVM会忽略它 RUNTIME // 此类型注释会保留在class文件中，JVM会读取它 } Java代码 //让保持性策略为运行时态，即将注解编码到class文件中，让虚拟机读取 @Retention(RetentionPolicy.RUNTIME) public @interface Greeting { //使用枚举类型 public enum FontColor{ BLUE,RED,GREEN }; String name(); FontColor fontColor() default FontColor.RED; } 3.3. 文档化功能 Java提供的Documented元注释跟Javadoc的作用是差不多的，其实它存在的好处是开发人员可以定制Javadoc不支持的文档属性，并在开发中应用。它的使用跟前两个也是一样的，简单代码示例如下： Java代码 //让它定制文档化功能 //使用此注解时必须设置RetentionPolicy为RUNTIME @Documented public @interface Greeting { //使用枚举类型 public enum FontColor{ BLUE,RED,GREEN }; String name(); FontColor fontColor() default FontColor.RED; } 3.4. 标注继承 Java代码 //让它允许继承，可作用到子类 @Inherited public @interface Greeting { //使用枚举类型 public enum FontColor{ BLUE,RED,GREEN }; String name(); FontColor fontColor() default FontColor.RED; } 4. 读取注解信息 属于重点，在系统中用到注解权限时非常有用，可以精确控制权限的粒度 注意： 要想使用反射去读取注解，必须将Retention的值选为Runtime Java代码 package com.iwtxokhtd.annotation; import java.lang.annotation.Annotation; import java.lang.reflect.Method; //读取注解信息 public class ReadAnnotationInfoTest { public static void main(String[] args) throws Exception { // 测试AnnotationTest类，得到此类的类对象 Class c = Class.forName("com.iwtxokhtd.annotation.AnnotationTest"); // 获取该类所有声明的方法 Method[] methods = c.getDeclaredMethods(); // 声明注解集合 Annotation[] annotations; // 遍历所有的方法得到各方法上面的注解信息 for (Method method : methods) { // 获取每个方法上面所声明的所有注解信息 annotations = method.getDeclaredAnnotations(); // 再遍历所有的注解，打印其基本信息 System.out.println(method.getName()); for (Annotation an : annotations) { System.out.println("方法名为：" + method.getName() + " 其上面的注解为：" + an.annotationType().getSimpleName()); Method[] meths = an.annotationType().getDeclaredMethods(); // 遍历每个注解的所有变量 for (Method meth : meths) { System.out.println("注解的变量名为：" + meth.getName()); } } } } }
