1. 注解概述

注解的概述

  • Java 注解（Annotation）又称 Java 标注，是 JDK5.0 引入的一种注释机制。
  • Java 语言中的类、构造器、方法、成员变量、参数等都可以被注解进行标注。

注解的作用

  • 对Java中类、方法、成员变量做标记，然后进行特殊处理，至于到底做何种处理由业务需求来决定。

例如：JUnit框架中，标记了注解@Test的方法就可以被当成测试方法执行，而没有标记的就不能当成测试方法执行。

2. 自定义注解

格式

1
2
3
public @interface 注解名称 {
    public 属性类型 属性名() default 默认值 ;
}
1
2
3
4
5
public @interface MyBook {
    String name();
    String[] authors();
    double price();
}

特殊属性

value属性，如果只有一个value属性的情况下，使用value属性的时候可以省略value名称不写!!

但是如果有多个属性, 且多个属性没有默认值，那么value名称是不能省略的。

1
2
3
4
5
public @interface Book {
    String value(); // 特殊属性
    double price() ;
    //double price() default 9.9;//有默认值也可以省略 
}
1
2
//@Book(value = "/delete")
// @Book("/delete")

3. 元注解

元注解：就是注解注解的注解

元注解有两个：

@Target: 约束自定义注解可以标记的范围

@Retention：用来约束自定义注解的存活范围

@Target中可使用的值定义在ElementType枚举类中，常用值如下

值 含义
TYPE 类，接口
FIELD 成员变量
METHOD 成员方法
PARAMETER 方法参数
CONSTRUCTOR 构造器
LOCAL_VARIABLE 局部变量

@Retention中可使用的值定义在RetentionPolicy枚举类中，常用值如下

值 含义
SOURCE 注解只作用在源码阶段，生成的字节码文件中不存在
CLASS 注解作用在源码阶段，字节码文件阶段，运行阶段不存在，默认值.
RUNTIME 注解作用在源码阶段，字节码文件阶段，运行阶段（开发常用） 
1
2
3
4
@Target({ElementType.METHOD,ElementType.FIELD}) // 元注解
@Retention(RetentionPolicy.RUNTIME) // 一直活着，在运行阶段这个注解也不消失
public @interface MyTest {
}

4. 注解解析

注解的操作中经常需要进行解析，注解的解析就是判断是否存在注解，存在注解就解析出内容。

与注解解析相关的接口

  • Annotation: 注解的顶级接口，注解都是Annotation类型的对象
  • AnnotatedElement:该接口定义了与注解解析相关的解析方法
方法 说明
Annotation[] getDeclaredAnnotations() 获得当前对象上使用的所有注解，返回注解数组
T getDeclaredAnnotation(Class<T> annotationClass) 根据注解类型获得对应注解对象
boolean isAnnotationPresent(Class<Annotation> annotationClass) 判断当前对象是否使用了指定的注解，如果使用了则返回true，否则false

所有的类成分Class, Method , Field , Constructor，都实现了AnnotatedElement接口他们都拥有解析注解的能力

解析注解的技巧

  • 注解在哪个成分上，我们就先拿哪个成分对象。
  • 比如注解作用成员方法，则要获得该成员方法对应的Method对象，再来拿上面的注解
  • 比如注解作用在类上，则要该类的Class对象，再来拿上面的注解
  • 比如注解作用在成员变量上，则要获得该成员变量对应的Field对象，再来拿上面的注解
1
2
3
4
5
6
7
@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Bookk {
    String value();
    double price() default 100;
    String[] author();
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
/**
   目标：完成注解的解析
 */
public class AnnotationDemo3 {
    @Test
    public void parseClass(){
        // a.先得到类对象
        Class c = BookStore.class;
        // b.判断这个类上面是否存在这个注解
        if(c.isAnnotationPresent(Bookk.class)){
            //c.直接获取该注解对象
            Bookk book = (Bookk) c.getDeclaredAnnotation(Bookk.class);
            System.out.println(book.value());
            System.out.println(book.price());
            System.out.println(Arrays.toString(book.author()));
        }
    }

    @Test
    public void parseMethod() throws NoSuchMethodException {
        // a.先得到类对象
        Class c = BookStore.class;

        Method m = c.getDeclaredMethod("test");

        // b.判断这个类上面是否存在这个注解
        if(m.isAnnotationPresent(Bookk.class)){
            //c.直接获取该注解对象
            Bookk book = (Bookk) m.getDeclaredAnnotation(Bookk.class);
            System.out.println(book.value());
            System.out.println(book.price());
            System.out.println(Arrays.toString(book.author()));
        }
    }
}

@Bookk(value = "《class上注解》", price = 99.9, author = {"a", "b"})
class BookStore{

    @Bookk(value = "《test方法上注解》", price = 399.9, author = {"1", "2"})
    public void test(){
    }
}