Java Annotation 学习（1）

一概念

注解（Annotation） 为我们在代码中添加信息提供了一种形式化的方法，是我们可以在稍后 某个时刻方便地使用这些数据（通过 解析注解
来使用这些数据）

类型

常见的作用有以下几种：
1.生成文档。这是最常见的，也是java 最早提供的注解。常用的有@see @param @return 等；
2.跟踪代码依赖性，实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。作用就是减少配置。现在的框架基本都使用了这种配置来减少配置文件的数量；
3.在编译时进行格式检查。如@Override放在方法前，如果你这个方法并不是覆盖了超类方法，则编译时就能检查出；

元注解

包 java.lang.annotation 中包含所有定义自定义注解所需用到的原注解和接口。如接口 java.lang.annotation.Annotation 是所有注解继承的接口,并且是自动继承，不需要定义时指定，类似于所有类都自动继承Object。

该包同时定义了四个元注解，Documented,Inherited,Target(作用范围，方法，属性，构造方法等),Retention(生命范围，源代码，class,runtime)。Inherited : 在您定义注解后并使用于程序代码上时，预设上父类别中的注解并不会被继承至子类别中，您可以在定义注解时加上java.lang.annotation.Inherited 限定的Annotation，这让您定义的Annotation型别被继承下来。注意注解继承只针对class 级别注解有效。

四个元注解分别是：@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 允许子类继承父类中的注解。

代码

自定义TestA注解

package com.melvin.annotation;import java.lang.annotation.ElementType;import java.lang.annotation.Target;@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})@Retention(RetentionPolicy.RUNTIME)public @interface TestA {String name();int id() default 0;Class gid();}

测试类代码

package com.melvin.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.melvin.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("id= ""+testA.id()+""; name= ""+testA.name()+""; gid = "+testA.gid());          }      } public static void parseMethodAnnotation(){Method[] methods = UserAnnotation.class.getDeclaredMethods();          for (Method method : methods) {              boolean hasAnnotation = method.isAnnotationPresent(TestA.class);              if (hasAnnotation) {              TestA annotation = method.getAnnotation(TestA.class);                  System.out.println("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("constructor = " + constructor.getName()                          + " ; id = " + annotation.id() + " ; description = "                          + annotation.name() + "; gid= "+annotation.gid());              }          }  }

main函数调用

public static void main(String[] args) throws ClassNotFoundException {    parseTypeAnnotation();    parseMethodAnnotation();    parseConstructAnnotation();    }}