反射

上一篇Java反射之获取注解的AnnotatedElement接口介绍了 AnnotatedElement 接口，它是用反射获取注解的顶级接口。其实现类或子接口包括 Class、TypeVariable、Parameter、Package、AccessibleObject、GenericDeclaration 等，这些在前边的文章中已经介绍过。另外，它还有一个重要的接口 AnnotatedType，本篇将介绍它。 1. 再说注解 JDK1.5推出了注解功能，给Java语言带来非常强大的诸多特性。Java注解有几种保留策略：源码、运行时、类，可以在创建注解时通过 @Retention 元注解来指定，它需要引用 RetentionPolicy 中定义的策略： SOURCE: 注解只在源码层面保留，编译后被丢弃 CLASS: 默认的保留策略，注解将由编译器记录在类文件中，但在运行时不需要由 JVM 保留 RUNTIME: 注解不仅保留在类文件，在运行时 JVM 也会保留它，因此可以通过反射获取注解 注解的作用大概可以分为以下几种： 提供编译期特性：Java提供的一些注解，可以进行编译期特性支持，比如 @SuppressWarnings, @Deprecated 和 @Override 等可以提供编译期检查，@FunctionalInterface 标注函数式接口等 生成帮助文档：Java的 @Documented 注解可以用来标记生成 javadoc 时保留类或接口上的注解 运行时获取注解实现特定逻辑：这个是使用最多的场景，使用注解，并通过反射获取注解，来实现自身业务逻辑，大多数框架都使用注解来实现高级特性，比如 Spring 的 @Bean、 @Service 等注解 一句话，有了注解，我们可以方便的按需实现自身业务逻辑。在JDK1.8之前呢，注解所能表示标注的位置有限，JDK1.8又新增了两种标注位置，支持将注解标注在任何类型上。 2. 再说注解标注的位置 还记得 上一篇 介绍注解标注的位置信息吗？文中提到，通过 ElementType 枚举来定义注解可标注的位置信息，其他包括下边两项： ElementType.TYPE_PARAMETER: 标注在类型参数上，比如泛型参数T、E上 ElementType.TYPE_USE: 使用类型，注解可以标注在任何类型变量上 它们都是在JDK1.8时新增的，TYPE_PARAMETER 主要目的在于支持将注解标注在泛型类型的参数上，而 TYPE_USE 范围更广，可以将注解标注在任何Java类型上。也就是说，JDK1.8之前，注解只能标注在特定的位置（类、方法、包、参数、域、构造器、本地变量、注解），不能标注在泛型参数上，JDK1.8之后，可以标注在任何类型上。 使用TYPE_USE就可以省略其他 ElementType 元素吗？ 既然 TYPE_USE 可以表示标注在所有类型上，那么是不是就不需要其他 ElementType 元素了呢？肯定不是！TYPE_USE 有其特殊的目的，它表示 “类型使用” 类型，其实就是指任何Java类型，但是它只能用 AnnotatedType 来描述并获取注解信息（见这里）。 ...

在Java反射的体系结构一文中说过，AnnotatedElement 接口定义了通过反射获取注解信息的方法，它是一个顶层接口，能够被标记注解的反射类都实现了该接口从而得到反射获取注解的能力，比如 Class、Field、Constructor、Method、Parameter 都实现了该接口。本文将详细介绍 AnnotatedElement。 1. 再说注解 注解是JDK1.5推出的新特性，用于标注Java中的特定元素，以便通过反射来获取它们，并实现不同的功能。本文不会讨论注解的基本知识，有兴趣的可以自行查阅相关资料。但是注解有一些特性需要细说一番。 1.1. 注解标注的位置 Java中，注解可以标注在多个位置上，常见的包括类、接口上、方法（构造函数）、方法参数（构造函数参数）、成员域上以及标注在注解上（注解的注解），甚至可以将注解标注在 package-info.java 文件中定义的包上，这些位置是在定义注解时通过元注解 @Target 来指定的，比如向下边这样： @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.PACKAGE, ElementType.TYPE, ElementType.FIELD}) public @interface CustomAnno { String value() default ""; } 可以看到，通过 ElementType 来指定注解可以标注的位置，它定义了以下几种位置： ElementType.TYPE: 标注在类型上，包括接口、类、枚举等 ElementType.FIELD: 标注在类、接口的成员域上，包括枚举的元素 ElementType.CONSTRUCTOR: 标注在构造器上 ElementType.ANNOTATION_TYPE: 标注在其他注解上 ElementType.METHOD: 标注在方法上 ElementType.PARAMETER: 标注在方法参数上 ElementType.LOCAL_VARIABLE: 标注本地变量上，即构造器、静态代码块、方法等的内部变量 ElementType.PACKAGE: 标注在 packag-info.java 文件中定义的包上 ElementType.TYPE_PARAMETER: 标注在类型参数上，比如泛型参数T、E上 ElementType.TYPE_USE: 使用类型，注解可以标注在任何类型变量上 上边的最后两个是在JDK1.8新增的，用于在注解标注在泛型上的情况，涉及到 AnnotatedType 接口，我们将在下一篇专门行文来介绍它。 注解用于包上的例子： package-info.java @CustomAnno("package") package com.belonk.lang.reflect; 其他标注位置比较常见，就不在赘述了。 1.2. 注解的继承 Java中定义注解时，可以指定其是否可以被继承。注解继承指的是父类标注的注解可以作用于子类，而不是说一个注解继承另一个注解。比如，自定义如下注解： @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) @Inherited (1) @interface MyAnno { String value() default ""; } ...

通过上一篇Java反射之表示所有类型的Type接口一文，我们知道 Type 接口及其五大组件是用来描述Java的各种类型，主要包括原始类型和泛型类型。很多时候，我们需要获取到泛型类上定义的具体类型，从而完成一些业务逻辑。比如，最常见的情景就是JSON的反序列化，需要将JSON字符串反序列化为泛型的具体类型，比如反序列化为 List<User>，这就要求每一个 List 中的元素都是 User 对象。那么，如何获取到泛型类上定义的具体类型呢？这就是本文要阐述的内容。 1. 通过Class能获取泛型类型吗？ 在/2021/11/09/reflect-class.html中说过，Class 类上有一个 getTypeParameters() 方法用来获取类上的类型变量。通过它能不能获取到泛型类型呢？看下边的示例： class Parent<T> { (1) } 1 定义一个泛型类 这里定义一个泛型类，现在尝试通过它的实例对象来获取泛型类型，代码如下： public void printParent() { Parent<String> parent = new Parent<>(); (1) TypeVariable<? extends Class<? extends Parent>>[] parentTypeParameters = parent.getClass().getTypeParameters(); (2) System.out.println(Arrays.toString(parentTypeParameters)); } 1 创建 Parent 类的实例 2 获取类型变量 上边的示例并不能拿到实例上的 String 类型，而只能拿到 Parent 类上定义的泛型类型 T，因此，输出结果为： [T] 很显然，这个结果不是我们想要的，我们想要获取到 String 这个类。在 Java反射之创建泛型数组 一文中说过，泛型是编译期特性，在运行时泛型会被擦除。因此，我们想通过`Class` 在运行时用反射直接去获取泛型类型，看起来是不行的。 ...

前边说过，JDK1.5推出了反射功能，并介绍了反射的类设计结构，其中提到了 Type 接口，它是JDK1.5新增的接口，表示Java中的所有类型。本文介绍这个接口及其五大组件。 Figure 1. Type及其组件 1. Type的五大组件概览 Type 接口表示Java中的类型，这些类型包括原始类型、参数化类型、数组类型、类型变量和基本类型，前边介绍的 Class 就是其组件之一。Type 及其组件用于通过反射来描述Java各种类型，比如描述泛型的定义，获取泛型参数个数、类型、泛型通配符的上下边界等等。一个典型的应用场景是获取真实的泛型类型，我们将在后续文章单独介绍。 Type 用其五大组件来描述上边提到这些类型，类图如下： Figure 2. Type类图 ParameterizedType: 表示参数化类型，即整个泛型的定义，如 List<String> 可以用 ParameterizedType 来描述； TypeVariable: 表示类型变量，即泛型申明中的具体类型，比如: List<E> 用参数化类型来描述，而其中的 E 就用 TypeVariable 来描述； WildcardType: 表示泛型通配符类型，即泛型申明中带 ? 通配符，比如：List<? extends Number> 中 ? extends Number 就用 WildcardType 来描述； GenericArrayType: 表示泛型数组，比如申明一个泛型数组的域 T[] array，它就用 GenericArrayType 来描述； Class: 表示运行时的类或接口，在前边Java反射的体系结构一文中已经介绍过了，不再赘述。 一句话总结，Type 的 Class 组件用来描述Java类或接口等原始类型和基本类型，其他几个组件描述泛型类型，包括泛型的变量、通配符以及泛型数组。 现在，来看看这几个组件的用法。 2. 参数化类型ParameterizedType 什么是参数化类型？其实就是指泛型，具体而言，JDK5推出泛型之后，原来的具体的类型可以申明为泛型，变得"可被参数化"了，比如：List 是一个具体类型，但是可以申明为 List<String>、List<Integer> ，就仿佛可以申明不同的参数，类似方法可以申明不同的参数一样（其实泛型是编译期特性，它两实际上是同一类型，都是 List，这在 Java反射之创建泛型数组 已经说过了）。 所以，ParameterizedType 用来描述泛型类型，比如：List<T>、List<String>、User<T extends Number>、List<? super User> 都可以用它来描述。ParameterizedType 的定义如下： ...

前边介绍了Java泛型类设计体系中的一些常用类，本篇将着重介绍 Array 类和如何创建泛型数组。 1. Java能创建泛型数组吗？ 1.1. 泛型类型擦除 首先，我们知道，泛型是JDK1.5推出的编译期特性，什么是编译期？即是说在编译的时候有效，编译代码时编译器能够对泛型进行检查和校验。但是如果在运行时，泛型其实已经无效了，泛型类型被擦除了。比如下面的代码： 代码清单1 List<String> stringList = new ArrayList<>(); List<Integer> integerList = new ArrayList<>(); System.out.println(stringList.getClass() == integerList.getClass()); 结果输出为 true。stringList 只能添加 String 类型的数据，而 integerList 也只能添加 Integer，不能加入别的类型的数据。为什么？因为它们申明了泛型类型，编译器就会对类型兼容性进行检查，类型不符则会抛出异常。但是，他们的 Class 确是相同的，即是说，在运行时它们是相同的类型，都是 ArrayList，而泛型类型被擦除了。 1.2. 尝试创建泛型数组 那么，我们申明泛型数组会怎么样呢？看下边的代码： 代码清单2 class GenericArray1<T> { private final T[] array; (1) private int index; public GenericArray1(int size) { this.array = (T[]) new Object[size]; (2) } public void add(T item) { (3) array[index++] = item; } public T[] array() { return array; } } ...

反射是JDK5推出的非常重要的特性，通过反射，开发者可以在运行时动态的创建类实例，获取、更改、调用类的相关信息、方法等。反射也是各大框架使用的主要技术，如知名的Spring framework框架。 本文将介绍反射的类设计体系，并配备一些简单示例来介绍反射常用API的使用，本文示例都是采用JDK1.8编写。 1. 反射类设计 Java专门为反射设计了名为java.lang.reflect包，官方API文档在这里： 反射官方文档，该包提供了一系列类共同组成反射体系。 1.1. 反射类概览 既然反射是在运行时动态描述类信息的，那么描述类信息到底是些什么东西？类信息除了类、接口、数组、枚举等常见类型的基本信息外，还包括类型中的域、方法、构造器等以及它们的修饰符（public、static、volatile、private、final、native、synchronized 等），另外，还包括方法参数和注解。反射类如下表所示： Table 1. 反射中的类 类 描述 Class 位于java.lang包，描述类、接口的运行时状态，枚举、数组也是一种类，而注解是一种特殊的接口。每一个类型都有一个Class对象与之对应 Field 描述类型中的域信息 Constructor 描述类型中的构造函数信息 Method 类型中的方法信息描述 Parameter JDK8新增，提供有关方法参数的信息，包括其名称和修饰符。它还提供了一种获取参数属性的替代方法。 Modifier 类、域、方法、构造函数等的访问修饰信息工具类 AnnotatedElement 反射获取注解的顶层接口 Type Java中的所有类型的顶层接口 Array 用于动态创建和处理数组 Proxy 动态代理的支持类 这里暂时介绍基础的Class、Field、Constructor、Method、Parameter、Modifier，其他几个类会在后续文章中单独介绍。现在，我们来看看类图的设计。 1.2. 反射类图 整个反射的类设计见下图： Figure 1. 反射类图 图中只列出了比较基础且重要的类，从图中可以看到，反射的类结构并不算复杂，顶层主要包括几个重要接口和类： AnnotatedElement: 定义了反射获取java注解的方法，如 getAnnotations() 等，实现该接口的类意味着可以获取注解信息； Member: 定义获取类成员（域、构造函数、方法）相关的标识符信息的接口，比如获取名称、标识符等； Type: 所有类型的顶层接口，用来描述java中的类型，比如泛型类型、类字节码等，包含五大组件，其中包括最重要和常见的 Class 对象，后续文章将单独介绍这个接口和其组件； GenericDeclaration: 表示泛型申明的接口，继承自 AnnotatedElement，内部定义了 getTypeParameters() 方法，用于获取类型变量(TypeVariable，该接口为 Type 接口的一个子组件)； AccessibleObject: 表示可访问对象，Field、Method 和 Constructor 对象的基类，用来检查和修改它们的访问权限：公共、包、私有访问，比如：调用其 setAccessible(boolean) 方法修改域的访问权限，然后才能修改域的值； Executable: 表示可执行的对象，其实就是方法和构造函数的基类； ...