Java开发技术栈：Java基础语法反射注解

Posted 2020-11-27 zdlynn

Java反射

定义

? Java反射机制是在运行状态中，对于任意一个类，都能够知道这个类的所有属性和方法；对于任意一个对象，都能够调用它的任意方法和属性。这种动态获取信息以及动态调用对象方法的功能称为Java语言的反射机制。

用途

? 通过反射，Java 代码可以发现有关已加载类的字段，方法和构造函数的信息，并可以在安全限制内对这些字段，方法和构造函数进行操作。

? 很多人都认为反射在实际Java中开发应用中并不广泛，其实不然。当我们在使用 IDE（如 IDEA/Eclipse）时，当我们输入一个对象或者类并调用它的属性和方法时，一按 (“.”)点号，编译器就会自动列出她的属性或方法，这里就会用到反射。反射最重要的用途就是开发各种通用框架。很多框架（比如 Spring）都是配置化的（比如Spring 通过 XML 配置模式装载 Bean），为了保证框架的通用性，他们可能根据配置文件加载不同的对象或类，调用不同的方法，这个时候就必须用到反射——运行时动态加载需要加载的对象。对于框架开发人员来说，反射作用非常大，它是各种容器实现的核心。而对于一般的开发者来说，不深入框架开发反射用的就会少一点，不过了解一下框架的底层机制有助于丰富自己的编程思想，也是很有益的。Java反射框架提供以下功能：

• 在运行时判定任意一个对象所属的类
• 在运行时构造任意一个类的对象
• 在运行时判定任意一个类所具有的成员变量和方法
• 在运行时调用任意一个对象的方法

反射的优缺点

反射的优点

使用反射机制，代码可以在运行时装配，提高了程序的灵活性和扩展性，降低耦合性，提高自适应能力。它允许程序创建和控制任何类的对象，无需硬编码目标类

反射的缺点

性能问题：使用反射基本上是一种解释操作，JVM无法对这些代码进行优化，因此，反射操作的效率要比那些非反射操作低得多。反射机制主要应用在对灵活性和扩展性要求很高的系统框架上，对性能要求高的程序中不建议使用

安全限制：使用反射技术要求程序必须在一个没有安全限制的环境中运行

内部暴露：由于反射允许代码执行一些在正常情况下不被允许的操作（比如访问私有的属性和方法），所以使用反射可能会导致意料之外的副作用——代码有功能上的错误，降低可移植性。反射代码破坏了抽象性，因此当平台发生改变的时候，代码的行为就有可能也随着变化。

反射机制的相关类

与Java反射相关的类如下：

类名 用途
Class类 代表类的实体，在运行的Java应用程序中表示类和接口
Field类 代表类的成员变量（成员变量也称为类的属性）
Method类 代表类的方法
Constructor类 代表类的构造方法

1.Class类

Class代表类的实体，在运行的Java应用程序中表示类和接口。在这个类中提供了很多有用的方法，这里对他们简单的分类介绍。

• 获得类相关的方法
  方法 用途
  asSubclass(Class clazz) 把传递的类的对象转换成代表其子类的对象
  Cast 把对象转换成代表类或是接口的对象
  getClassLoader() 获得类的加载器
  getClasses() 返回一个数组，数组中包含该类中所有公共类和接口类的对象
  getDeclaredClasses() 返回一个数组，数组中包含该类中所有类和接口类的对象
  forName(String className) 根据类名返回类的对象
  getName() 获得类的完整路径名字
  newInstance() 创建类的实例
  getPackage() 获得类的包
  getSimpleName() 获得类的名字
  getSuperclass() 获得当前类继承的父类的名字
  getInterfaces() 获得当前类实现的类或是接口
• 获得类中属性相关的方法
  方法 用途
  getField(String name) 获得某个公有的属性对象
  getFields() 获得所有公有的属性对象
  getDeclaredField(String name) 获得某个属性对象
  getDeclaredFields() 获得所有属性对象
• 获得类中注解相关的方法
  方法 用途
  getAnnotation(Class annotationClass) 返回该类中与参数类型匹配的公有注解对象
  getAnnotations() 返回该类所有的公有注解对象
  getDeclaredAnnotation(Class annotationClass) 返回该类中与参数类型匹配的所有注解对象
  getDeclaredAnnotations() 返回该类所有的注解对象
• 获得类中构造器相关的方法
  方法 用途
  getConstructor(Class…<?> parameterTypes) 获得该类中与参数类型匹配的公有构造方法
  getConstructors() 获得该类的所有公有构造方法
  getDeclaredConstructor(Class…<?> parameterTypes) 获得该类中与参数类型匹配的构造方法
  getDeclaredConstructors() 获得该类所有构造方法
• 获得类中方法相关的方法
  方法 用途
  getMethod(String name, Class…<?> parameterTypes) 获得该类某个公有的方法
  getMethods() 获得该类所有公有的方法
  getDeclaredMethod(String name, Class…<?> parameterTypes) 获得该类某个方法
  getDeclaredMethods() 获得该类所有方法
• 类中其他重要的方法
  方法 用途
  isAnnotation() 如果是注解类型则返回true
  isAnnotationPresent(Class<? extends Annotation> annotationClass) 如果是指定类型注解类型则返回true
  isAnonymousClass() 如果是匿名类则返回true
  isArray() 如果是一个数组类则返回true
  isEnum() 如果是枚举类则返回true
  isInstance(Object obj) 如果obj是该类的实例则返回true
  isInterface() 如果是接口类则返回true
  isLocalClass() 如果是局部类则返回true
  isMemberClass() 如果是内部类则返回true

2.Field类

• Field代表类的成员变量（成员变量也称为类的属性）。

  方法 用途
  equals(Object obj) 属性与obj相等则返回true
  get(Object obj) 获得obj中对应的属性值
  set(Object obj, Object value) 设置obj中对应属性值

3.Method类

• 代表类的方法。

  方法 用途
  invoke(Object obj, Object… args) 传递object对象及参数调用该对象对应的方法

4.Constructor类

• Constructor代表类的构造方法。

  方法 用途
  newInstance(Object… initargs) 根据传递的参数创建类的对象

通过反射获取后三者，即私有属性，方法和构造方法时，需要进行暴力反射，设置setAccessible(true)。否则会报错说无法获取私有属性，方法和构造方法

Java注解

为什么要引入注解？

? 使用【注解】之前(甚至在使用之后)，【XML】被广泛的应用于描述元数据，得到各大框架的青睐，它以松耦合的方式完成了框架中几乎所有的配置，但是随着项目越来越庞大，【XML】的内容也越来越复杂，一些应用开发人员和架构师发现维护成本变高。他们希望使用一些和代码紧耦合的东西，于是就有人提出来一种标记式高耦合的配置方式【注解】。方法上可以进行注解，类上也可以注解，字段属性上也可以注解，反正几乎需要配置的地方都可以进行注解。下面我们通过一个例子来理解这两者的区别。

? 假如你想为应用设置很多的常量或参数，这种情况下，【XML】是一个很好的选择，因为它不会同特定的代码耦合。如果你想把某个方法声明为服务，那么使用【注解】会更好一些，因为这种情况下需要注解和方法紧密耦合起来，开发人员也必须认识到这点。同时，【注解】定义了一种标准的描述元数据的方式。

? 关于【注解】和【XML】两种不同的配置模式，争论了好多年，各有各的优劣，注解可以提供更大的便捷性，易于维护修改，但耦合度高，而 【XML】 相对于注解则是相反的。追求低耦合就要抛弃高效率，追求效率必然会遇到耦合。目前，许多框架将【XML】和【注解】两种方式结合使用，平衡两者之间的利弊。

什么是注解

? 注解也叫元数据，即一种描述数据的数据。例如我们常见的@Override和@Deprecated，注解是JDK1.5版本开始引入的一个特性，用于对代码进行说明，可以对包、类、接口、字段、方法参数、局部变量等进行注解。Annotation接口中有下面这句话来描述注解：Annotation 是所有注解继承的公共接口

? The common interface extended by all annotation types.注解的本质就是一个继承了 Annotation 接口的接口。有关这一点，你可以去反编译任意一个注解类得到结果。一个注解准确意义上来说，只不过是一种特殊的注释而已，如果没有解析它的代码，它可能连注释都不如。而解析一个类或者方法的注解往往有两种形式，一种是编译期直接的扫描，一种是运行期反射。反射的事情我们先不讨论，而编译器的扫描指的是编译器在对 Java 代码编译成字节码的过程中会检测到某个类或者方法被一些注解修饰，这时它就会对于这些注解进行某些处理。

@Override
public String toString() {
    return "Hello Annotation";
}

? 上面的代码中，我重写了toString()方法并使用了@Override注解。但是，即使我不使用@Override注解标记代码，程序也能够正常执行。那么，该注解表示什么？这么写有什么好处吗？事实上，@Override告诉编译器这个方法是一个重写方法(描述方法的元数据)，如果父类中不存在该方法，编译器便会报错，提示该方法没有重写父类中的方法。如果我不小心拼写错误，例如将toString()写成了toStrring()，而且我也没有使用@Override注解，那程序依然能编译运行。但运行结果会和我期望的大不相同。现在我们了解了什么是注解，并且使用注解有助于提高代码的可读性。

注解的用途

• 生成文档，通过代码里标识的元数据生成javadoc文档。
• 编译检查，通过代码里标识的元数据让编译器在编译期间进行检查验证。
• 编译时动态处理，编译时通过代码里标识的元数据动态处理，例如动态生成代码。
• 运行时动态处理，运行时通过代码里标识的元数据动态处理，例如使用反射注入实例

注解的分类

• Java自带的标准注解，包括@Override（标明重写某个方法）、@Deprecated（标明某个类或方法过时）和@SuppressWarnings（标明要忽略的警告），使用这些注解后编译器就会进行检查

• 自定义注解，可以根据自己的需求定义注解

• 元注解，元注解是用于定义注解的注解，包括@Retention（标明注解被保留的阶段）、@Target（标明注解使用的范围）、@Inherited（标明注解可继承）、@Documented（标明是否生成javadoc文档）

  元注解具体介绍

  要想真正掌握怎么使用注解，还需要先学习一下元注解。

  元注解是用于修饰注解的注解

  元注解有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 种。

  @Retention

  Retention 的英文意为保留期的意思。当 @Retention 应用到一个注解上的时候，它解释说明了这个注解的的存活时间。它的取值如下：

  • RetentionPolicy.SOURCE 注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视。
  • RetentionPolicy.CLASS 注解只被保留到编译进行的时候，它并不会被加载到 JVM 中。如Java内置注解，@Override、@Deprecated、@SuppressWarnning等
  • RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候，它会被加载进入到 JVM 中，所以在程序运行时可以获取到它们。如SpringMvc中的@Controller、@Autowired、@RequestMapping等。

  @Documented

  顾名思义，这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去。

  @Target

  Target 是目标的意思，@Target 指定了注解运用的地方。

  你可以这样理解，当一个注解被 @Target 注解时，这个注解就被限定了运用的场景。类比到标签，原本标签是你想张贴到哪个地方就到哪个地方，但是因为 @Target 的存在，它张贴的地方就非常具体了，比如只能张贴到方法上、类上、方法参数上等等。@Target 有下面的取值

  • ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
  • ElementType.CONSTRUCTOR 可以给构造方法进行注解
  • ElementType.FIELD 可以给属性进行注解
  • ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
  • ElementType.METHOD 可以给方法进行注解
  • ElementType.PACKAGE 可以给一个包进行注解
  • ElementType.PARAMETER 可以给一个方法内的参数进行注解
  • ElementType.TYPE 可以给一个类型进行注解，比如类、接口、枚举

  @Inherited

  Inherited 是继承的意思，但是它并不是说注解本身可以继承，而是说如果一个超类使用了@Inherited 注解，那么如果它的子类没有被任何注解应用的话，那么这个子类就继承了超类的注解。

  @Repeatable

  Repeatable 自然是可重复的意思。@Repeatable 是 Java 1.8 才加进来的，所以算是一个新的特性。

  Repeatable使用场景：在需要对同一种注解多次使用时，往往需要借助@Repeatable。

注解的属性

? 注解的属性也叫做成员变量。注解只有成员变量，没有方法。注解的成员变量在注解的定义中以“无形参的方法”形式来声明，其方法名定义了该成员变量的名字，其返回值定义了该成员变量的类型。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation{
int id();
String msg();
}

? 上面代码定义了 @TestAnnotation 这个注解中拥有 id 和 msg 两个属性。在使用的时候，我们应该给它们进行赋值。赋值的方式是在注解的括号内以 value="" 形式，多个属性之前用 ，隔开。

@TestAnnotation(id=3, msg="hello annotation")
public class Test {
}

快捷方式

? 所谓的快捷方式就是注解中定义了名为value的元素，并且在使用该注解时，如果该元素是唯一需要赋值的一个元素，那么此时无需使用key=value的语法，而只需在括号内给出value元素所需的值即可。这可以应用于任何合法类型的元素，记住，这限制了元素名必须为value，简单案例如下

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface IntegerVaule{
   int value() default 0;
   String name() default "";
}

public class QuicklyWay {

   @IntegerVaule(20)
   public int age;

   @IntegerVaule(value = 10000, name = "MONEY")
   public int money;

}

注解不支持继承

注解是不支持继承的，因此不能使用关键字extends来继承某个@interface，但注解在编译后，编译器会自动继承java.lang.annotation.Annotation接口

声明注解

这里总共定义了4个注解来演示注解的声明

1. 定义一个可以注解在Class，interface，enum上的注解
2. 定义一个可以注解在METHOD上的注解
3. 定义一个可以注解在FIELD上的注解
4. 定义一个可以注解在PARAMETER上的注解

Java预置的注解

学习了上面相关的知识，我们已经可以自己定义一个注解了。其实 Java 语言本身已经提供了几个现成的注解。

@Deprecated

这个元素是用来标记过时的元素，想必大家在日常开发中经常碰到。编译器在编译阶段遇到这个注解时会发出提醒警告，告诉开发者正在调用一个过时的元素比如过时的方法、过时的类、过时的成员变量。

@Override

这个大家应该很熟悉了，用于标明此方法覆盖了父类的方法。

@SuppressWarnings

用于有选择的关闭编译器对类、方法、成员变量、变量初始化的警告。之前说过调用被 @Deprecated 注解的方法后，编译器会警告提醒，而有时候开发者会忽略这种警告，他们可以在调用的地方通过 @SuppressWarnings 达到目的。

@SafeVarargs

参数安全类型注解。它的目的是提醒开发者不要用参数做一些不安全的操作，它的存在会阻止编译器产生 unchecked 这样的警告。它是在 Java 1.7 的版本中加入的。

@FunctionalInterface

函数式接口注解，这个是 Java 1.8 版本引入的新特性。函数式编程很火，所以 Java 8 也及时添加了这个特性。函数式接口 (Functional Interface) 就是一个具有一个方法的普通接口。我们进行线程开发中常用的 Runnable 就是一个典型的函数式接口，从源码可以看到它使用了@FunctionalInterface 注解。

------------恢复内容结束------------