注解和反射

注解和反射

1. 注解

1.1 什么是注解

• Annotation是从JDK 5.0开始引入的新技术

• Annotation的作用:

  • 不是程序本身，可以对程序作出解释（这点和注释（comment）没什么区别）

  • 可以被其他程序（如编译器等）读取

• Annotation的格式:

  • 注解是以“@注释名”在代码中存在的，还可以添加一些参数值

• Annotation在哪里使用》

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

1.2. 内置注解

• @Override：定义在java.lang.Override中，此注解只适用于修饰方法，表示一个方法声明打算重写超类中的另一个方法声明。

• @Deprecated：定义在java.lang.Deprecated中，此注解可以修饰方法、属性、类，表示不鼓励程序员使用这样的元素，通常是因为它很危险或者存在更好的选择。

• @SupressWarnings：定义在java.lang.SupressWarnings中，用来抑制编译时的警告信息。

  • 与前两个注解有所不同，需要添加一个参数才能正常使用，这些参数是已经定义好的，选择使用即可。

  • 参数有all、unchecked、{“unchecked”,“deprecation”}等

1.3. 自定义注解、元注解

1.3.1 元注解

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

• 这些类型和他们所支持的类在java.lang.annotation包中可以找到(@Target,@Retention,@Documented,@Inherited)

  • @Target:用来描述注解的使用范围（即：被描述的注解可以用在什么地方）

  • @Retention：表示需要在什么级别保存该注解信息，用于描述注解的生命周期

    • SOURCE < CLASS < RUNTIME

  • @Documented:说明该注解将被包含在javadoc中

  • @Inherited：说明子类可以继承父类中该注解

package com.hyf.anntation;

import java.lang.annotation.*;

//测试元注解
@MyAnnootation
public class Test02 {
    @MyAnnootation
    public void test(){

    }
}

//定义一个注解
//Target 表示我们的注解可以用在哪些地方
@Target(value = {ElementType.TYPE,ElementType.METHOD})

//Retention表示注解在什么地方还有效   RUNTIME >CLASS > SOURCES
@Retention(RetentionPolicy.RUNTIME)

//@Documented 表示是否将我们的注解生成在JavaDoc中
@Documented

//
@Inherited
@interface MyAnnootation{
}

1.3.2 自定义注解

• 使用@interface自定义注解，它会自动继承java.lang.annotation.Annotation接口

• 分析

  • @interface来声明一个注解

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

  • 方法的名称就是类的名称

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

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

  • 如果只有一个参数成员，一般参数名为value

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

2. 反射机制

2.1 Java反射机制概述

静态语言 VS 动态语言

动态语言

• 在运行时代码可以根据某些条件改变自身结构

• 例如：Object-C、C#、JavaScript、PHP、Python等

静态语言

• 与动态语言相对应，运行时结构不可变的语言就是静态语言。如Java、C、Cpp

• Java不是动态语言，但是Java可以称之为“准动态语言”。Java有一定的动态性，我们可以利用反射机制获得类似动态语言的特性

反射（Reflection）是Java被视为动态语言的关键，反射机制允许程序在执行期借助Refection API获得任何类的内部信息，并能直接操作任意对象的内部属性及方法。
加载完类之后，在堆内存的方法区中就产生了一个个Class类型的对象（一个类只有一个Class对象），这个对象就包含了完整的类的结构信息。我们可以通过这个对象看到类的结构。这个对象就像一面镜子，透过这个镜子看到类的结构，所以，我们形象的称之为：反射。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-elXYnn0o-1642173714754)(https://github.com/Missyesterday/Picture/blob/main/Xnip2022-01-14_01-34-16.jpg?raw=true)]

Java反射机制提供的功能

• 在运行时判断任意一个对象所属的类

• 在运行时构造任意一个类的对象

• 在运行时判断任意一个类所具有的成员变量和方法

• 在运行时处理注解

• 生成动态代理

Java反射的优点和缺点

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

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

2.2 理解Class类并获取Class实例

反射相关的主要API

• Java.lang.Class:代表一个类

• java.lang.reflect.Method:代表类的方法

• java.lang.reflect.Field：代表类的成员变量

• java.lang.reflect.Constructor：代表类的构造器

Class类

对象照镜子后可以得到的信息：某个类的属性、方法和构造器、某个类到底实现了哪些接口。对于每个类而言，JRE都为其保留一个不变的Class类型的对象。一个Class对象包含了特定某个结构（class/interface/enum/annotation/private type/void/[])的有关信息。

• Class本身也是一个类

• Class对象只能由系统建立对象

• 一个加载的类在JVM中只会有一个Class实例

• 一个Class对象对应的是一个加载到JVM中的一个.class文件

• 每个类的实例都会记得自己是哪个Class实例所生成

• 通过Class可以完整的得到一个类中的所有被加载的结构

• Class类是Reflection的根源，针对任何你想动态加载、运行的类，唯有鲜活的响应的Class对象

方法名	功能说明
static ClassforName(String name)	返回指定类名的Class对象
Object newInstance()	调用无参构造函数，返回Class对象的一个实例
getName()	返回此Class对象所表示的实体（类、接口、数组类或void）的名称
Class getSuperClass()	返回当前Class对象的父类Class对象
Class[] getInterfaces()	返回Class对象的接口
Constructor[] getClassLoader()	返回该类的类加载器
Method getMethod(String name,Class … T)	返回一个Method对象，此对象的形参类型为paramType
Field[] getDeclaredFields()	返回Field对象的一个数组

获取Class类的实例

1. 若已知具体的类，通过类的class属性获取，该方法最为安全可靠，程序性能最高

2. 已知某个类的实例，通过"实例.getClass()"

3. 已知一个类的全类名，且该类在类路径下，可以通过Class的静态方法forName()获取

4. 内置基本数据类型可以用“类名.Type”

5. 利用ClassLoader

2.3 类的加载与ClassLoader

2.3.1 类的加载

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-KIg2YeMv-1642173714755)(https://github.com/Missyesterday/Picture/blob/main/Xnip2022-01-14_17-40-56.jpg?raw=true)]

• 加载：将class文件字节码内容加载到内存中，并将这些静态数据转换成方法区的运行时数据结构，然后生成一个代表这个类的java.lang.Class对象。加载是类加载过程中的一个阶段

• 链接：将Java类的二进制代码合并到JVM的运行状态之中的过程

  • 验证:确保加载的类信息符合JVM规范，没有安全方面的问题

  • 准备：正式为类变量（static）分配内存并设置类默认初始值的阶段，这些内存都将在方法区中进行分配

    • 例如static int m = 100，默认初始值是0！

    • 对final的静态字面值常量直接赋初值（赋初值不是赋默认值，如果不是字面值静态常量，那么会和静态变量一样赋默认值）

  • 解析：将虚拟机常量池内的符号引用（常量名）替换为直接引用（地址）的过程

    • 假设：一个类有一个静态变量，该静态变量是一个自定义的类型，那么经过解析后，便静态变量将是一个指针，指向该类在方法区的内存地址。

• 初始化：为类的静态变量赋初值

• 赋初值的两种方法：

  • 定义静态变量时指定初始值。如static int m = 100;

  • 在静态代码块里为静态变量赋值。如static {m=300;}

• 对于这两种方法的先后赋值顺序，取决于它们在源代码中的顺序

• 例如：

package com.hyf.reflection;

import sun.rmi.rmic.iiop.IDLGenerator;

//类的加载
public class Test05 {

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

}

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


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

输出300

而

package com.hyf.reflection;

import sun.rmi.rmic.iiop.IDLGenerator;

//类的加载
public class Test05 {

    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类的无参构造初始化");
    }
}

输出100

• 执行类构造器<clinit>()方法的过程。类构造器<clinit>()方法是由编译器自动收集类中所有类变量的赋值动作和静态代码块中的语句合并产生的。（类构造器是构造类的信息的，不是构造该类对象的构造器）

• 当初始化一个类的时候，如果发现其父类还没有进行初始化，则需要先触发其父类的初始化

• 虚拟机会保证一个类的<clinit>()方法在多线程环境中被正确加锁和同步

2.3.2 类初始化时机

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

2.3.3 类加载器的作用

类加载器的作用是用来把class文件字节码内容加载到内存中并将这些静态数据转换成方法区的运行时数据结构，然后在堆中生存一个代表这个类的java.lang.Class对象，作为方法区中类数据的访问入口。JVM与定义有三种类加载器：

• 根类加载器（bootstrap class loader）:它用来加载 Java 的核心类，是用原生代码来实现的，并不继承自 java.lang.ClassLoader（负责加载$JAVA_HOME中jre/lib/rt.jar里所有的class，由C++实现，不是ClassLoader子类）。由于引导类加载器涉及到虚拟机本地实现细节，开发者无法直接获取到启动类加载器的引用，所以不允许直接通过引用进行操作。
• 扩展类加载器（extensions class loader）：它负责加载JRE的扩展目录，lib/ext或者由java.ext.dirs系统属性指定的目录中的JAR包的类。由Java语言实现，父类加载器为null。
• 系统类加载器（system class loader）：被称为系统（也称为应用）类加载器，它负责在JVM启动时加载来自Java命令的-classpath选项、java.class.path系统属性，或者CLASSPATH换将变量所指定的JAR包和类路径。程序可以通过ClassLoader的静态方法getSystemClassLoader()来获取系统类加载器。如果没有特别指定，则用户自定义的类加载器都以此类加载器作为父加载器。由Java语言实现，父类加载器为ExtClassLoader。

package com.hyf.reflection;

public class Test07 {
    public static void main(String[] args) throws ClassNotFoundException {
        //获取系统类的加载器
        ClassLoader systemClassLoader = ClassLoader.getSystemClassLoader();
        System.out.println(systemClassLoader);

        //获取系统类加载器的父类加载器-->扩展类加载器
        ClassLoader parent = systemClassLoader.getParent();
        System.out.println(parent);

        //获取扩展类加载器的父类加载器-->根加载器 C/C++
        ClassLoader parent1 = parent.getParent();
        System.out.println(parent1);

        //测试当前类是哪个加载器加载的
        ClassLoader classLoader = Class.forName("com.hyf.reflection.Test07").getClassLoader();
        System.out.println(classLoader);

        ClassLoader classLoader1 = Class.forName("java.lang.Object").getClassLoader();
        System.out.println(classLoader1);

        //如何获得系统类加载器可以加载的路径
        System.out.println(System.getProperty("java.class.path"));

        //双亲委派机制，检测安全性，写一个与java.lang.xxx同名的包不会运行


        /*/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/jre/lib/charsets.jar:
        /Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/jre/lib/ext/cldrdata.jar:
        /Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/jre/lib/ext/dnsns.jar:
        /Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/jre/lib/ext/jaccess.jar:
        /Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/jre/lib/ext/legacy8ujsse.jar:
        /Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/jre/lib/ext/localedata.jar:
        /Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/jre/lib/ext/nashorn.jar:
        /Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/jre/lib/ext/openjsse.jar:
        /Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/jre/lib/ext/sunec.jar:
        /Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/jre/lib/ext/sunjce_provider.jar:
        /Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/jre/lib/ext/sunpkcs11.jar:
        /Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/jre/lib/ext/zipfs.jar:
        /Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/jre/lib/jce.jar:
        /Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/jre/lib/jfr.jar:
        /Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/jre/lib/jsse.jar:
        /Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/jre/lib/management-agent.jar:
        /Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/jre/lib/resources.jar:/Library
        /Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/jre/lib/rt.jar:
        /Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/lib/dt.jar:
        /Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/lib/jconsole.jar:
        /Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/lib/tools.jar:
        /Users/heyufan1/Library/Mobile Documents/com~apple~CloudDocs/学习/Java/Annotation/out/production/Annotation:
        /Applications/IntelliJ IDEA.app/Contents/lib/idea_rt.jar

         * */

    }
}

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

2.4 创建运行时类的对象

2.4.1 获取运行时类的完整结构

通过反射获取运行时类的完整结构,通过一些方法
Field（属性）、Method、Constructor、Superclass、Interface、Annotation

package com.hyf.reflection;

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

//获得类的信息
public class Test08 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException, NoSuchMethodException {
        Class c1 = Class.forName("com.hyf.reflection.Ueser");

        Ueser ueser = new Ueser();
        Class<? extends Ueser> c2 = ueser.getClass();

        //通过反射获得类的名字
        System.out.println(c1.getName());//获得包名+类名
        System.out.println(c1.getSimpleName());//获得类名

        System.out.println(c2.getName());//获得包名+类名
        System.out.println(c2.getSimpleName());//获得类名

        //获得类的属性
/*        Field[] fields = c1.getFields();//只能找到public属性
        for (Field field :
                fields) {
            System.out.println(field);
        }*/

        Field[] fields = c1.getDeclaredFields(); //能找到全部属性
        for (Field field :
                fields) {
            System.out.println(field);
        }


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

        //获得类的方法
        for (Method method : c1.getMethods()) { //获得本类及其父类的所有public方法
            System.out.println("正常的"+method);

        }

        for (Method method : c1.getDeclaredMethods()) {//获得本类所有的方法
            System.out.println("Declared  "+method);

        }

        //获得指定方法，需要方法中的参数
        //重载
        Method getName = c1.getMethod("getName", null);
        Method setName = c1.getMethod("setName", String.class);
        System.out.println(getName);
        System.out.println(setName);

        //获得构造器  一样的 getConstructors()....


    }
}

2.4.1 创建动态对象

调用Class对象的newInstance()方法

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

通过Class类的getDeclaredConstuctor()可以取得本类的指定形参类型的构造器，然后再构造器.newInstance();

通过反射操作方法

 //通过反射获得一个方法,invoke(对象，方法);
        Method setName = c1.getDeclaredMethod("setName", String.class);
        setName.invoke(u,"h");

package com.hyf.reflection;


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

//动态创建对象，通过反射
public class Test09 {
    public static void main(String[] args) throws ClassNotFoundException, InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException, NoSuchFieldException {

        //获得class对象
        Class c1 = Class.forName("com.hyf.reflection.Ueser");

        //构造一个对象
        Ueser u1 = (Ueser) c1.newInstance();//本质上调用了类的无参构造器，没有无参构造器报错

        System.out.println(u1);

        //通过构造器创建一个对象
        Constructor constructor = c1.getDeclaredConstructor(String.class, int.class, int.class);
        Ueser u = (Ueser) constructor.newInstance("何宇凡", 1, 12);
        System.out.println(u);

        //通过反射获得一个方法,invoke(对象，方法);
        Method setName = c1.getDeclaredMethod("setName", String.class);
        setName.invoke(u,"h");

        System.out.println(u.getName());


        //通过反射操作属性，不能直接操作私有属性，需要关闭程序的安全检测，属性或者方法的setAccessible(true);
         Ueser u2 = (Ueser) c1.newInstance();
        Field name = c1.getDeclaredField("name");

        name.setAccessible(true);
        name.set(u2,"name");
        System.out.println(u2.getName());
    }
}

setAccessible

• Method、Field、Constructor对象都有setAccessible()方法
• setAccessible()方法的作用是启动和禁用访问安全检测的开关
• 参数值为true则指示反射的对象在使用时应该取消Java语言的访问检测，提高反射的效率和访问private成员是设置为true
• 参数值为false则指示反射的对象应该实施Java语言访问检查

分析性能

package com.hyf.reflection;

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

//分析性能问题
public class Test10 {
    //普通方式调用
    public static void test01(){
        Ueser u1 = new Ueser();

        long startTime = System.currentTimeMillis();

        for (int i = 0; i < 1000000000; i++) {//10亿次
            u1.getName();
        }
        long endTime = System.currentTimeMillis();
        System.out.println("普通方法执行10亿次" + (endTime - startTime) + "ms");

    }
    //反射方式调用
    public static void test02() throws NoSuchMethodException, InvocationTargetException, IllegalAccessException {
        Ueser u = new Ueser();
        Class c1 = u.getClass();

        Method getName = c1.getDeclaredMethod("getName", null);

        long startTime = System.currentTimeMillis();

        for (int i = 0; i < 1000000000; i++) {//10亿次
            getName.invoke(u,null);
        }
        long endTime = System.currentTimeMillis();
        System.out.println("反射方法执行10亿次" + (endTime - startTime) + "ms");

    }

    //反射方式调用 关闭检测
    public static void test03() throws NoSuchMethodException, InvocationTargetException, IllegalAccessException {
        Ueser u = new Ueser();
        Class c1 = u.getClass();

        Method getName = c1.getDeclaredMethod("getName", null);
        getName.setAccessible(true);
        long startTime = System.currentTimeMillis();

        for (int i = 0; i < 1000000000; i++) {//10亿次
            getName.invoke(u,null);
        }
        long endTime = System.currentTimeMillis();
        System.out.println("关闭检测反射方法执行10亿次" + (endTime - startTime) + "ms");

    }

    public static void main(String[] args) throws InvocationTargetException, NoSuchMethodException, IllegalAccessException {
        test01();
        test02();
        test03();
    }
}

2.5 反射操作泛型

package com.hyf.reflection;

import java.lang.reflect.Method;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.List;
import java.util.Map;

//通过反射获取泛型
public class Test11 {
        public void test01(Map<String, Ueser> map, List<Ueser> list){
            System.out.println("test01");
        }
        public Map<String,Ueser> test02(){
            return null;
        }

    public static void main(String[] args) throws NoSuchMethodException {
        Method method = Test11.class.getMethod("test01", Map.class, List.class);

        Type[] genericParameterTypes = method.getGenericParameterTypes();
        for (Type genericParameterType : genericParameterTypes) {
            System.out.println(genericParameterType);
            if(genericParameterType instanceof ParameterizedType){//获得泛型的参数类型
                Type[] actualTypeArguments = ((ParameterizedType) genericParameterType).getActualTypeArguments();
                for (Type actualTypeArgument : actualTypeArguments) {
                    System.out.println(actualTypeArgument);
                }
            }
        }

    }
}

2.6 反射操作注解

• ORM:Object Relationship Mapping 对象关系映射
  [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-UIjKKPLP-1642173714755)(https://github.com/Missyesterday/Picture/blob/main/Xnip2022-01-14_23-00-25.jpg?raw=true)]
  • 类和表结构对应
  • 属性和字段对应
  • 对象和记录对应
• 要求利用注解和反射完成类和表结构的映射关系

package com.hyf.reflection;

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

//练习反射操作注解
public class Test12 {

    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException {
        Class c1 = Class.forName("com.hyf.reflection.Student");

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

        //获得指定注解value的值
        Table annotation = (Table) c1.getAnnotation(Table.class);
        System.out.println(annotation.value());

        //获得类指定的注解

        Field f = c1.getDeclaredField("name");
        FieldHe annotation1 = f.getAnnotation(FieldHe.class);
        System.out.println(annotation1.columnName());
        System.out.println(annotation1.type());
        System.out.println(annotation1.length());


    }
}

@Table("db_student")
class Student{
    @FieldHe(columnName = "db_name",type = "varchar", length = 3)
    String name;
    @FieldHe(columnName = "db_age",type = "int", length = 10)
    int age;

    @FieldHe(columnName = "db_id",type = "int", length = 10)
    int id;

    @Override
    public String toString() {
        return "Student{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", 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;
    }

    public int getId() {
        return id;
    }

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

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


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

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