java基础之注解

目录

JDK中预定义的一些注解

自定义注解

在程序中使用（解析） 注解

---

概述：从JDK5开始,Java增加对元数据的支持，也就是注解，注解与注释是有一定区别的，可以把注解理解为代码里的特殊标记，这些标记可以在编译，类加载，运行时被读取，并执行相应的处理。通过注解开发人员可以在不改变原有代码和逻辑的情况下在源代码中嵌入补充信息。

作用：

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

JDK中预定义的一些注解

1. @Override

检测被该注解标注的方法是否是继承自父类（接口）的

2. @Deprecated

将该注解标注的内容，已过时

3. @SuppressWarnings

被该注解修饰的元素以及该元素的所有子元素取消显示编译器警告，例如修饰一个类，那他的字段，方法都是显示警告

4. @FunctionalInterface

保证这个接口只有一个抽象方法，注意这个只能修饰接口

实例：

@SuppressWarnings("all")
public class AnnoTest02 {

    @Override
    public String toString() {
        return super.toString();
    }
    
    @Deprecated
    public void show1() {
        //有缺陷
    }
    
    public void show2() {
        //替代show1方法
    }
    
    public void demo() {
        show1();
    }
}

自定义注解

格式：

        元注解

        public @interface 注解名称 {

        属性列表；

        }

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

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

属性：接口中的抽象方法

        要求：

        1. 属性的返回值类型（基本数据类型，String，枚举，注解，以上类型的数组）

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

             ①如果定义属性时，使用default关键字给属性默认初始化值，则使用注解时，可以不进行                属性的赋值

            ②如果只用一个属性需要赋值，并且属性的名称是value，则value可以省略，直接定义即可

            ③数组赋值时，值使用{}包裹。如果数组中只有一个值，则{}可以省略

实例：

MyAnno注解

@SuppressWarnings("all")
public @interface MyAnno {
    int age();
    String name() default "张三";
    String show2();

    Person per();

    MyAnno2 anno2();

    String[] strs();
}

Worker类

@MyAnno(age = 1,show2 = "李四",per=Person.P1,anno2 = @MyAnno2,strs = {"王五","孙六"})
public class Worker {
}

元注解 ：用于描述注解的注解

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

        ElementType取值：

        TYPE:可以作用于类上

        METHOD:可以作用域方法上

        FIELD:可以作用于成员变量上

• @Retentaion:用于描述注解被保留的阶段

        @Retention(RetentionPolicy.RUNTIME)：当前被描述的注解，会保留到class字节码文件                中，并被JVM读取到

• @Documented:描述注解是否被抽取到api文档中
• @Inherited:描述注解是否被子类继承

在程序中使用（解析） 注解

获取注解中定义的属性值

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

2.获取指定的注解

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

实例：

@SuppressWarnings("all")
@Pro(className = "com.lu.test.Demo1", methodName = "show")
public class RelfectTest {
    public static void main(String[] args) {

        //1. 解析注解
        //1.1 获取该类的字节码文件对象
        Class<RelfectTest> relfectTestClass = RelfectTest.class;
        //2.获取上边的注解对象
        //其实就是内存中生成了一个该注解接口的子类实现对象
        /*
            public class ProImpl implements Pro {
                public String className() {
                    return "com.lu.test.Demo1";
                }

                public String methodName() {
                    return "show";
                }
            }
        */
        Pro an = relfectTestClass.getAnnotation(Pro.class);
        //3.调用注解对象中定义的抽象方法，获取返回值
        String className = an.className();
        String methodName = an.methodName();
        System.out.println(className + methodName );

    }
}