Java基础：对注解的理解

从JDK1.5之后，引入了注解 Annotation

Annotation是一种应用于类、方法、参数、变量、构造器及包声明中的特殊修饰符。其作用是为其所修饰的变量，方法，类型，作用域等添加一些额外的属性信息。这些属性信息往往是不同对象共有的属性的抽象化。某些应用对这着额外的信息进行查询和处理。

常见的注解包括 @Override 重写接口方法， @Autowired  spring中的自动注入等。

我们先看一下注解的结构，以@Override为例：

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

可以看到，对接口的定义，是用"@interface" 来定义的，说明注解和接口interface的作用差不多。

在接口的定义上，还有几个注解：

J2SE5.0版本在 java.lang.annotation提供了四种元注解，专门注解其他的注解：

@Documented –注解是否将包含在JavaDoc中
@Retention –什么时候使用该注解
@Target? –注解用于什么地方
@Inherited – 是否允许子类继承该注解

@Documented–一个简单的Annotations标记注解，表示是否将注解信息添加在java文档中。

@Retention– 定义该注解的生命周期。

RetentionPolicy.SOURCE – 保留到编译阶段。这些注解在编译结束之后就不再有任何意义，所以它们不会写入字节码。@Override, @SuppressWarnings都属于这类注解。

RetentionPolicy.CLASS – 保留到CLASS字节文件中。在字节码文件的处理中有用。注解默认使用这种方式。

RetentionPolicy.RUNTIME– 始终不会丢弃，运行期也保留该注解，因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式。

@Target – 表示该注解用于什么地方。如果不明确指出，该注解可以放在任何地方。以下是一些可用的参数。需要说明的是：属性的注解是兼容的，如果你想给7个属性都添加注解，仅仅排除一个属性，那么你需要在定义target包含所有的属性。

ElementType.TYPE:用于描述类、接口或enum声明
ElementType.FIELD:用于描述实例变量
ElementType.METHOD:用于描述方法
ElementType.PARAMETER:用于描述参数
ElementType.CONSTRUCTOR:用于描述构造函数
ElementType.LOCAL_VARIABLE:用于描述本地变量
ElementType.ANNOTATION_TYPE 另一个注释
ElementType.PACKAGE 用于记录java文件的package信息

@Inherited – 定义该注释和子类的关系

下面我们自定义一个注解，来演示注解的作用：

我们定义一个注解 @TestAnnotation

作用于方法。

保留阶段到运行阶段。

在注解中，我们放置了两个枚举类型，Life，和Status。

另外我们定义了三个方法，并为其赋予了默认值。

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
    enum Life{chi,he,wan,le};
    enum Status{live,die};

    String name() default "zhang san";
    Life life() default Life.chi;
    Status status() default Status.live;

}

我们定义了一个Person类型，并自定义了两个方法sayHello和sayByeBye。给两个方法添加注解

public class Person {

    @TestAnnotation
    public void sayHello(){
        System.out.println("Hello");
    }
    @TestAnnotation(name = "li si",life = TestAnnotation.Life.le,status = TestAnnotation.Status.die)
    public void sayByeBye(){
        System.out.println("ByeBye");
    }
}

第一个方法sayHello()我们使用注解的默认属性参数，第二个方法sayByeBye我们重新赋予注解参数。

下面通过Java的反射机制，从方法中提取出注解，并解析出注解中属性的值。

public class Main {
    public static void main(String[]args){

        Person person = new Person();

        Method[] methods = person.getClass().getDeclaredMethods();

        for(Method method:methods){
            TestAnnotation testAnnotation = method.getAnnotation(TestAnnotation.class);
            System.out.println("----------------------------------------");
            System.out.println(method.getName());
            System.out.println(testAnnotation.name());
            System.out.println(testAnnotation.life());
            System.out.println(testAnnotation.status());
        }

    }
}

输出如下：

----------------------------------------
sayHello
zhang san
chi
live
----------------------------------------
sayByeBye
li si
le
die