新学注解,很是不明白,在经过视频与这篇博文后算是有了一个初步的认识,转载过来做了一些修改说明,原文链接http://blog.sina.com.cn/s/blog_93dc666c0101gzn5.html
java 注解定义。注解(Annotation) 为我们在代码中添加信息提供了一种形式化的方法,是我们可以在稍后 某个时刻方便地使用这些数据(通过 解析注解 来使用这些数据)。
java 注解常见的作用: 1.生成文档。最常见,也是java 最早提供的注解。常用的有@see @param @return 等; 2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。作用就是减少配置。现在的框架基本都使用了这种配置来减少配置文件的数量; 3.在编译时进行格式检查。如@Override放在方法前,如果你这个方法并不是覆盖了超类方法,则编译时就能检查出;
java 注解相关包: 包 java.lang.annotation 中包含所有定义自定义注解所需用到的原注解和接口。如接口 java.lang.annotation.Annotation 是所有注解继承的接口,并且是自动继承,不需要定义时指定,类似于所有类都自动继承Object。
四个元注解: 该包同时定义了四个元注解,1.Documented,2.Inherited,3.Target(作用范围,方法,属性,构造方法等),4.Retention(生命范围,源代码,class,runtime)。下面将在实例中逐个讲解他们的作用,及使用方法。元注解:自定义注解时需要用到的注解,是基本内置注解 建立第一个注解,空注解,注解体内部什么属性都没有(@interface用来声明一个注解):
package com.tmser.annotation; public @interface TestA { //这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。 } 使用注解: package com.tmser.annotation; import java.util.HashMap; import java.util.Map; @TestA //使用了类注解 public class UserAnnotation { @TestA //使用了类成员注解 private Integer age; @TestA //使用了构造方法注解 public UserAnnotation(){ } @TestA //使用了类方法注解 public void a(){ @TestA //使用了局部变量注解 Map m = new HashMap(0); } public void b(@TestA Integer a){ //使用了方法参数注解 } } 编译没报错。这个注解很简单,什么信息也不能传递。下面进行完善它,要使用四位元注解。 四个元注解:@Target,@Retention,@Documented,@Inherited ,再次强调下元注解是java API提供,是 专门用来定义注解的注解,其作用分别如下: @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 中 ,它代表着此注解会被javadoc工具提取成文档。在doc文档中的内容会因为此注解的信息内容不同而不同。相当与@see,@param 等。 @Inherited 允许子类继承父类中的注解。 接下来进行注解完善修改: 第一个:@Target,动手在前面我们编写的注解上加上元注解。 package com.tmser.annotation; import java.lang.annotation.ElementType; import java.lang.annotation.Target; @Target(ElementType.PACKAGE) //与前面定义的注解不同的地方,这里使用了元注解Target public @interface TestA { }使用了第一个元注解:Target,这次修改之后会出现报错,报错文件是UserAnnotation,因为元注解Target的作用是表明这个自定义注解在什么地方用。 @Target(ElementType.PACKAGE)这个元注解的意思是这个自定义注解必须定义在 package-info.java 中,也就是用在包的前面。 我们先不进行排错处理 第二个元注解: @Retention 参数 RetentionPolicy。有了前面的经验这个注解理解起来就简单多了,并且幸运的是这个注解还没有特殊的属性值。 简单演示下如何使用: package com.tmser.annotation; import java.lang.annotation.ElementType; import java.lang.annotation.Target; @Target(ElementType.PACKAGE) @Retention(RetentionPolicy.RUNTIME) public @interface TestA { } 第三和第四个元注解就不再举例了。比较简单,也没有值。
下面开始定义并使用一个比上面复杂一点的注解: 开始之前将下定义属性的规则: @interface用来声明一个注解 代码:
package com.tmser.annotation; import java.lang.annotation.*; //自定义注解TestA @Target({ElementType.TYPE,ElementType.METHOD,ElementType.FIELD,ElementType.CONSTRUCTOR}) //@Target(ElementType.PACKAGE) //元注解Target,指出自定义注解的作用范围 @Retention(RetentionPolicy.RUNTIME)//元注解Retention,指出注解的生存周期 @Documented //元注解Document,无参数 @Inherited//元注解Inherited public @interface TestA { String name(); int id() default 0; Class gid(); } 下面改下我们的测试类(这里使用了上面的注解,并且传了参数): package com.tmser.annotation; import java.util.HashMap; import java.util.Map; @TestA(name = "type", gid = Long.class) public class UserAnnotation { @TestA(name = "param", id = 1, gid = Long.class) private Integer age; @TestA(name = "construct", id = 2, gid = Long.class) public UserAnnotation() { } @TestA(name = "public method", id = 3, gid = Long.class) public void a() { Map m = new HashMap(0); } @TestA(name = "protected method", id = 4, gid = Long.class) protected void b() { Map m = new HashMap(0); } @TestA(name = "private method", id = 5, gid = Long.class) private void c() { Map m = new HashMap(0); } public void b(Integer a) { } } 上面我们使用了注解,下面是读取我们在类中定义的这些注解,最终目的就是把这些注解读取出来,并且使用 package com.tmser.annotation; import java.lang.annotation.Annotation; import java.lang.reflect.Constructor; import java.lang.reflect.Method; public class ParseAnnotation { //获得 public static void parseTypeAnnotation() throws ClassNotFoundException { Class clazz = Class.forName("com.tmser.annotation.UserAnnotation"); //方法返回当前这个元素上的所有注解。它返回一个长度为零的数组,如果这个元素没有注解。该方法的调用者可以随意修改返回的数组;这对其他调用者返回的数组产生任何影响。 Annotation[] annotations = clazz.getAnnotations(); for(Annotation annotation:annotations){ TestA testA = (TestA)annotation; System.out.println("No.1: id="+testA.id()+";name="+testA.name()+";gid="+testA.gid()); } } public static void parseMethodAnnotation(){ Method[] methods=UserAnnotation.class.getDeclaredMethods(); for (Method method : methods) { //isAnnotationPresent如果一个注解指定注释类型是存在于此元素上此方法返回true,否则返回false boolean hasAnnotation = method.isAnnotationPresent(TestA.class); if (hasAnnotation) { TestA annotation = method.getAnnotation(TestA.class); System.out.println("No.2: method = " + method.getName() + " ; id = " + annotation.id() + " ; description = " + annotation.name() + "; gid= "+annotation.gid()); } } } public static void parseConstructAnnotation(){ Constructor[] constructors = UserAnnotation.class.getConstructors(); for (Constructor constructor : constructors) { boolean hasAnnotation = constructor.isAnnotationPresent(TestA.class); if (hasAnnotation) { TestA annotation =(TestA) constructor.getAnnotation(TestA.class); System.out.println("No.3: constructor = " + constructor.getName() + " ; id = " + annotation.id() + " ; description = " + annotation.name() + "; gid= "+annotation.gid()); } } } public static void main(String[] args) throws ClassNotFoundException { parseTypeAnnotation(); parseMethodAnnotation(); parseConstructAnnotation(); } } 附: 1. 要用好注解,必须熟悉java 的反射机制,从上面的例子可以看出,注解的解析完全依赖于反射。 2. 不要滥用注解。平常我们编程过程很少接触和使用注解,只有做设计,且不想让设计有过多的配置时 这个网址可以给你参考一些注解的例子:http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html3.上面代码可以方法到集成开发环境中,看得更加清楚。