Java中的注解和反射

Posted 2021-02-28 itzhouq的博客

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Java中的注解和反射相关的知识，希望对你有一定的参考价值。

文章首发我的博客，欢迎访问：https://blog.itzhouq.cn/annotation-reflection

最近又回顾了一下 Java 中的注解和反射知识点，注解在日常开发中使用很多，但是反射比较少。值得注意的是 Java 的各种框架底层源码中大量使用了注解和反射，阅读源码，这些是基本功，面试中这部分内容也经常问到。这里面概念不多，内容略微有些枯燥，但是通过一些简单的例子，能让我们明白一些基本概念和 API 的使用。所以，说到底，这篇博客只能算是一个简单的笔记，希望对你有帮助。以前也写过枚举类和注解的相关笔记，可以看看历史文章 Java枚举类和注解梳理。

1、什么是注解

注解 Annotation 是从JDK1.5 开始引入的新技术。

注解的作用：不是程序本身，可以对程序作出解释，能被其他程序读取到。

注解使用的位置：package、class、method、field 等上面，相当于给他们添加了额外的辅助信息。我们可以通过反射机制实现对这些元数据的访问。

2、元注解

元注解的作用就是负责注解其他的注解，Java 定义了 4 个标准的 meta-Annotation类型，他们被用来提供对其他 Annotation 类型做说明。

Target：用于描述注解的使用范围，注解可以用在什么地方。随便点击一个注解，查看源码可以看到这个位置使用 ElementType枚举类表示，主要可以放在类上，方法上，属性上等，我这就不细说了。
Retention：表示在什么级别保存该注解的信息，用于描述注解的生命周期。SOURCE < CLASS <RUNTIME 。同样看源码，使用 RetentionPolicy枚举类表示，有 SOURCE，CLASS， RUNTIME。基本见名知意。
Document：说明该注解会被包含在 Javadoc中。
Inherited：说明子类可以继承父类的该注解。

3、自定义注解

使用 @interface 自定义注解时，自动继承了 java.lang.annotation.Annotation 接口。

分析：

@interface：用来声明一个注解，格式：public @interface 注解名{定义内容}；
其中的每一个方法实际上就是一个配置参数；
方法的名称就是参数的名称；
返回的类型就是参数的类型（返回值只能是基本类型、Class、String、enum）；
可以通过 default 来声明参数的默认值；
如果只有一个参数成员，一般参数名为 value；
注解元素必须要有值，我们定义注解元素时，经常使用空字符串，0作为默认值。

// 自定义注解
public class Test {
    @MyAnnotation(age = 18, name = "Hello")
    public void test() {}

}

@interface MyAnnotation {
    // 注解的参数：参数类型 + 参数名();
    String name() default "";
    int age();
    int id() default -1;
    String[] schools() default {"清华大学", "北京大学"};
}

4、什么是反射

反射（Reflection）：是 Java 被视为动态语言的关键，反射机制允许程序在执行期借助于 Reflection API 取得任何类的内部信息，并能直接操作任意对象的内部属性及方法。

加载完类后，在堆内存的方法区中就产生了一个 Class 类型的对象（一个类只有一个 Class 对象），这个对象包含了完整的类的结构信息。我们可以通过这个对象看到类的结构。这个对象就像一面镜子，透过和镜子看到类的结构。所以我们形象地称之为反射。

Java发射的优缺点：

优点：可以实现动态创建对象和编译，体现很大的灵活性；

缺点：对性能有影响，使用反射基本上是一种解释操作，这类操作总是慢于直接执行相同的操作。

public class Test01 {
    public static void main(String[] args) throws ClassNotFoundException {
        // 通过反射获取类的Class对象
        Class c1 = Class.forName("Test01");
        Class c2 = Class.forName("Test01");
        System.out.println(c1); // class Test01

        // 一个类在内存中只有一个Class对象
        // 一个类被加载后，类的整个结构都会被封装在Class对象中。
        System.out.println(c1.hashCode()); // 685325104
        System.out.println(c2.hashCode()); // 685325104
    }
}

class User{
    private String name;
    private int age;
    public User() {}
    public User(String name, int age) {
        this.name = name;
        this.age = age;
    }
    @Override
    public String toString() {
        return "User{" +
                "name=\'" + name + \'\\\'\' +
                ", age=" + age +
                \'}\';
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
}

5、Class 类及其创建方式

在Object类中定义了一下方法，此方法将被所有子类继承。

public final Class getClass()

此方法的返回值类型是一个Class类，此类是Java反射的源头，实际上所谓反射从程序的运行结果来看也很好理解：即：可以通过对象反射求出类的名称。

Class 类的特点：

Class本身也是一个类
Class对象只能由系统建立对象
一个加载的类在 JVM 中只会有一个Class实例
一个Class对象对应的是一个加载到JVM中的一个.class文件
每个类的实例都会记得自己是由哪一个Class实例所生成的
通过Class可以完整的得到一个类中所有被加载的结构
Class类是Reflection的根源针对任何你想要动态加载、运行的类，唯有先获取相依的Class对象。

/**
 * 测试Class类的创建方式有哪些
 */
public class Test02 {
    public static void main(String[] args) throws ClassNotFoundException {
        Person person = new Student();
        System.out.println("这个人是：" + person.name); // 这个人是：学生

        // 方式一：通过对象获得
        Class c1 = person.getClass();
        System.out.println(c1.hashCode()); // 460141958

        // 方式二：forName获取
        Class c2 = Class.forName("Student");
        System.out.println(c2.hashCode()); // 460141958

        // 方式三：通过类名.class获取【最为安全可靠，性能最高】
        Class c3 = Student.class;
        System.out.println(c3.hashCode()); // 460141958

        // 方式四：基本内置类型的包装类都有一个Type属性
        Class c4 = Integer.TYPE;
        System.out.println(c4); // int
    }
}

class Person {
    String name;
    public Person() {
    }
    public Person(String name) {
        this.name = name;
    }

    @Override
    public String toString() {
        return "Person{" +
                "name=\'" + name + \'\\\'\' +
                \'}\';
    }
}

class Student extends Person{
    public Student() {
        this.name = "学生";
    }
}

class Teacher extends Person{
    public Teacher() {
        this.name = "老师";
    }
}

注意：Class 类创建方式很大概率在面试中会被问到。

6、类的加载过程和ClassLoader的理解

Java内存

当程序主动使用某个类时，如果该类还未被加载到内存中，则系统会通过如下三个步骤来对该类进行初始化：

类的加载过程

加载：将class文件字节码内容加载到内存中，并将这些静态数据转换成方法区的运行时数据结构，然后生成一个代表这个类的java.lang.Class对象；
链接：将类的二进制代码合并到JVM的运行状态之中的过程。
- 验证：确保的加载的类信息符合JVM规范，没有安全方面的问题；
- 准备：正式为类变量（static）分配内存并设置类变量默认值的阶段，这些内存都将在方法区中进行分配；
- 解析：虚拟机常量池内的符号引用（常量名）替换为直接引用（地址）的过程；
初始化：
- 执行类构造器<clinit>()方法的过程。类构造器<clinit>()方法是由编译器自动收集类中所有类变量的赋值动作和静态代码块中的语句合并产生的；
- 当初始化一个类的时候，如果发现其父类还没有进行初始化，则需要先触发其父类的初始化；
- 虚拟机会保证一个类的<clinit>()方法在多线程环境中被正确加锁和同步。

public class Test03 {
    public static void main(String[] args) {
        A a = new A();
        System.out.println(a.m);
    }
}

class A {
    static {
        System.out.println("A类静态代码块初始化");
        m = 300;
    }

    static int m = 100;

    public A () {
        System.out.println("A类的无参构造初始化");
    }

//    A类静态代码块初始化
//    A类的无参构造初始化
//    100
    /**
     * 过程分析：
     *      1. 加载到内存，会产生一个类对象Class对象
     *      2. 链接， 链接结束后 m = 0
     *      3. 初始化
     *      <clinit>(){
     *          System.out.println("A类静态代码块初始化");
     *          m = 300;
     *          m = 100;
     *      }
     */
}

类加载内存分析

7、分析类的初始化

什么时候会发生类的初始化？

类的主动引用：一定会发生类的初始化
- 当虚拟机启动，先初始化 main 方法所在的类
- new 一个类的对象
- 调用类的静态方法（除了 final 常量）和静态方法
- 使用 java.lang.reflection包的方法对类进行反射调用
- 当初始化一个类，如果其父类没有被初始化，则会先初始化其父类
类的被动引用：不会发生类的初始化
- 当访问一个静态域时，只有真正声明这个域的类才会被初始化。如：当通过子类引用父类的静态变量，不会导致子类被初始化
- 通过数组定义类的引用，不会触发类的初始化
- 引用常量不会触发此类的初始化（常量在链接阶段就存入调用类的常量池中了）。

// 测试类什么时候会被初始化
public class Test04 {
    static {
        System.out.println("Main类被加载");
    }

    public static void main(String[] args) throws ClassNotFoundException {
        // 1. 主动引用
        // Son son = new Son();
//        Main类被加载
//        父类被加载
//        子类被加载

        // 2. 反射也会产生主动引用
        // Class.forName("Son");
//        Main类被加载
//        父类被加载
//        子类被加载

        // 3. 不会产生类的引用方法
        // System.out.println(Son.b);
//        Main类被加载
//        父类被加载
//        3

        Son[] array = new Son[5]; // Main类被加载
    }
}

class Father{
    static int b = 3;
    static {
        System.out.println("父类被加载");
    }
}

class Son extends Father{
    static {
        System.out.println("子类被加载");
        m = 300;
    }

    static int m = 100;
    static final int M = 1;
}

8、类加载器的作用

类加载器的作用：将class文件字节码内容加载到内存中，并将这些静态数据转换成方法区的运行时数据结构，然后再堆中生成这个类的java.lang.Class对象，作为方法区中类数据的访问入口。

类缓存：标准的 JavaSE 类加载器可以按要求查找类，但一旦某个类被加载到类加载器中，他将维持加载（缓存）一段时间。不过 JVM 垃圾回收机制可以回收这些Class对象。

类的加载

类加载器作用：用来把类（class）装载进内存的。JVM 规范定义了如下类型的类的加载器。

类的加载器

public class Test05 {
    public static void main(String[] args) throws ClassNotFoundException {
        // 获取系统类加载器
        ClassLoader systemClassLoader = ClassLoader.getSystemClassLoader();
        System.out.println(systemClassLoader); // sun.misc.Launcher$AppClassLoader@18b4aac2

        // 获取系统类加载器的父类---> 扩展类加载器
        ClassLoader systemClassLoaderParent = systemClassLoader.getParent();
        System.out.println(systemClassLoaderParent); // sun.misc.Launcher$ExtClassLoader@1b6d3586

        // 测试当前类是哪个类加载器加载的
        ClassLoader classLoader = Class.forName("Test05").getClassLoader();
        System.out.println(classLoader); // sun.misc.Launcher$AppClassLoader@18b4aac2

        // 测试 JDK 内置的类是哪个加载器加载的
        ClassLoader loader = Class.forName("java.lang.Object").getClassLoader();
        System.out.println(loader); // null 引导类加载器
    }

}

9、获取运行时类的完整结构

通过反射获取运行时累的完整结构

Filed、Method、Constructor、Superclass、Interface、Annotation。

import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.Method;

// 获得类的信息
public class Test06 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException, NoSuchMethodException {
        Class c1 = Class.forName("pojo.User");

        // 获得类的名称
        System.out.println(c1.getName()); // 包名+类名  pojo.User
        System.out.println(c1.getSimpleName()); // 类名   User

        // 获得类的属性
        Field[] fields = c1.getFields(); // 只能找到public属性

        Field[] declaredFields = c1.getDeclaredFields(); // 找到全部属性 private int pojo.User.id

        // 获得指定属性的值
        Field name = c1.getDeclaredField("name");

        Method[] methods = c1.getMethods(); // 获得本类及其父类的全部 public 方法
        Method[] declaredMethods = c1.getDeclaredMethods(); // 获得本类的所有方法

        // 获得指定方法
        Method getName = c1.getMethod("getName", null);
        Method setName = c1.getMethod("setName", String.class);

        // 获得指定构造器
        Constructor[] constructors = c1.getConstructors();
        Constructor[] declaredConstructors = c1.getDeclaredConstructors();

        Constructor declaredConstructor = c1.getDeclaredConstructor(int.class, String.class);
        System.out.println(declaredConstructor); // public pojo.User(int,java.lang.String)

    }
}

10、动态创建对象执行方法

有了 Class 对象之后，能做什么？

创建类的对象：调用 Class 对象的 newInstance() 方法。

类必须有一个无参构造器
类的构造器的访问权限需要足够。

思考？难道没有无参构造器就不能创建对象了吗？

答：只要操作的时候明确的调用类中的构造器。并将参数传递进去之后，才可以实例化操作。

import pojo.User;

import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

// 通过反射动态的创建对象
public class Test07 {
    public static void main(String[] args) throws ClassNotFoundException, IllegalAccessException, InstantiationException, NoSuchMethodException, InvocationTargetException, NoSuchFieldException {
        // 获得 Class 对象
        Class c1 = Class.forName("pojo.User");

        // 构造一个对象
        User user = (User) c1.newInstance(); // 本质调用了类的无参构造器
        System.out.println(user); // User{id=0, name=\'null\'}

        // 通过构造器创建对象
        Constructor constructor = c1.getDeclaredConstructor(int.class, String.class);
        User jack = (User) constructor.newInstance(1, "Jack");
        System.out.println(jack); // User{id=1, name=\'Jack\'}

        // 通过反射调用普通方法
        User user2 = (User) c1.newInstance();
        // 通过反射调用一个方法
        Method setName = c1.getDeclaredMethod("setName", String.class);
        setName.invoke(user2, "小米");
        System.out.println(user2); // User{id=0, name=\'小米\'}

        // 通过反射操作属性
        User user3 = (User) c1.newInstance();
        Field name = c1.getDeclaredField("name");
        // 不能直接操作私有属性，需要取消安全监测
        name.setAccessible(true);
        name.set(user3, "小黑");
        System.out.println(user3); // User{id=0, name=\'小黑\'}
    }
}

Method 和 Field、Constructor 对象都有 setAccessible() 方法。

setAccessible 作用是启动和禁用访问安全检查的开关。

参数值为 true 则指示反射的对象在使用时应该取消 Java 语言访问检查。

11、反射操作泛型（generics）

Java 采用泛型擦除的机制来引入泛型，Java 中的泛型仅仅是给编译器 javac 使用的，确保数据的安全性和免去强制类型转换问题，但是一旦编译完成，所有和泛型有关的类型全部擦除。

为了通过反射操作这些类型， Java 新增了 ParameteriedType, GenericArrayType, TypeVariable和WildcardType 几种类型来代表不能被归一到 Class 类中的类型但是又和原始类型齐名的类型。

ParameteriedType：表示一个参数化类型，比如Collection<String>
GenericArrayType：表示一个元素类型是参数化类型或者类型变量的数组类型
TypeVariable：是各种类型变量的公共父接口
WildcardType ：代表一种通配符类型的表达式。

// 获取泛型（generics）信息
public class Test08 {
    public void test01 (Map<String, User> map, List<User> list) {
        System.out.println("test01");
    }

    public Map<String, User> test02 () {
        System.out.println("test02");
        return null;
    }

    public static void main(String[] args) throws NoSuchMethodException {
        Method method = Test08.class.getMethod("test01", Map.class, List.class);
        Type[] genericParameterTypes = method.getGenericParameterTypes();
        for (Type genericParameterType : genericParameterTypes) {
            System.out.println(genericParameterType);
            // java.util.Map<java.lang.String, pojo.User>
            // java.util.List<pojo.User>
            if (genericParameterType instanceof ParameterizedType) {
                Type[] actualTypeArguments = ((ParameterizedType) genericParameterType).getActualTypeArguments();
                for (Type actualTypeArgument : actualTypeArguments) {
                    System.out.println("##" + actualTypeArgument);
//                    java.util.Map<java.lang.String, pojo.User>
//                    ##class java.lang.String
//                    ##class pojo.User
//                    java.util.List<pojo.User>
//                    ##class pojo.User
                }
            }
        }

        System.out.println("=======================");
        // 获取返回值泛型
        Method method1 = Test08.class.getMethod("test02", null);
        Type genericReturnType = method1.getGenericReturnType();
        if (genericReturnType instanceof ParameterizedType) {
            Type[] actualTypeArguments = ((ParameterizedType) genericReturnType).getActualTypeArguments();
            for (Type actualTypeArgument : actualTypeArguments) {
                System.out.println("##" + actualTypeArgument);
//                ##class java.lang.String
//                ##class pojo.User
            }
        }
    }
}

12、反射操作注解

练习：ORM

使用注解和反射完成类和表结构映射。类和表结构对应，属性和字段对应、对象和记录对应。

ORM映射

import java.lang.annotation.*;
import java.lang.reflect.Field;

// 练习反射操作注解
public class Test09 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException {
        Class c1 = Class.forName("Student");
        // 通过反射获得注解

        Annotation[] annotations = c1.getAnnotations();
        for (Annotation annotation : annotations) {
            System.out.println(annotation); // @TableMy(value=db_student)
        }

        // 获得注解的 value 的值
        TableMy tableMy = (TableMy) c1.getAnnotation(TableMy.class);
        String value = tableMy.value();
        System.out.println(value); // db_student

        // 获得类指定的注解
        Field f = c1.getDeclaredField("id");
        FiledMy annotation = f.getAnnotation(FiledMy.class);
        System.out.println(annotation.columnName()); // db_id
        System.out.println(annotation.type()); // int
        System.out.println(annotation.length()); // 10
    }

}

// 类名的注解
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface TableMy{
    String value();
}

// 属性的注解
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface FiledMy {
    String columnName();
    String type();
    int length();
}

@TableMy("db_student")
class Student {
    @FiledMy(columnName = "db_id", type = "int", length = 10)
    private int id;
    @FiledMy(columnName = "db_age", type = "int", length = 10)
    private String name;
    @FiledMy(columnName = "db_name", type = "varchar", length = 3)
    private int age;

    public Student() {
    }

    public Student(int id, String name, int age) {
        this.id = id;
        this.name = name;
        this.age = age;
    }

    @Override
    public String toString() {
        return "Student{" +
                "id=" + id +
                ", name=\'" + name + \'\\\'\' +
                ", age=" + age +
                \'}\';
    }

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

以上是关于Java中的注解和反射的主要内容，如果未能解决你的问题，请参考以下文章

注解与反射

Java中的注解和反射

注解以及注解在反射中的应用

Java注解教程：自定义注解示例，利用反射进行解析

基于NACOS和JAVA反射机制动态更新JAVA静态常量非@Value注解