注解与反射详解通俗易懂

一、注解–Java.Annotation

1、什么是注解

• Annotation是JDK5引入的技术
• Annotation的作用：
  • 不是程序本身，但可以对程序作出解释（这一点与注释（comment）没区别）
  • 可以被其他程序（比如：编译器等）读取
• Annotation的格式
  • 注解是以“@注解名”在代码中存在的，还可以添加一些参数值
  • 例如： @SuppressWarnings（value=“unchecked”）
• Annotation在哪里使用
  • 可以附加在package、class、method、field等上面，相当于个他们添加了额外的辅助信息
  • 我们可以通过反射机制编译实现对这些元数据的访问

// 什么是注解
public class Test1 extends Object {
    
    // @Override 重写的注解
    @Override
    public String toString() {
        return super.toString();
    }
}

2、内置注解

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

import java.util.ArrayList;
import java.util.List;

// 什么是注解
public class Test1 extends Object {

    // @Override 重写的注解
    @Override
    public String toString() {
        return super.toString();
    }

    // @Deprecated 不推荐使用
    @Deprecated
    public static void test(){
        System.out.println("Deprecated");
    }

    // 不建议镇压警告
    @SuppressWarnings("all")
    public void test2(){
        List list = new ArrayList();
    }

    public static void main(String[] args) {
        test();
    }
}

3、元注解

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

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

// 测试元注解
@MyAnnotation
public class Test2 {
    public void test(){

    }
}

// 定义一个注解
// Target表示我们的注解可以用在哪个地方
@Target(value = {ElementType.METHOD,ElementType.TYPE})
// Retention表示我们的注解在那个地方还有效
@Retention(value = RetentionPolicy.RUNTIME)
@interface MyAnnotation {

}

4、自定义注解

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

• @interface用来声明一个注解，
  • 格式： public @interface 注解名{定义内容}
• 其中的每一个方法实际上是声明了一个配置参数
• 方法的名称就是参数的名称
• 返回值类型就是参数的类型（返回值只能是基本类型，Class、String、enum）
• 可以通过default来声明参数的默认值
• 若只有一个参数成员，一般参数名为value
• 注解元素必须要有值，我们定义注解元素时，经常使用空字符串0作为默认值

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

// 自定义注解
public class Test3 {
    // 注解可以显示赋值，若没有默认值则必须赋值
    @MyAnnotation2(name = "KS",schools = {"清，北"})
    public void test(){}

    @MyAnnotation3("耳冉")
    public void test2(){}
}

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2 {
    // 注解的参数： 参数类型+参数名();
    String name();
    int age() default 0;
    int id() default -1; //若默认值为-1.则代表不存在
    String[] schools() default {"家里蹲"};
}

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation3 {
    // 当参数名为value时， 可在注解中省略参数名
    String value();
}

二、反射机制–Java.Reflection

1、Java反射机制概述

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

正常方式： 引入需要的“包类”名称——>通过new实例化——>取得实例化对象

反射方式： 实例化对象——>getClass()方法——>得到完整的“包类”名称

Java反射机制提供的功能

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

Java反射优点和缺点

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

反射相关的主要API

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

2、获得反射对象

// 什么是反射
public class Test {
    public static void main(String[] args) throws ClassNotFoundException {
        // 通过反射机制获得类的Class对象
        Class c1 = Class.forName("KS.Reflection.User");
        System.out.println(c1);

        Class c2 = Class.forName("KS.Reflection.User");
        Class c3 = Class.forName("KS.Reflection.User");
        // 若hashCode一样 则说明是一个类
        // 一个类在内存中只有一个class对象
        // 一个类被加载后，类的整个结构都会被封装在class对象中
        System.out.println(c2.hashCode());
        System.out.println(c3.hashCode());
    }
}
// 实体类 pojo entity
class User{}

三、Class类

1、创建Class类

对于每个类而言，JRE都为其保留一个不变的Class类型的对象。

一个Class对象包含了特定某个结构（class\interface\enum\annotation等）的有关信息

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

获取Class类的实例

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

// 测试Class类的创建方式有哪些
public class Test2 {
    public static void main(String[] args) throws ClassNotFoundException {
        Person person = new Student();
        System.out.println("这是" + person.name);

        // 方式一：通过对象获得
        Class c1 = person.getClass();
        System.out.println(c1.hashCode()); // 284720968
        // 方式二：forName获得
        Class c2 = Class.forName("KS.Reflection.Student");
        System.out.println(c2.hashCode()); // 284720968
        // 方式三：通过类名.class
//        Class<Student> c3 = Student.class;
        Class c3 = Student.class;
        System.out.println(c3.hashCode()); // 284720968
        // 方式四：基本内置类型的包装类都有一个Type属性
        Class<Integer> c4 = Integer.TYPE;
        System.out.println(c4);
        // 获得父类类型 --Person
        Class c5 = c1.getSuperclass();
        System.out.println(c5);
        System.out.println(c5.hashCode()); // 1915910607
        System.out.println(Person.class.hashCode()); // 1915910607
    }
}

class Person {
    String name;

    public Person(String name) {
        this.name = name;
    }

    public Person() {
    }

    public String getName() {
        return name;
    }

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

class Student extends Person {
    public Student() {
        this.name = "学生";
    }
}

class Teacher extends Person {
    public Teacher() {
        this.name = "教师";
    }
}

2、所有类型的Class对象

import java.lang.annotation.ElementType;

// 所有类型的Class
public class Test3 {
    public static void main(String[] args) {
        Class c1 = Object.class; // 类               --class
        Class c2 = Comparable.class; // 接口          --interface
        Class c3 = String[].class; // 一维数组        --class
        Class c4 = int[][].class; // 二维数组         --class
        Class c5 = Override.class; // 注解            --interface
        Class c6 = ElementType.class; // 枚举         --class
        Class c7 = Integer.class; // 基本数据类型      --class
        Class c8 = void.class; // void                --void
        Class c9 = Class.class; // Class              --class
        // Alt+左键 多行复制
        System.out.println(c1);
        System.out.println(c2);
        System.out.println(c3);
        System.out.println(c4);
        System.out.println(c5);
        System.out.println(c6);
        System.out.println(c7);
        System.out.println(c8);
        System.out.println(c9);

        // 元素类型与维度一致，则为同一个Class
        int[] a = new int[10];
        int[] b = new int[100];
        System.out.println(a.getClass().hashCode());
        System.out.println(b.getClass().hashCode());
    }
}

3、Java内存分析

类的加载过程

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

1. 类的加载（Load）：将类的class文件读入内存，并为之创建一个java.lang.Class对象，此过程由类加载器完成
2. 类的链接（Link）：将类的二进制数据合并到JRE中
3. 类的初始化（Initialize）：JVM负责对类进行初始化

类的加载与ClassLoader的理解

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

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

        /* 过程：
        * 1、 加载到内存，会产生一个类对应class对象
        * 2、 链接， 链接结束后 m = 0
        * 3、 初始化
        *   <clinit>(){
        *       System.out.println("A类静态代码块初始化");
        *       m = 300;
        *       m = 100;
        *   }
        *   m = 100
        * */
    }
}
class A {
    static{
        System.out.println("A类静态代码块初始化");
        m =300;
    }
    static int m = 100;

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

}

4、类加载器

public class Test5 {
    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++) 无法加载到 输出为null
        ClassLoader parent1 = parent.getParent();
        System.out.println(parent1);

        // 测试当前类是哪个加载器加载
        ClassLoader classLoader = Class.forName("KS.Reflection.Test5").getClassLoader();
        System.out.println(classLoader);
        classLoader = Class.forName("java.lang.Object").getClassLoader();
        System.out.println(classLoader); // null

        // 如何获得系统类加载器可以加载的路径
        System.out.println(System.getProperty("java.class.path"));
        // E:\idea\IntelliJ IDEA Community Edition 2019.3.1\IdeaProjects\untitled\out\production\耳冉

        // 双亲委派机制 保证安全性
    }
}

5、获取类的运行时结构

import java.lang.reflect.Field;

public class Test6 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException {
        Class c1 = Class.forName("KS.Reflection.User");

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

        // 获得类的属性
        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);

    }
}

6、动态创建对象执行方法

创建类的对象：调用Class对象的newInstance()方法

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

若没有无参构造器：

1. 通过Class类的getDeclaredConstructor(Class … parameterTypes)取得本类的指定形参类型的构造器
2. 向构造器的形参中传递一个对象数组进去，里面包含了构造器中所需的各个参数
3. 通过Constructor实例化对象

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

// 通过反射动态创建对象
public class Test7 {
    public static void main(String[] args) throws ClassNotFoundException, IllegalAccessException, InstantiationException, NoSuchMethodException, InvocationTargetException, NoSuchFieldException {
        // 获得class对象
        Class c1 = Class.forName("KS.Reflection.User");
        // 构造一个对象
        User user = (User) c1.newInstance(); // 本质是调用类的无参构造器
        System.out.println(user);

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

        // 通过反射调用普通方法
        User user3 = (User) c1.newInstance();
        // 通过反射获取一个方法
        Method setName = c1.getDeclaredMethod("setName", String.class);
        // invoke 激活 （对象，“方法的值”）
        setName.invoke(user3, "User");
        System.out.println(user3.getName());

        // 通过反射操作属性
        User user4 = (User) c1.newInstance();
        Field name = c1.getDeclaredField("name");
        // 不能直接操作私有熟悉，我们需要关闭程序的安全监测，实现或方法的setAccessible(true)
        name.setAccessible(true);
        name.set(user4, "User2");
        System.out.println(user4.getName());
    }
}

调用指定的方法
通过反射，调用类中的方法，通过Method类完成

1. 通过Class类的getMethod(String name，Class … parameterTypes)方法取得一个Method对象，并设置此方法操作时所需要的的参数类型
2. 使用Object invoke(Object obj,object[] args)进行调用，并向方法中传递要设置的obj对象的参数信息

setAccessible

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

四、性能对比分析

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

// 分析性能问题
public class Test8 {

    // 普通方法调用
    public static void test01(){
        User user = new User();
        long startTime = System.currentTimeMillis();
        for (int i = 0; i < 100000000; i++) {
            user.getName();
        }
        long endTime = System.currentTimeMillis();

        System.out.println("普通执行时间：" + (endTime - startTime) + "ms");
    }
    // 反射方法调用
    public static void test02() throws NoSuchMethodException, InvocationTargetException, IllegalAccessException {
        User user = new User();
        Class c1 = user.getClass();

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

        long startTime = System.currentTimeMillis();
        for (int i = 0; i < 100000000; i++) {
            getName.invoke(user, null);
        }
        long endTime = System.currentTimeMillis();

        System.out.println("反射执行时间：" + (endTime - startTime) + "ms");
    }
    // 反射方法调用 关闭检测
    public static void test03() throws NoSuchMethodException, InvocationTargetException, IllegalAccessException {
        User user = new User();
        Class c1 = user.getClass();

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

        long startTime = System.currentTimeMillis();
        for (int i = 0; i < 100000000; i++) {
            getName.invoke(user, null);
        }
        long endTime = System.currentTimeMillis();

        System.out.println("反射执行时间：" + (endTime - startTime) + "ms");
    }

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