Java自定义注解详解

注解（Annotation）

注解提供了一种安全的类似注释的机制，为我们在代码中添加信息提供了一种形式化得方法，使我们可以在稍后某个时刻方便的使用这些数据（通过解析注解来使用这些数据），用来将任何的信息或者元数据与程序元素（类、方法、成员变量等）进行关联。其实就是更加直观更加明了的说明，这些说明信息与程序业务逻辑没有关系，并且是供指定的工具或框架使用的。Annotation像一种修饰符一样，应用于包、类型、构造方法、方法、成员变量、参数及本地变量的申明语句中。

Annotation其实是一种接口

通过java的反射机制相关的API来访问Annotation信息。相关类（框架或工具中的类）根据这些信息来决定如何使用该程序元素或改变它们的行为。Java语言解释器在工作时会忽略这些Annotation，因此在JVM中这些Annotation是“不起作用”的，只能通过配套的工具才能对这些Annotation类型的信息进行访问和处理。

Annotation和interface的异同

1. annotation的类型使用关键字@interface而不是interface。它继承了java.lang.annotition.Annotition接口，并非申明了一个interface。
2. Annotation类型、方法定义是独特的、受限制的。Annotation类型的方法必须申明为无参数、无异常抛出的。这些方法定义了Annotation的成员：方法名称为了成员名，而方法返回值称为了成员的类型。
3. 方法返回值必须为primitive类型、Class类型、枚举类型、Annotation类型或者由前面类型之一作为元素的一位数组。
4. 方法的后面可以使用default和一个默认数值来申明成员的默认值，null不能作为成员的默认值，这与我们在非Annotation类型中定义方法有很大不同。
5. Annotation类型和他的方法不能使用Annotation类型的参数，成员不能是generic。只有返回值类型是Class的方法可以在Annotation类型中使用generic，因为此方法能够用类转换将各种类型转换为Class。
6. Annotation类型又与接口有着近似之处。它们可以定义常量、静态成员类型（比如枚举类型定义）。Annotation类型也可以如接口一般被实现或者继承。

元注解

@Target 表示该注解用于什么地方
@Retention 表示在什么级别保存该注解信息
@Documented 将此注解包含在 javadoc 中
@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将在运行期也保留注释，因此可以通过反射机制读取注解的信息。
  

  ---

示例代码：

//Test.java
//该注解用于方法声明
@Target(ElementType.METHOD)
//VM将在运行期也保留注释，因此可以通过反射机制读取注解的信息
@Retention(RetentionPolicy.RUNTIME)
//允许子类继承父类中的注解
@Inherited
//将此注解包含在javadoc中
@Documented
public @interface Test {
    public int id();
    public String desc() default "no descrition"; 
}

public class DemoTest {

    @Test(id = 1, desc = "美丽的姑娘")
    public void method1() {
    }
    @Test(id=2)
    public void method2() {
    }

    @Test(id=3,desc="哎呦，原来如此")
    public void method3() {
    }   

    public static void main(String[] args) {

        Method[] methods = DemoTest.class.getDeclaredMethods();
        for(Method m:methods){

            boolean b = m.isAnnotationPresent(Test.class);
            if(b){
                Test annotation = m.getAnnotation(Test.class);
                System.out.println(annotation.id()+":"+annotation.desc());
            }

        }

    }
}

参考博客：http://freewxy.iteye.com/blog/1149128/