Java注解

Java注解，也叫元数据，是jdk1.5引入的。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，是给计算机看的，不是程序的一部分。其本质上就是一个继承Annotation接口的接口。

作用分类

• 编写文档：通过代码里标识的注解生成文档
• 代码分析：通过代码里标识的注解对代码进行分析
• 编译检查：通过代码里标识的注解让编译器能够实现基本的编译检查。如：@Override

自定义注解

格式：

1
2
3
4

元注解
public @interface 注解名称{
    属性列表;
}

属性：接口中的抽象方法

• 属性的返回值类型：
  • 基本数据类型
  • String
  • 枚举
  • 注解
  • 以上类型的数组， 使用{}表示
• 定义了属性后，在使用注解时需要赋值
  • 使用default给属性默认初始化值的，可以不进行属性的赋值
  • 如果只有一个value属性需要赋值，则value可以省略，直接定义值即可。
  • 数组赋值时，值使用{}包裹。如果数组中只有一个值，则{}可以省略

元注解：用于描述注解的注解

• @Target：描述注解能够作用的位置
  • @Target(ElementType.TYPE): 被其注解的注解只能注解在类上
  • ElementType取值：
    • TYPE：类上
    • METHOD：方法上
    • FIELD：成员变量上
• @Retention：描述注解被保留的阶段
  • SOURCE, CLASS, RUNTIME
  • @Retention(RetentionPolicy.RUNTIME)
• @Documented：描述注解是否被javadoc抽取到api文档中
• @Inherited：描述注解是否被子类继承
  • 使用该注解的类，若有子类，子类同样会继承该注解

获取注解的属性值

1. 获取注解的子类实现对象
   • public <T extends Annotation> T getAnnotation(Class<T> annotationClass)：
     • 该方法类对象，成员函数对象，成员变量对象都可调用
2. 获取指定注解属性值
   • 使用获取到的对象调用注解中定义的抽象方法。

练习

• 定义注解

1
2
3
4
5
6

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation {
    String info() default "info";
    String value();
}

• 测试

1
2
3
4
5
6
7
8
9
10
11
12
13

@MyAnnotation("嘻嘻")
public class AnnotationTest {

    @Test
    public void testAnnotation() {
        Class<AnnotationTest> clazz = AnnotationTest.class;
        MyAnnotation anno = clazz.getAnnotation(MyAnnotation.class);
        if (anno != null) {
            System.out.println(anno.info());
            System.out.println(anno.value());
        }
    }
}