Java基础-注解

摘要

　　注解是JDK1.5引入的、符合JSR175规范的用来修饰元数据的工具。

正文

1 元注解

　　JDK1.5提供了四种元注解，用来修饰其他注解。

@Documented
@Retention
@Target
@Inherited

1.1 @Documented

　　中文含义：文档。表示注解将会包含在JavaDoc文档中。

1.2 @Retention

　　中文含义：保留。表示注解的保留策略，有下面三个选项。

RetentionPolicy.SOURCE：源码。仅保留在源码里，编译时丢弃，不会写入class文件。如：@Override、@SuppressWarnings。
RetentionPolicy.CLASS：class文件。写入class文件，在类加载的时候丢弃。注解默认使用这种方式。
RetentionPolicy.RUNTIME：运行时。始终不会丢弃，运行期也保留该注解，因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式。

1.3 @Target

　　中文含义：对象。表示注解可以修饰的对象。

ElementType.TYPE：用于描述类、接口或enum声明
ElementType.FIELD：用于描述实例变量
ElementType.METHOD：方法
ElementType.PARAMETER：参数
ElementType.CONSTRUCTOR：构造器
ElementType.LOCAL_VARIABLE：局部变量
ElementType.ANNOTATION_TYPE：注解
ElementType.PACKAGE：包

1.4 @Inherited

　　中文含义：继承。表示注解是否被子注解继承。　　
　　

2 注解定义

　　注解属性只支持基本类型、String、Class、Annotation及枚举类型、数组。所有的属性被定义成方法，并允许提供默认值。如下：

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface RequestMapping {

    String name() default "";

    @AliasFor("path")
    String[] value() default {};

    @AliasFor("value")
    String[] path() default {};

    RequestMethod[] method() default {};

    String[] params() default {};

    String[] headers() default {};

    String[] consumes() default {};

    String[] produces() default {};
}

3 注解的使用

　　大部分自定义注解都的保留策略都是Runtime，可以通过反射获取注解属性，如下：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Author {
    String value();
}

@Author("ly")
public class AnnotationDemo {
    public static void main(String[] args) {
        Class demo = AnnotationDemo.class;
        Author author = (Author) demo.getAnnotation(Author.class);
        System.out.println(author.value());
    }
}

　　输出结果：ly