概念解释

注解与注释

注释：用文字描述程序的,是给程序员看的。

注解：用来解释说明程序的，是给计算机看的。

百度百科定义：

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

作用

①编写文档：通过代码里标识的注解生成文档【生成文档doc文档】。

doc文档就是java的API文档。java文件使用javadoc命令就可以生成doc文档，这个过程就会去解析java文件中那些文档的注解。

② 代码分析：通过代码里标识的注解对代码进行分析【使用反射】。

③编译检查：通过代码里标识的注解让编译器能够实现基本的编译检查。

比如使用@Override注解，编译器就会在编译时检查该方法是否重写父类的方法。

JDK中预定义的一些注解

1.@Override：检测被该注解标注的方法是否继承自父类(接口)的。

2.@Deprecated：该注解标注的内容表示已经过时，不推荐使用。

3.@SuppressWarnnings：压制警告。

自定义注解

自定义注解格式

@元注解
public @interface 注解名称{
    
}

注解的本质

将自定义注解的class文件进行反编译,如图

反编译的命令为 : javap class文件名

编译结果为：

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

因此，注解的本质就是继承了Annotation的接口。

属性

注解的属性其实就是注解中定义的抽象方法。注解中的抽象方法有一下要求：

1.属性返回值类型有以下取值：

• 基本数据类型（8种）

• String

• 枚举

• 注解

• 以上类型的数组类型

2.定义了属性，在使用时需要给属性赋值

• 如果定义属性时，使用default关键字给属性设置默认值，在使用时可以使用该默认值，也可赋值。

• 如果属性唯一且属性的名称是value，则value可以省略，直接定义值即可。

• 数组赋值时，值需要使用{}来包裹，其中元素之间用“，”隔开；如果只有一个值，则{}可以省略。

元注解

元注解就是自定义注解时，所用到的用来给自定义注解标注的注解。

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

Target注解中只有一个属性：ElementType[] value()；ElementType是枚举类,有以下属性枚举：

public enum ElementType {
    
    TYPE, //表示可以声明在类、接口或枚举上
​
    FIELD,//表示可以声明字段（包括枚举常量）上
​
    METHOD,//表示可以声明在方法上
​
    PARAMETER,//表示可以声明在参数上
​
    CONSTRUCTOR,//表示可以声明在构造方法上
​
    LOCAL_VARIABLE,//表示可以声明在局部变量上
​
    ANNOTATION_TYPE,//表示可以声明在注释上
​
    PACKAGE,//表示可以声明包上
​
    TYPE_PARAMETER,//表示可以声明在类型参数上（从JKD1.8开始使用）
​
    TYPE_USE,//使用一种类型（从JKD1.8开始使用）
}

@Retention：描述注解能被保留的阶段。

Retention注解中只有一个属性：RetentionPolicy value()；RetentionPolicy 是枚举类,有以下属性枚举：

public enum RetentionPolicy {
    
    SOURCE,//表示保留在源代码阶段
​
    CLASS,//表示保留在Class类对象阶段
​
    RUNTIME//表示保留在运行时阶段
}

@Documented：描述注解是否被抽取到API文档中。

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

解析注解

使用反射机制来获取注解信息并进行解析:

@Application(className = "model.Teacher",methodName="teach")
public class AnnotationTest {
    public static void main(String[] args) throws Exception {
​
        //1.读取注解
        //1.1获取框架类的class对象
        Class<AnnotationTest> cls = AnnotationTest.class;
        //1.2根据类的class对象来获取注解
        Application annotation = cls.getAnnotation(Application.class);
        //1.3获取注解中的属性值:className、methodName
        String className = annotation.className();
        String methodName = annotation.methodName();
​
        //2.创建对象
        //2.1获取类的class对象
        Class clazz = Class.forName(className);
        //2.2创建对象
        Object obj = clazz.newInstance();
​
        //3.获取对象的方法
        Method method = clazz.getDeclaredMethod(methodName);
​
        //4.执行方法
        method.invoke(obj);
​
    }
}

解释:

在上述代码中的1.2步骤中,通过框架类的class对象获取注解对象时,会生成该注解的代理类(子类),并实现注解中的属性(抽象方法);代理对象实现抽象方法时,会读取框架类中使用的注解属性值并作为返回值。1.3步骤通过注解对象（代理）执行其中的方法就能获取到其返回值。根据其返回值，再根据反射机制，创建对象并执行方法。

生成的代理类长这样：

public class AnnotationImpl implements Application {
​
    @Override
    public String className() {
        return "model.Teacher";
    }
​
    @Override
    public String methodName() {
        return "teach";
    }
​
    /**
     * 因为注解继承了Annotation接口,所以必须实现该方法。
     */
    @Override
    public Class<? extends Annotation> annotationType() {
        return Application.class;
    }
}