Java基础——注解

2019-04-11 本文已影响0人 So_ProbuING

基本概念

在JAVA中我们都知道有注释的概念，注释有单行注释多行注释文档注释。这种注释是给开发人员看的。
而在JAVA中的注解是给程序看的，用于告知程序一些东西

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

作用分类

编写文档：通过代码里标识的元数据生成文档[生成doc文档]
代码分析：通过代码里标识的元数据对代码进行分析[使用反射]
编译检查：通过代码里标识的元数据让编译器能实现基本的编译检查[Override]

JDK中预定义的一些注解

@Override
用于检测被该注解标注的方法是否是继承自父类的
@Deprecated
将该注解标注的内容，已过时
SuppressWarnings
抑制警告

自定义注解

格式：

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

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

public interface MyAnno extends Annotation{
}

注解本质上就是个接口，那么我们也就知道接口中可以定义的在注解中也可以定义。

注解的属性

接口中可以定义成员方法，这些成员方法被称作注解的属性

要求

属性的返回值类型

基本数据类型
String
枚举
注解
以上类型的数组
这里我们发现，注解属性的返回值类型没有void类型，所以在注解中定义的方法不能用void

定义了属性，在使用时需要给属性赋值，
1. 多个属性的赋值可以使用,隔开。
2. 如果在使用的时候不想给注解的属性赋值，可以在定义时添加default默认值
3. 如果只有一个注解的属性需要赋值，并且属性的名称是value。则value可以省略。直接定义值即可。
4. 给数组赋值，使用{}包裹，如果数组中只有一个值，则{}可以省略
  我们来演示一下，现在我们有一个自定义的注解MyAnno,其中定义了一些注解属性
  MyAnno.java

public @interface MyAnno {
    int myInt();
    String myString();
    MyAnno2 myAnno2();
    MyEnum myEnum();
    String[] strs();
    double value();
}

MyAnno2.java

public @interface MyAnno2 {
}

MyEnum.java

public enum MyEnum {
    my1, my2;
}

在使用MyAnno注解时
Example.java

@MyAnno(myInt = 1,myString = "myString",myAnno2 = @MyAnno2,strs = {"a","b","c"},myEnum = MyEnum.my1, value = 2.23d)
public class Example {
}

我们可以看到，在使用注解时，需要对注解中的属性进行赋值，如果注解中有value的属性则使用value=进行赋值

元注解

元注解：用于描述注解的注解，元注解也是一个注解
我们来看一下JDK预定义的注解中的元注解的使用

Override

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

可以看到在Override上面的@Target @Retention就是元注解。
元注解也是预定义的。

@Target：描述注解能够作用的位置，作用于方法、类等
使用Target元注解需要指定ElementType，ElementType是一个枚举类
- @Target(ElementType.Type) 表示只能作用于类上
- @Target(ElementType.Method) 表示可以作用于方法上
- @Target(ElementType.FIELD) 表示可以作用于成员变量上
@Retention：描述注解被保留的阶段
- @Retention(RetentionPolicy.SOURCE) 表示作用的注解会被抽取到源代码的javadoc的文档中
- @Retention(RetentionPolicy.SOURCE)
- @Retention(RetentionPolicy.RUNTIME) 表示作用的注解会保留到运行时阶段，会保留到class文件中，并被JVM读取到
@Documented：描述注解是否被抽取到api文档中
@Inherited：描述注解是否被子类继承

在程序中使用(解析)注解

解析注解步骤

获取注解定义的位置的对象(Class,Method,Field)
获取字节码文件对象的注解对象
调用注解对象中定义的抽象方法，获取配置的属性值
我们定义一个注解，里面有两个返回String类型的抽象方法

ProAnno.java

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface ProAnno {
    String getClassName();

    String getMethodName();
}

UseAnno.java

@ProAnno(getClassName = "com.probuing.useanno.UseAnno",getMethodName = "hello")
public class UseAnno {
    public static void main(String[] args) {
        //获取注解定义位置的对象
        Class<UseAnno> aClass = UseAnno.class;
        //通过获取的对象获取注解对象
        ProAnno getClassName = aClass.getAnnotation(ProAnno.class);
        //调用注解对象中定义的抽象方法，获取配置的属性
        String className = getClassName.getClassName();
        String methodName = getClassName.getMethodName();
        System.out.println("anno className"+className);
        System.out.println("anno methodName"+methodName);
    }
}

在指定的对象中，有一个api方法可以快速的判断是否被指定的注解作用

isAnnotationPresent(Annotation.class)