注解与反射

1. 注解

1.1 什么是注解？

在JDK1.5以后引入的一种注释机制，又叫做Java标注。

Annotation的作用：

  • 不是程序本身，但是可以对程序作出解释（和注释的作用一样）
  • 可以被其他程序（例如：编译器）读取
  • 可以检查验证代码

Annotation的格式：

  • 注解是以 @注解名 在代码中存在的，还可以添加一些参数值，例如：

    @SuppressWarnings(value="unchecked")

Annotation在哪里使用？

  • 可以附加在package，class，method，field等上面，相当于给他们添加了额外的辅助信息，我们可以通过反射机制编程实现对这些元数据的访问

1.2 内置注解

  • @Override：定义在java.lang.Override中，此注释只适用于修辞方法，表示一个方法声明打算重写super类中的另一个方法声明。
  • Deprecated：定义在java.lang.Deprecated中，此注释可以用于修辞方法、属性、类，表示不鼓励程序员使用这样的元素，通常是因为它很危险或者存在更好的选择。
  • @SuppressWarnings：定义在java.SuppressWarnings中，用来抑制编译时的警告信息。
    • 与前两个注释有所不同，你需要添加一个参数才能正确使用，这些参数都是系统预设的，我们只需要调用即可。
    • @SuppressWarnings("all")
    • @SuppressWarnings("unchecked")
    • @SuppressWarnings(value={"unchecked", "deprecation"})
    • and many more...

1.3 元注解

  • 元注解的作用就是负责注解其他注解，Java定义了4个标准的meta-annotation类型，他们被用来提供对其他annotation类型作说明。
  • 这些类型和它们所支持的类在java.lang.annotaion包中可以找到。（@Target，@Retention，@Documented，@Inherited）
    • @Target：用于描述注解的使用范围
      • （TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE, ANNOTATION_TYPE, PACKAGE, TYPE_PARAMETER, TYPE_USE）
    • @Retention：表示需要在什么级别保存该注释信息，用于描述注解的生命周期
      • (SOURCE < CLASS < RUNTIME)
    • @Document：说明该注解将被包含在javadoc中
    • @Inherited：说明子类可以继承父类中的该注解

1.4 自定义注解

  • 使用@interface自定义注解；

  • 使用@interface时，自动继承了java.lang.annotation.Annotation接口

  • 介绍：

    • @interface用来声明一个注解，格式：

      public @interface AnnotationName {
    // code...
}

    • 其中的每一个方法实际上是声明了一个配置参数

    • 方法的名称就是参数的名称

    • 返回值类型就是参数的类型（返回值只能是基本类型（Class、String、enum））

    • 可以通过default来声明参数的默认值

    • 如果只有一个参数成员，一般参数名为value，默认可以不写(必须是value才可以)，直接写值

    • 注解元素必须要有值，我们定义注解元素时，经常使用空字符串、0作为默认值

2. 从Class对象到反射

2.1 概述

2.1.1 静态语言 VS 动态语言

  • 静态语言
    • 运行时结构不可改变的语言。如Java、C、C++
    • Java不是动态语言，但Java可以称之为“准动态语言”。即Java有一定的动态性，我们可以利用反射机制获得类似动态语言的特性。Java的动态性让编程的时候更加灵活。
  • 动态语言
    • 是一类在运行时可以改变其结构的语言：例如新的函数、对象、甚至代码可以被引进，已有的函数可以被删除或是其他结构上的变化。通俗点说就是在运行时代码可以根据某些条件改变自身结构。
    • 主要动态语言：Object-C、C#、JavaScript、PHP、Python等。

2.1.2 Java Reflection

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

    Class c = Class.forName("java.lang.String");

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

    正常方式：

    $正常方式：引入需要的“包类”名称 \to 通过new实例化 \to 取得实例化对象$

    $反射方式：实例化对象 \to getClass()方法 \to 得到完整的“包类”名称$

2.2 Java反射机制提供的功能

  • 在运行时判断任意一个对象所属的类
  • 在运行时构造任意一个类的对象
  • 在运行时判断任意一个类所具有的成员变量和方法
  • 在运行时获取泛型信息
  • 在运行时调用任意一个对象的成员变量和方法
  • 在运行时处理注解
  • 生成动态代理
  • ……

2.3 Java反射优点和缺点

优点：

  • 可以实现动态创建对象和编译，体现出很大的灵活性

缺点：

  • 对性能有影响。使用反射基本上是一种解释操作，我们可以告诉JVM，我们希望做什么并且它满足我们的要求。这类操作总是慢于直接执行相同的操作。

2.4 反射相关的主要API

  • java.lang.Class：代表一个类
  • java.lang.reflect.Method：代表类的方法
  • java.lang.reflect.Field：代表类的成员变量
  • java.lang.reflect.Constructor：代表类的构造器
  • ……

2.5 Class类

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

$public \quad final \quad Class \quad getClass();$

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

Class类拥有的信息：

  • 某个类的属性
  • 方法
  • 构造器
  • 实现的接口

对于每个类而言，JRE都为其保留一个不变的Class类型的对象。一个Class对象包含了特定某个接口（class/interface/enum/annotaion/primitive type/void[]）的有关信息。

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

2.6 Class类的常用方法

方法名功能说明
static ClassforName(String name)返回指定类名name的Class对象
Object newInstance()调用缺省构造函数，返回Class对象的一个实例
gatName()返回此Class对象所表示的实体（类，接口，数组类或void）的名称
Class getSuperClass()返回当前Class对象的父类的Class对象
Class[] getinterfaces()获取当前Class对象的接口
ClassLoader getClassLoader()返回该类的类加载器
Constructor[] getConstructors()返回一个包含某些Constructor对象的数组
Method getMothed(String name, Class... T)返回一个Method对象，此对象的形参类型为paramType
Field[] getDeclaredFields()fanhuiField对象的一个数组

2.7 获取Class类的实例

  • 若已知具体的类，通过类的class属性获取，该方法最为安全可靠，程序性能最高
  • 已知某个类的实例，调用该实例的getClass()方法获取Class对象
  • 已知一个类的全类名，且该类在类路径下，可通过Class类的静态方法forName()获取，可能抛出ClassNotFoundException错误
  • 内置基本数据类型可以直接用类名.Type
  • 还可以利用ClassLoader

2.8 哪些类型可以有CLass对象

  • Class：外部类，成员（成员内部类，静态内部类），局部内部类，内部匿名类
  • interface：接口
  • []：数组
  • enum：枚举
  • annotation：注解@interface
  • primitive type：基本数据类型
  • void

注：只要元素类型与维度相同，则Class相同；

2.9 Java内存分析

Java内存

  • 堆
    • 存放new的对象和数组
    • 可以被所有的线程共享，不会存放别的对象引用
  • 栈
    • 存放基本变量类型（会包含这个基本类型的具体数值）
    • 引用对象的变量（会存放这个引用在堆里面的具体地址）
  • 方法区
    • 可以被所有的线程共享
    • 包含了所有的class和static变量

2.10 类的加载过程

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

$类的加载（Load） \to 类的链接（Link） \to 类的初始化（Initialize）$

类加载：

  • 将类的class文件字节码内容读入内存，并将这些静态数据转换成方法去的运行时数据结构，然后创建一个java.lang.Class对象。此过程由类加载器完成

类链接：

  • 将Java类的二进制数据合并到JVM的运行状态（JRE）中的过程
    • 验证：确保加载的类信息复核JVM规范，没有安全方面的问题
    • 准备：正式为类变量（staitc）分配内存并设置类变量默认初始值的阶段，这些内存都将在方法区中进行配置
    • 解析：虚拟机常量池内的符号引用（常量名）替换为直接引用（地址）的过程

类初始化：

  • JVM负责对类进行初始化
    • 执行类构造器<clinit>()方法的过程。类构造器<clinit>()方法是由编译器自动收集类中所有类变量的赋值动作和静态代码块中的语句合并产生的。（类构造器是构造类信息的，不是构造该类对象的构造器）
    • 当初始化一个类的时候，如果发现其父类还没有进行初始化，则需要先出发其父类的初始化
    • 虚拟机会保证一个类的<clinit>()方法在多线程环境中被正确加锁和同步。

2.11 类的初始化

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

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

2.12 类加载器的作用

  • 类加载器的作用：将class文件字节码内容加载到内存中，并将这些静态数据转换成方法区的运行时数据结构，然后在堆中生成一个代表这个类的java.lang.Class对象，作为方法区中类数据的访问入口。
  • 类缓存：标准的JavaSE类加载器可以按要求查找类，但一旦某个类被加载到类加载器中，它将维持加载（缓存）一段时间。不过JVM垃圾回收机制可以回收这些Class对象。
  • JVM规范定义了如下类型的类的加载器：
    • 引导类加载器：用C++编写的，是JVM自带的类加载器，负责Java平台核心库，用来装载核心类库。(该加载器无法直接获取)
    • 扩展类加载器：负责jre/lib/ext目录下的jar包或-D java.ext.dirs 指定目录下的jar包装入工作库
    • 系统类加载器：负责java -classpath或-D java.class.path所指的目录下的类与jar包装入工作，是最常用的加载器

2.13 类的运行时结构

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

Field、Method、Constructor、Superclass、Interface、Annotation

  • 实现的全部接口
  • 所继承的父类
  • 全部的构造器
  • 全部的方法
  • 全部的属性
  • 注解
  • ……

2.14 Class对象的作用

  • 创建类的对象：调用Class对象的newInstance()方法
    • 类必须有一个无参数的构造器
    • 类的构造器的访问权限需要足够
  • 创建没有无参构造器的类的对象
    • 通过Class类的getDeclaredConstructor(Class ... parameterTypes)取得本类的指定形参类型的构造器
    • 向构造器的形参中传递一个对象数组进去，里面包含了构造器中所需的各个参数
    • 通过Constructor实例化对象
  • 通过反射调用类中的方法
    • 通过Class类的getMethos(String name, Class ... parameterTypes)方法取得一个Method对象，并设置此方法操作时所需要的参数类型；
    • 之后使用Object invoke(Object obj, Object[] args)进行调用，并向方法中传递要设置的obj对象的参数信息；
  • 调用指定的方法
    • Object对应原方法的返回值，若原方法无返回值，此时返回null；
    • 若原方法为静态方法，此时形参Object obj可为null；
    • 若原方法形参列表为空，则Object[] args为null；
    • 若原方法声明为private，则需要在调用此invoke()方法前，显式调用方法对象的setAccessible(true)方法，将可访问private方法；

2.15 setAccessible

  • Method和Field、Constructor对象都有setAccessible()方法；
  • setAccessible作用是启动和禁用访问安全检查的开关；
  • 参数值为true时反射的对象应该取消java语言访问检查；
    • 提高反射的效率，如果代码中必须用反射，而该句代码需要频繁的被调用，那么请设置为true。
    • 使得原本无法访问的私有成员也可以访问
  • 参数值为false时反射的对象应该实施java语言访问检查

2.16 小知识

1000.for //可以快速生成for循环，当前实例生成代码如下
for (int i = 0; i < 1000; i++) {

}
// 换成数组也可以
int[] arr = new int[9];
arr.for
for (int i : arr) {
                
 }

3. 反射

3.1 反射操作泛型

  • java采用泛型擦除的机制来进入泛型，Java中的泛型仅仅是给编译器javac使用的，确保数据的安全性和免去强制类型转换问题，但是，一旦编译完成，所有和泛型有关的类型全部擦除
  • 为了通过反射操作这些类型，Java新增了ParameterizedType，GenericArrayType，TypeVariable和WildcardType几种类型来代表不能被归一到Class中的类型但是又和原始类型齐名的类型
    • ParameterizedType：表示一种参数化类型，比如Collection
    • GenericArrayType：表示一种元素类型是参数化类型或者变量的数组类型
    • TypeVariable：是各种类型变量的公共父接口
    • WildcardType：代表一种通配符类型表达式

3.2 反射操作注解

3.2.1 ORM

  • Object relationship Mapping：对象关系映射
    • 类和表结构对应
    • 属性和字段对应
    • 对象和记录对应

3.2.2 小例

/**
 * 功能说明: x
 *
 * @author YanceyGao
 * @date 2021/9/18
 */

@OperateTable("student")
public class Student {

    @OperateField(
            columnName = "STU_NO",
            type = "VARCHAR",
            length = 16)
    String stuNo;
    @OperateField(
            columnName = "STU_NAME",
            type = "VARCHAR",
            length = 64)
    String name;
    @OperateField(
            columnName = "STU_AGE",
            type = "INT",
            length = 8)
    Integer age;
    @OperateField(
            columnName = "STU_NO",
            type = "VARCHAR",
            length = 64)
    String major;

    public Student() {
    }

    public Student(String stuNo, String name, Integer age, String major) {
        this.stuNo = stuNo;
        this.name = name;
        this.age = age;
        this.major = major;
    }

    public String getStuNo() {
        return stuNo;
    }

    public void setStuNo(String stuNo) {
        this.stuNo = stuNo;
    }

    public String getName() {
        return name;
    }

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

    public Integer getAge() {
        return age;
    }

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

    public String getMajor() {
        return major;
    }

    public void setMajor(String major) {
        this.major = major;
    }

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

/**
 * 功能说明:
 *
 * @author YanceyGao
 * @date 2021/9/18
 */

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface OperateTable {
    String value();
}

/**
 * 功能描述
 *
 * @author gaoyang42213
 * @date 2021/9/18
 * @version 1.0
 */

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface OperateField {
    String columnName();
    String type();
    int length();
}


/**
 * 功能说明:
 *
 * @author YanceyGao
 * @date 2021/9/18
 */
public class Main {

    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException {
        Class aClass = Class.forName("com.yancey.reflection_operation_annotation.Student");

        // 通过反射获得注解
        Annotation[] annotations = aClass.getAnnotations();
        System.out.println(annotations);
        for (Annotation annotation : annotations) {
            System.out.println(annotation);
        }
        OperateTable annotation = (OperateTable) aClass.getAnnotation(OperateTable.class);
        System.out.println(annotation.value());

        Field field = aClass.getDeclaredField("name");
        OperateField operateField = (OperateField) field.getAnnotation(OperateField.class);
        System.out.println(operateField);
        System.out.println(operateField.columnName() + "---" + operateField.type() + "----" + operateField.length());
    }

}

Q.E.D.

If you don't come, I will snow.