Java注解

注解用于为 Java 代码提供元数据。一种代码级别的说明，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。

注解作用：

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

一、JDK中预定义的一些注解

@Deprecated：标注已过时

@SuppressWarnings(String[] value)：压制警告，需要传参

二、元注解

元注解是描述注解的注解。

1、@Target：描述注解能够作用的位置

@Target的取值：

在@Target注解中使用枚举ElementType来表示作用范围，ElementType有以下几个属性：

TYPE：表示可以作用于类上

FIELD：表示可以作用于字段上，包括枚举类型

METHOD：表示可以作用于方法上

PARAMETER：表示可以作用于参数上

CONSTRUCTOR：表示可以作用于构造函数上

LOCAL_VARIABLE：表示可以作用于局部变量上

ANNOTATION_TYPE：表示可以作用于注释类型上，@Retention注解中就使用该属性

PACKAGE：表示可以作用于包上

TYPE_PARAMETER：表示可以作用于类型参数，即泛型方法、泛型类等

TYPE_USE：表示可以作用于类型使用，可以用于标准任意类型除了class

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {}

2、@Retention：描述注解被保留的阶段

@Retention的取值：

在@Retention注解中使用枚举RetentionPolicy来表示注解保留时期，RetentionPolicy有以下几个属性：

SOURCE：注解仅存在于源码中，在class字节码文件中不包含

CLASS：默认保留策略，注解会在class字节码文件中存在，但运行时无法获得

RUNTIME：在运行时可以通过反射获取到，注解会在字节码文件中存在

自定义注解中肯定要使用@Retention(RetentionPolicy.RUNTIME)。

3、@Documented：描述注解是否被抽取到api文档中

它的作用是能够将注解中的元素包含到Javadoc中去。

4、@Inherited：描述注解是否被子类继承

@Inherited注解了的注解修饰了一个父类，如果他的子类没有被其他注解修饰，则它的子类也继承了父类的注解。

5、@Repeatable：描述注解是否可重复

这个元注解修饰的注解可以同时作用一个对象多次，但是每次作用注解又可以代表不同的含义。比如说你定义了一个注解，如果你的注解没有标记@Repeatable这个JDK自带的注解，那么你这个注解在引用的地方就只能使用一次。

@Repeatable(PersonsAnno.class)
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface PersonAnno {
    String role() default "";
}

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface PersonsAnno {
    PersonAnno[] value();
}

public class Test {
    @PersonAnno(role = "a")
    @PersonAnno(role = "b")
    public void test(){}
}

三、自定义注解

格式：public @interface 注解名称{}

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

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

/**Annotation接口源码*/
public interface Annotation {
    boolean equals(Object obj);
    int hashCode();
    String toString();
    Class annotationType();
}

注解类型元素：就是注解的属性，也就是注解中的内容，接口中的抽象方法

• 要求：

  • 1、属性的返回值类型
    • 基本数据类型
    • String
    • 枚举
    • 注解
    • 以上类型的数组

  public @interface MyAnno extends java.lang.annotation.Annotation{
      String test01();
      //void test02();  //void是不可以的
  }
  

• 2、定义了属性，在需要时需要给属性赋值
  • 1、如果定义属性时，使用default关键字给属性默认初始化值，则使用注解时，可以不进行属性的赋值
  • 2、如果只有一个属性需要赋值，并且属性的名称是value，则value可以省略，直接定义值即可
  • 3、数组赋值时，使用大括号包裹，如果数组中只有一个值，则大括号可以省略

public @interface MyAnno extends java.lang.annotation.Annotation{
    String name() default "aa";
    int age();
    int sex();
    String[] strs();
}

@MyAnno(age = 12,sex = 0,strs={"a","b"})
public void test(){}

四、获取注解的属性

使用注解时，使用反射来获取注解属性，获取注解中定义的属性值步骤：

1、获取注解定义的位置的对象（class、Method、Field），判断是否有注解，主要有三个方法

2、获取注解的对象

3、调用注解中的抽象方法获取配置的属性值

public class CountEntiy {
    public void count(){
        System.out.println("count执行");
    }
}

@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface AnnoProperties {
    String className();
    String methodName();
}

//源码中的方法
//判断是否存在对应的Annotation对象
public boolean isAnnotationPresent(Class annotationClass) {
    return AnnotatedElement.super.isAnnotationPresent(annotationClass);
}
//获取Annotation对象
public  A getAnnotation(Class annotationClass) {
    Objects.requireNonNull(annotationClass);
    return (A) annotationData().annotations.get(annotationClass);
}
//获取所有Annotation对象数组
public Annotation[] getAnnotations() {
    return AnnotationParser.toArray(annotationData().annotations);
}

下面例子介绍获取属性：

@AnnoProperties(className = "com.test.CountEntiy",methodName = "count")
public class MyAnno {
    @AnnoProperties(className = "com.test.CountEntiy",methodName = "count")
    public void myAnnoTest(){
        System.out.println("myAnnoTest执行")
    }
}
public class Test {
    public static void main(String[] args) throws Exception {
        //获取类注解属性
        //获取注解定义位置的对象
        Class clzMyAnno = MyAnno.calss; 
        //判断是否有注解
        boolean testPresent = clzMyAnno.isAnnotationPresent(AnnoProperties.class);
        if(testPresent) {
            //获取注解的对象
            AnnoProperties anno = clzMyAnno.getAnnotation(AnnoProperties.class);
            //调用注解中的抽象方法获取配置的属性值
            String className = anno.className();
            String methodName = anno.methodName();
        }
        //获取方法MyAnno.calss.get注解属性
        Method method = MyAnno.calss.getDeclaredMethod("myAnnoTest");
        boolean methodPresent = method.isAnnotationPresent(AnnoProperties.class);
        if(methodPresent) {
            AnnoProperties annoPro = method.getAnnotation(AnnoProperties.class);
            String className = anno.className();
            String methodName = anno.methodName();
        }
        
        //用反射执行myAnnoTest()方法
        Class clz = Class.forName(className);
        Object obj = clz.newInstance();
        Method method = clz.getMethod(methodName);
        method.invoke(obj);
    }
}
//结果：myAnnoTest执行