阿里P8教你Java注解与反射

Ⅰ 什么是注解

Java 注解（Annotation）又称 Java 标注，是 JDK5.0 引入的一种注释机制。 Java 语言中的类、方法、变量、参数和包等都可以被标注。和 Javadoc 不同，Java 标注可以通过反射获取标注内容。在编译器生成类文件时，标注可以被嵌入到字节码中。Java 虚拟机可以保留标注内容，在运行时可以获取到标注内容 。 当然它也支持自定义 Java 标注。

注解以@注解名的形式存在于代码中，例如@Override，还可以添加一些参数值，例如@Auth(value = "super")。

Ⅱ 内置注解

Java 有10个内置 注解，6个注解是作用在代码上的，4个注解是负责注解其他注解的(即元注解)，元注解提供对其他注解的类型说明。

注解	作用	作用范围
@Override	检查该方法是否是重写方法。如果发现其父类，或者是引用的接口中并没有该方法时，会报编译错误。	作用在代码上
@Deprecated	标记表示过时的，不推荐使用。可以用于修饰方法，属性，类。如果使用被此注解修饰的方法，属性或类，会报编译警告。	作用在代码上
@SuppressWarnings	指示编译器去忽略注解中声明的警告。	作用在代码上
@SafeVarargs	Java 7 开始支持，忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。	作用在代码上
@FunctionalInterface	Java 8 开始支持，标识一个匿名函数或函数式接口。	作用在代码上
@Repeatable	Java 8 开始支持，标识某注解可以在同一个声明上使用多次。	作用在代码上
@Retention	标识这个注解怎么保存，是只在代码中，还是编入class文件中，或者是在运行时可以通过反射访问。包含关系runtime>class>source。	作用在其他注解上，即元注解
@Documented	标记这些注解是否包含在用户文档中。	作用在其他注解上，即元注解
@Target	标记某个注解的使用范围，例如作用方法上，类上，属性上等等。	作用在其他注解上，即元注解
@Inherited	说明子类可以集成父类中的此注解，默认注解并没有继承于任何子类	作用在其他注解上，即元注解

Ⅲ 自定义注解

使用@interface在这里插入代码片定义注解，而且自动继承java.lang.annotation.Annotation接口。

• 格式为 public @interface 注解名 {定义内容}
• 其中每一个方法实际是声明了一个参数
• 方法的名称就是参数的名称
• 返回值类型就是参数的类型，而且返回值类型只能是基本类型，Class，String，enum。
• 可以通过default关键字来声明参数的默认值，一般会使用空字符串或者0
• 如果只有一个参数，一般参数名为value，而且使用注解时，赋值可以不显示写出参数名，直接写参数值
• 定义了参数，如果没有默认值，就一定要显示赋值

Ⅳ 注解案例

import java.lang.annotation.*;

/**
 * @author Mr.nobody
 * @Description 自定义注解
 * @date 2020/8/30
 */
@Target(ElementType.METHOD) // 此注解只能用在方法上。
@Retention(RetentionPolicy.RUNTIME) // 此注解保存在运行时，可以通过反射访问。
@Inherited // 说明子类可以集成父类中的此注解。
@Documented // 此注解包含在用户文档中。
public @interface CustomAnnotation {
    String value(); // 使用时需要显示赋值
    int id() default 0; // 有默认值，使用时可以不赋值
}

/**
 * @author Mr.nobody
 * @Description 测试注解
 * @date 2020/8/30
 */
public class TestAnnotation {

    // @CustomAnnotation(value = "test") 只能注解在方法上，这里会报错
    private String str = "Hello World!";

    @CustomAnnotation(value = "test")
    public static void main(String[] args) {
        System.out.println(str);
    }
}

Ⅴ Java 反射机制

讲解反射前，我们先来谈谈静态语言和动态语言。

动态语言是一类在运行时可以改变其结构的语言。例如新的函数，对象，甚至代码可以被引进，已有的函数可以被删除或者结构上的一些变化。简单说即是在运行时代码可以根据某些条件改变自身结构。动态语言主要C#，Object-C，JavaScript，PHP，Python等。

静态语言是运行时结构不可改变的，例如Java，C，C++等。

Java不是动态语言，但是她可以称为准动态语言，因为Java可以利用反射机制获得类似动态语言的特性，Java的动态性让它在编程时更加灵活。

反射机制允许程序在执行期借助于Reflection API取得任何类的内部信息，并能直接操作任意对象的内部属性以及方法等。 类在被加载完之后，会在堆内存的方法区中生成一个Class类型的对象，一个类只有一个Class对象，这个对象包含了类的结构信息。我们可以通过这个对象看到类的结构。 例如可以通过如下方法获取String类的Class对象：Class c = Class.forName("java.lang.String"); 当然，每个类都隐式继承Object类，Object类有个getClass()方法也能获取Class对象。

5.1 Java反射机制提供的功能

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

5.2 Java反射机制的优缺点

• 优点：实现动态创建对象和编译，有更加的灵活性。
• 缺点：对性能有影响。使用反射基本上是一种解释操作，我们可以告诉JVM，我们想要做什么然后它满足我们的要求，这类操作总是慢于直接执行相同的操作。

5.3 Java反射相关的主要API

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

5.4 Class类

通过Class对象可以得知某个类的属性，方法，构造器，注解，以及实现了哪些接口等等信息。对于每个类而言，JRE都为其保留一个不变的Class类型的对象。一个Class对象包含了特定的结构（class，interface，enum，annotation，private type，void，[]）的有关信息。

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

Class类的常用方法：

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

获取运行时类的完整结构

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

1. Field
2. Method
3. Constructor
4. Superclass
5. Interface
6. Annatation
7. ...

调用指定的方法：Object invoke(Object obj, Object ... args)

• 第一个Object对应原方法的返回值，若原方法无返回值，则返回null
• 若原方法为静态方法，则参数obj可为null
• 若原方法形参列表为空，则参数args为null
• 若原方法声明为private，则调用invoke方法前，需要显示调用方法对象的setAccessible(true)方法，才可访问private方法。

package com.nobody;

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

/**
 * @author Mr.nobody
 * @Description
 * @date 2020/9/4
 */
public class Test01 {

    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException, NoSuchMethodException, IllegalAccessException, InstantiationException, InvocationTargetException {
        Class aClass = Class.forName("com.nobody.Student");

        System.out.println(aClass.getName());
        System.out.println(aClass.getSimpleName());

        System.out.println("-----------------------");
        System.out.println("获取public的属性");
        Field[] fields = aClass.getFields();
        for (Field field : fields) {
            System.out.println(field);
        }

        System.out.println("-----------------------");
        System.out.println("获取全部的属性");
        Field[] declaredFields = aClass.getDeclaredFields();
        for (Field declaredField : declaredFields) {
            System.out.println(declaredField);
        }

        System.out.println("-----------------------");
        System.out.println("获取指定名称的属性");
        Field name = aClass.getDeclaredField("name");
        System.out.println(name);

        System.out.println("-----------------------");
        System.out.println("获取本类和父类的全部public方法");
        Method[] methods = aClass.getMethods();
        for (Method method : methods) {
            System.out.println(method);
        }

        System.out.println("-----------------------");
        System.out.println("获取本类的方法");
        Method[] declaredMethods = aClass.getDeclaredMethods();
        for (Method declaredMethod : declaredMethods) {
            System.out.println(declaredMethod);
        }

        System.out.println("-----------------------");
        System.out.println("获得指定名字的方法");
        Method getName = aClass.getDeclaredMethod("getName");
        System.out.println(getName);
        Method setName = aClass.getDeclaredMethod("setName", String.class);
        System.out.println(setName);

        System.out.println("-----------------------");
        System.out.println("获得构造器");
        Constructor[] declaredConstructors = aClass.getDeclaredConstructors();
        for (Constructor declaredConstructor : declaredConstructors) {
            System.out.println(declaredConstructor);
        }

        System.out.println("-----------------------");
        System.out.println("获取指定的构造器");
        Constructor declaredConstructor = aClass.getDeclaredConstructor(String.class, int.class);
        System.out.println(declaredConstructor);

        System.out.println("-----------------------");
        System.out.println("生成类的实例");
        Student student = (Student) aClass.newInstance();
        Student student1 = (Student) declaredConstructor.newInstance("小明", 20);
        System.out.println(student);
        System.out.println(student1);

        System.out.println("-----------------------");
        System.out.println("调用实例的方法");
        setName.invoke(student, "小花");
        System.out.println(student);

        System.out.println("-----------------------");
        System.out.println("使用实例的属性");
        name.setAccessible(true); // 因为student的name变量是私有的，所以要加此行代码，关闭安全检测
        name.set(student, "小红");
        System.out.println(student);
    }

}

class Student {

    private String name;

    public int age;

    public String getName() {
        return name;
    }

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

    private void testMethod01() {

    }

    public Student() {
    }

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

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

输出结果：

com.nobody.Student
Student
-----------------------
获取public的属性
public int com.nobody.Student.age
-----------------------
获取全部的属性
private java.lang.String com.nobody.Student.name
public int com.nobody.Student.age
-----------------------
获取指定名称的属性
private java.lang.String com.nobody.Student.name
-----------------------
获取本类和父类的全部public方法
public java.lang.String com.nobody.Student.toString()
public java.lang.String com.nobody.Student.getName()
public void com.nobody.Student.setName(java.lang.String)
public final void java.lang.Object.wait() throws java.lang.InterruptedException
public final void java.lang.Object.wait(long,int) throws java.lang.InterruptedException
public final native void java.lang.Object.wait(long) throws java.lang.InterruptedException
public boolean java.lang.Object.equals(java.lang.Object)
public native int java.lang.Object.hashCode()
public final native java.lang.Class java.lang.Object.getClass()
public final native void java.lang.Object.notify()
public final native void java.lang.Object.notifyAll()
-----------------------
获取本类的方法
public java.lang.String com.nobody.Student.toString()
public java.lang.String com.nobody.Student.getName()
public void com.nobody.Student.setName(java.lang.String)
private void com.nobody.Student.testMethod01()
-----------------------
获得指定名字的方法
public java.lang.String com.nobody.Student.getName()
public void com.nobody.Student.setName(java.lang.String)
-----------------------
获得构造器
public com.nobody.Student()
public com.nobody.Student(java.lang.String,int)
-----------------------
获取指定的构造器
public com.nobody.Student(java.lang.String,int)
-----------------------
生成类的实例
Student{name='null', age=0}
Student{name='小明', age=20}
-----------------------
调用实例的方法
Student{name='小花', age=0}
-----------------------
使用实例的属性
Student{name='小红', age=0}

获取Class类的实例

1. 若已知具体的类，可通过class属性获取，此方法最为安全可靠，程序性能最高。Class clazz = User.class;
2. 若已知某个类的实例，可调用此实例的getClass()方法获取。Class clazz = user.getClass();
3. 若已知一个类的全类名，且此类在类路径下，可通过Class类的静态方法forName()方法获取，可能会抛出ClassNotFoundException。Class clazz = Class.forName("com.nobody.User");
4. 内置基本数据类型可以直接通过类名.Type获取
5. 可以通过ClassLoader获取

package com.nobody;

/**
 * @author Mr.nobody
 * @Description
 * @date 2020/9/2
 */
public class User extends Person {

    private String name;

    public static void main(String[] args) throws ClassNotFoundException {

        User user = new User();

        Class userClass = User.class;
        Class aClass = user.getClass();
        Class aClass1 = Class.forName("com.nobody.User");

        System.out.println(userClass.hashCode());
        System.out.println(aClass.hashCode());
        System.out.println(aClass1.hashCode());

        Class superclass = userClass.getSuperclass();
        System.out.println(superclass);

        Class type = Integer.TYPE;
        System.out.println(type);

    }
}

class Person {

}

输出结果：

685325104
685325104
685325104
class com.nobody.Person
int
复制代码

有Class对象的类型

1. class：外部类，成员（成员内部类，静态内部类），局部内部类，匿名内部类。
2. interface：接口
3. []：数组
4. enum：枚举
5. annotation：注解
6. primitive type：基本数据类型（例如Integer，Double等）
7. void：空类型

package com.nobody;

import java.lang.annotation.Documented;
import java.util.List;

/**
 * @author Mr.nobody
 * @Description
 * @date 2020/9/2
 */
public class ClassTest {

    public static void main(String[] args) {
        Class