Java 注解总结

作用

• 标记，告诉编译器一些信息。比如@Override，@Deprecated，@SuppressWarnings等。
• 运行时动态处理。可以通过相应的函数得到注解信息。
  • getAnnotation(AnnotationName.class) 表示得到该 Target 某个 Annotation 的信息，因为一个 Target 可以被多个 Annotation 修饰
  • getAnnotations() 则表示得到该 Target 所有 Annotation
  • isAnnotationPresent(AnnotationName.class) 表示该 Target 是否被某个 Annotation 修饰
• 编译时动态处理。编译时动态生成代码。

分类

• 标准Annotation，比如经常用到的@Override，@Deprecated，@SuppressWarnings，所谓标准Annotation即指Java自带的几个Annotation
• 元Annotation，如@Retention, @Target, @Inherited, @Documented，所谓元Annotation即指用来定义Annotation的Annnotation
  • @Retention
    • 用来指定注解的保留时间
    • 可选值:RetentionPolicy.SOURCE（源码时），RetentionPolicy.CLASS（编译时），RetentionPolicy.RUNTIME（运行时）
  • @ Target
    • 用来指定注解可以修饰哪些程序元素
    • 可选值:ElementType.TYPE, ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.PARAMETER 等
  • @ Inherited
    • 用来指定是否可被继承，默认为false
  • @ Documented
    • 用来指定是否保存到Javadoc文档中
• 自定义Annotation，有时候有这样的需求需要自己自定义Annotation，定义的过程中需要使用到元Annotation

标准Annotation使用

Java自带了一部分注解，平时其实在不经意的使用，使用的最多的莫过于@Override了，用于表示重写某个函数，然后还有@Deprecated，表示这个函数已经废弃了，不再推荐使用了。@SuppressWarnings用于表示忽略某个错误。

运行时Annotation解析

对某个类，字段或者函数加上运行时注解后，我们可以在运行时动态获取注解的信息。

Class<?> clazz=SomeClass.getClass();
Annotation[] annotations = clazz.getAnnotations();
for (Annotation annotation : annotations) {
    System.out.println(annotation.annotationType());
}

编译时Annotation解析

此类注解用于编译时动态生成代码。

编写注解

@Target({ElementType.FIELD,ElementType.METHOD})
@Retention(RetentionPolicy.CLASS)
public @interface TestAnnotation {
    String name();
    int version() default 1;
}

• 使用@interface来定义一个注解，注解名即自定义注解名
• 所有方法没有方法体，参数，修饰符
• 方法返回值只能是基本数据类型
• 使用default添加默认值

使用注解

public class Person {
    @TestAnnotation(name="name")
    private String name;

    @TestAnnotation(name="walk")
    public void walk(){
        System.out.println("walk");
    }
}

• 使用@注解名在对应的Target上使用，属性值通过 属性=”“ 进行使用

解析注解

@SupportedAnnotationTypes("cn.edu.zafu.TestAnnotation")
public class TestProcessor extends AbstractProcessor {

    @Override
    public boolean process(Set<? extends TypeElement> annotations,
            RoundEnvironment roundEnv) {

        for (TypeElement te : annotations) {
            for (Element element : roundEnv.getElementsAnnotatedWith(te)) {
                TestAnnotation testAnnotation = element
                        .getAnnotation(TestAnnotation.class);
                //testAnnotation.name()
                //testAnnotation.version()

            }
        }

        return true;
    }

}

• 使用@SupportedAnnotationTypes注解表示该类支持的注解的完整类路径，支持通配符
• 继承AbstractProcessor 类，所有处理在process中进行
• process 函数返回值表示这组 annotations 是否被这个 Processor 接受，如果接受后续 processor 不会再对这个 Annotations 进行处理

参考文章

1. 公共技术点之 Java 注解 Annotation