注解

从JDK 5开始引入的技术

作用分类：

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

JDK中预定义的注解

@Override: 检测被标注的方法是否是继承自父类(接口)的方法。

@Deprecated:该注解标注的内容，表示已过时。

@SuppressWarnings:压制警告

​ 一般传递参数all

package top.lukeewin.demo20Annotation;

import java.util.Date;

@SuppressWarnings("all")
public class AnnotationDemo02 {

    @Override
    public String toString(){
        return super.toString();
    }

    @Deprecated
    public void show01(){
        //有缺陷
    }

    public void show02(){
        //代替show01方法
    }

    public void demo(){
        show01();
        Date date = new Date();
    }
}

自定义注解

格式：

1. 元注解

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

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

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

3. 属性：接口中的抽象方法

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

元注解

@Target: 描述注解能够作用的位置

• ElementType取值：
  • TYPE: 可以作用于类上
  • METHOD: 可以作用于方法上
  • FIELD: 可以作用于成员变量上

@Retention: 描述注解被保留的阶段

• RetentionPolicy取值：
  • SOURCES: 源码阶段
  • CLASS: 字节码阶段
  • RUNTIME: 运行时阶段

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

@Inherited: 描述注解是否被子类继承

注解的使用

1. 获取注解定义的位置的对象(Class, Method, Field)

2. 获取指定的注解

   • getAnnotation(Class)

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

   //其实就是在内存中生成了一个该注解接口的子类实现类对象
   public class ProImpl implements Pro{
   	public String className(){
   		return "top.lukeewin.demo20Annotation.Demo04";
   	}
   	public String methodName(){
   		return "show";
   	}
   }
   

package top.lukeewin.demo20Annotation;

import java.lang.reflect.Method;

@Pro(className = "top.lukeewin.demo20Annotation.Demo05", methodName = "show")
public class ReflectTest {
    public static void main(String[] args) throws Exception {
        //可以创建任意类的对象，可以执行任意方法

        //1.解析注解
        //1.2 获取该类的字节码文件对象
        Class<ReflectTest> reflectTestClass = ReflectTest.class;
        //2. 获取上边的注解对象
        //其实就是在内存中生成了一个该注解接口的子类实现类对象
        /*public class ProImpl implements Pro{
            public String className(){
                return "top.lukeewin.demo20Annotation.Demo04";
            }
            public String methodName(){
                return "show";
            }
        }*/
        Pro an = reflectTestClass.getAnnotation(Pro.class);
        //3. 调用注解对象中定义的抽象方法，获取返回值
        String className = an.className();
        String methodName = an.methodName();
        System.out.println(className);
        System.out.println(methodName);
        //4. 加载该类进内存
        Class<?> cls = Class.forName(className);
        //5. 创建对象
        Object obj = cls.newInstance();
        //6. 获取方法对象
        Method method = cls.getMethod(methodName);
        //7. 执行方法
        method.invoke(obj);
    }
}

package top.lukeewin.demo20Annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

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

package top.lukeewin.demo20Annotation;

public class Demo05 {
    public void show(){
        System.out.println("demo05...show...");
    }
}

Q.E.D.