注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。

作用分类

  • 编写文档：通过代码里标识的注解生成文档【生成文档doc文档】
  • 代码分析：通过代码里标识的注解对代码进行分析【使用反射】
  • 编译检查：通过代码里标识的注解让编译器能够实现基本的编译检查【Override】

JDK中预定义的一些注解

  • @Override：检测被该注解标注的方法是否是继承自父类(接口)的
  • @Deprecated：该注解标注的内容，表示已过时
  • @SuppressWarnings：压制警告，一般传递参数all @SuppressWarnings(“all”)

自定义注解

1
2
3
public @interface 注解名称{
     属性列表;
}

本质: 注解本质上就是一个接口，该接口默认继承Annotation接口

1
public interface MyAnno extends java.lang.annotation.Annotation {}

属性: 接口中的抽象方法

要求:

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

元注解

用于描述注解的注解

  • @Target：描述注解能够作用的位置ElementType取值：
    • TYPE：可以作用于类上
    • METHOD：可以作用于方法上
    • FIELD：可以作用于成员变量上
  • @Retention：描述注解被保留的阶段
  • @Retention(RetentionPolicy.RUNTIME)：当前被描述的注解，会保留到class字节码文件中，并被JVM读取到
  • @Documented：描述注解是否被抽取到api文档中
  • @Inherited：描述注解是否被子类继承

预先定义Demo1.java与Demo2.java,解析注解,获取注解中定义的属性值
Demo1.java

1
2
3
4
5
public class Demo1 {
    public void show(){
        System.out.println("demo1...show...");
    }
}

Demo2.java

1
2
3
4
5
public class Demo2 {
    public void show(){
        System.out.println("demo2...show...");
    }
}

再自定义一个注解Pro.java

1
2
3
4
5
6
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Pro {
    String className();
    String methodName();
}

接下来通过注解加载类与方法

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
@Pro(className = "annotation.Demo1",methodName = "show")
public class ReflectTest {
    public static void main(String [] args) throws Exception {
        Class<ReflectTest> reflectTestClass = ReflectTest.class;
        Pro an = reflectTestClass.getAnnotation(Pro.class);
        String className=an.className();
        String methodName = an.methodName();
        System.out.println(className);
        System.out.println(methodName);

        Class cls = Class.forName(className);
        Object obj = cls.newInstance();
        Method method = cls.getMethod(methodName);
        method.invoke(obj);
    }
}