Java注解与反射：深入理解与实战应用-优快云博客

本文链接：https://blog.youkuaiyun.com/qq_41877400/article/details/118695619

注解和反射

1.注解

1.1、注解入门

什么是注解

Annotation是从JDK5.0开始引入的新技术)
Annotation的作用:
- 不是程序本身，可以对程序作出解释.(这一点和注释(comment)没什么区别)
- 可以被其他程序(比如:编译器等)读取.
Annotation的格式︰
- 注解是以"@注释名"在代码中存在的，还可以添加一些参数值，例如:@SuppressWarnings(value=“unchecked”)。
Annotation在哪里使用?
- 可以附加在package , class , method , field等上面，相当于给他们添加了额外的辅助信息，我们可以通过反射机制编程实现对这些元数据的访问。

1.2、内置注解

@Override︰定义在java.lang.Override中,此注释只适用于修辞方法，表示一个方法声明打算_重写超类中的另一个方法声明.
@Deprecated :定义在java.lang.Deprecated中,此注释可以用于修辞方法，属性，类，表示不鼓励程序员使用这样的元素，通常是因为它很危险或者存在更好的选择．
SuppressWarnings:定义在java.lang.SuppressWarnings中,用来抑制编译时的警告信息.
- 与前两个注释有所不同,你需要添加一个参数才能正确使用,这些参数都是已经定义好了的，我们选择性的使用就好了.
  1. @SuppressWarnings(“all”)
  2. @SuppressWarnings(“unchecked”)
  3. @SuppressWarnings(value={“unchecked”,“deprecation”})
  4. 等等…

1.3、自定义注解，元注解

1.3.1.元注解

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

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

//Retention表示我们的注解在什么地方还有效
//runtime>class>sources
@Retention(value = RetentionPolicy.RUNTIME)

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

// Inherited子类可以继承父类的注解
@Inherited
@interface MyAnnotation{
}

1.3.2、自定义注解

使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口
分析:
- interface用来声明一个注解，格式: public @interface注解名{定义内容}；
- 其中的每一个方法实际上是声明了一个配置参数；
- 方法的名称就是参数的名称；
- 返回值类型就是参数的类型（返回值只能是基本类型,Class , String , enum )；
- 可以通过default来声明参数的默认值；
- 如果只有一个参数成员，一般参数名为value；
- 注解元素必须要有值，我们定义注解元素时,经常使用空字符串，0作为默认值。
```
@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnotation2{
    //注解的参数:参数类型+参数名();
    String name() default "";
    int age();
    int id() default -1;// 如果默认值为-1，代表不存在
    String[] schools() default {"东北大学","西南大学"};
}
```

2.反射机制

2.1、Java反射机制概述

动态语言vs静态语言

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

Reflection

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

在这里插入图片描述

Java反射机制提供的功能

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

优点:
- 可以实现动态创建对象和编译，体现出很大的灵活性
缺点:
- 对性能有影响。使用反射基本上是一种解释操作，我们可以告诉JVM，我们希望做什么并且它满足我们的要求。这类操作总是慢于直接执行相同的操作。

反射相关的主要API

在这里插入图片描述

2.2、理解Class类并获取Class实例

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

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

2.2.1、Class类

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

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

2.2.2、获取Class的实例

若已知具体的类，通过类的class属性获取，该方法最为安全可靠，程序性能最高。
- Class clazz=Person.class;
已知某个类的实例，调用该实例的getClass()方法获取Class对象
- Class clazz = person.getClass();
已知一个类的全类名，且该类在类路径下，可通过Class类的静态方法forName()获取，可能抛出ClassNotFoundException
- Class clazz=Class.forName(“demo01.Student”);
内置基本数据类型可以直接用类名.Type
还可以利用ClassLoader我们之后讲解

//方式一:通过对象获得
Class c1 = person.getClass();

//方式二:forname获得
Class c2 = Class.forName("annotation.Reflection.Student");

//方式三:通过类名.class获得
Class c3 = Student.class;

//方式四:基本内置类型的包装类都有一个Type属性
Class c4 = Integer.TYPE;

//获得父类类型
Class c5 = c1.getSuperclass();

2.2.4、哪些类型可以有Class对象

class:外部类，成员(成员内部类，静态内部类)，局部内部类，匿名内部类。
interface:接口
[]:数组
enum:枚举
annotation:注解@interface
primitive type:基本数据类型
void

2.3、类的加载与ClassLoader

内存分析

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

在这里插入图片描述

2.3.1、类的加载

在这里插入图片描述

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

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

/**
 * 1.加载到内存，会产生一个类对应class对象
 * 2.链接，链接结束后 m=0
 * 3.初始化
 * <clinit>(){
 *     System.out.println("A类静态代码块初始化");
 *         m = 300;
 *         m = 100;
 * }
 */
public class Test5 {
    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类的无参构造初始化");
    }
}

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

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

2.3.3、类加载器的作用

类加载的作用:将class文件字节码内容加载到内存中，并将这些静态数据转换成方法区的运行时数据结构，然后在堆中生成一个代表这个类的java.lang.Class对象，作为方法区中类数据的访问入口。
类缓存:标准的JavaSE类加载器可以按要求查找类，但一旦某个类被加载到类加载器中，它将维持加载（缓存）一段时间。不过JVM垃圾回收机制可以回收这些Class对象

类加载器作用是用来把类(class)装载进内存的。JVM规范定义了如下类型的类的加载器。
在这里插入图片描述

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("annotation.Reflection.Test07").getClassLoader();
    System.out.println(classLoader);

    //测试JDK内置的类是谁加载的
    ClassLoader classLoader1 = Class.forName("java.lang.Object").getClassLoader();
    System.out.println(classLoader1);

    //获得系统类加载器可以加载的路径
    System.out.println(System.getProperty("java.class.path"));
    
    /**
     * C:\Program Files\Java\jdk1.8.0_281\jre\lib\charsets.jar;
     * C:\Program Files\Java\jdk1.8.0_281\jre\lib\deploy.jar;
     * C:\Program Files\Java\jdk1.8.0_281\jre\lib\ext\access-bridge-64.jar;
     * C:\Program Files\Java\jdk1.8.0_281\jre\lib\ext\cldrdata.jar;
     * C:\Program Files\Java\jdk1.8.0_281\jre\lib\ext\dnsns.jar;
     * C:\Program Files\Java\jdk1.8.0_281\jre\lib\ext\jaccess.jar;
     * C:\Program Files\Java\jdk1.8.0_281\jre\lib\ext\jfxrt.jar;
     * C:\Program Files\Java\jdk1.8.0_281\jre\lib\ext\localedata.jar;
     * C:\Program Files\Java\jdk1.8.0_281\jre\lib\ext\nashorn.jar;
     * C:\Program Files\Java\jdk1.8.0_281\jre\lib\ext\sunec.jar;
     * C:\Program Files\Java\jdk1.8.0_281\jre\lib\ext\sunjce_provider.jar;
     * C:\Program Files\Java\jdk1.8.0_281\jre\lib\ext\sunmscapi.jar;
     * C:\Program Files\Java\jdk1.8.0_281\jre\lib\ext\sunpkcs11.jar;
     * C:\Program Files\Java\jdk1.8.0_281\jre\lib\ext\zipfs.jar;
     * C:\Program Files\Java\jdk1.8.0_281\jre\lib\javaws.jar;
     * C:\Program Files\Java\jdk1.8.0_281\jre\lib\jce.jar;
     * C:\Program Files\Java\jdk1.8.0_281\jre\lib\jfr.jar;
     * C:\Program Files\Java\jdk1.8.0_281\jre\lib\jfxswt.jar;
     * C:\Program Files\Java\jdk1.8.0_281\jre\lib\jsse.jar;
     * C:\Program Files\Java\jdk1.8.0_281\jre\lib\management-agent.jar;
     * C:\Program Files\Java\jdk1.8.0_281\jre\lib\plugin.jar;
     * C:\Program Files\Java\jdk1.8.0_281\jre\lib\resources.jar;
     * C:\Program Files\Java\jdk1.8.0_281\jre\lib\rt.jar;
     * F:\java\javase\out\production\javase;
     * F:\java\javase\src\lib\commons-io-2.10.0.jar;
     * D:\app\IDEA\IntelliJ IDEA 2020.3.2\lib\idea_rt.jar
     */
}

2.4、创建运行时类的对象

// 获得类的名字
Class c1 = Class.forName("annotation.Reflection.User");
System.out.println(c1.getName());
System.out.println(c1.getSimpleName());
//获得类的属性
System.out.println("=============================================");
Field[] fields = c1.getFields();//只能找到public属性

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

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

//获得类的方法
System.out.println("=============================================");
Method[] declaredMethods = c1.getDeclaredMethods();//获得其父类的所有方法
for (Method declaredMethod : declaredMethods) {
    System.out.println(declaredMethod);
}
System.out.println("=============================================");
Method[] methods = c1.getMethods();//获得本类及其父类的全部public方法
for (Method method : methods) {
    System.out.println(method);
}
//获得指定构造器及指定的构造器
Constructor declaredConstructor = c1.getDeclaredConstructor(String.class, int.class, int.class);
System.out.println("指定：" + declaredConstructor);

小结：

在实际的操作中，取得类的信息的操作代码，并不会经常开发。
一定要熟悉java.lang.reflect包的作用，反射机制。
如何取得属性、方法、构造器的名称，修饰符等。

有了Class对象，能做什么？

创建类的对象:调用Class对象的newlnstance()方法
- 类必须有一个无参数的构造器。
- 类的构造器的访问权限需要足够
**思考?**难道没有无参的构造器就不能创建对象了吗?只要在操作的时候明确的调用类中的构造器，并将参数传递进去之后，才可以实例化操作。
- 步骤如下:
  - 通过Class类的getDeclaredConstructor(Class… parameterTypes)取得本类的指定形参类型的构造器
  - 向构造器的形参中传递一个对象数组进去，里面包含了构造器中所需的各个参数。
  - 通过Constructor实例化对象
通过反射，调用类中的方法，通过Method类完成。
- 通过Class类的getMethod(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的方法。

setAccessible

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

//获得Class对象
Class c1 = Class.forName("annotation.Reflection.User");

//1. 构造一个对象
User user = (User) c1.newInstance();
System.out.println(user);

//2.通过构造器创建对象
Constructor constructor = c1.getDeclaredConstructor(String.class, int.class, int.class);
User user1 = (User) constructor.newInstance("秦疆", 001, 18);
System.out.println(user1);

//3.通过反射操作方法
User user3 = (User) c1.newInstance();
//通过反射获取一个方法
Method setName = c1.getDeclaredMethod("setName", String.class);

//invoke： 激活的意思 ===》(对象，"方法的值")
setName.invoke(user3, "彭添他");
System.out.println(user3.getName());

//4.通过反射操作属性
System.out.println("===========================================");
User user4 = (User) c1.newInstance();
Field name = c1.getDeclaredField("name");

// 不能操作私有属性，我们需要程序的安全检测，属性或者方法的setAccessible(Ture)。
name.setAccessible(true);
name.set(user4, "你");
System.out.println(user4);

2.5、反射操作泛型

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

2.6、反射操作注解

getAnnotations
getAnnotation

ORM

了解什么是ORM?
- Object relationship Mapping -->对象关系映射
- 属性和字段对应
- 对象和记录对应
- 类和表结构对应
要求:利用注解和反射完成类和表结构的映射关系

Class c1 = Class.forName("annotation.Reflection.Student2");

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

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

//获得类指定的注解
Field f = c1.getDeclaredField("name");
Fieldend annotation1 = f.getAnnotation(Fieldend.class);
System.out.println(annotation1.columnName());
System.out.println(annotation1.type());
System.out.println(annotation1.length());

or (Annotation annotation : annotations) {
System.out.println(annotation);
}

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

//获得类指定的注解
Field f = c1.getDeclaredField(“name”);
Fieldend annotation1 = f.getAnnotation(Fieldend.class);
System.out.println(annotation1.columnName());
System.out.println(annotation1.type());
System.out.println(annotation1.length());