Java注解和反射

本文最后更新于:1 分钟前

注解

注解入门

注解的作用:

  • 不是程序本身,可以对程序作出解释
  • 可以被其他程序(如编译器)读取

注解的格式:@ + 注释名 + [参数值]

使用的地方:在package,class,method,field等上面,相当于给他们添加额外的辅助信息,可以通过反射机制变成实现对这些源数据的访问

内置注解

@Override

重写

image-20220226164816918

@Deprecated

不推荐使用,但可以使用,或者有更推荐的代替方法

image-20220226164830172

@SuppressWarnings

镇压警告

image-20220226165411836

image-20220226165137822

元注解

package xyz.qiuqian;

import java.lang.annotation.*;

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

    }
}

// 定义一个注解
// Target 表示注解可以用在哪些地方
@Target(value = {ElementType.METHOD, ElementType.TYPE})
// 表示注解在什么地方有效 源码 class 运行时
// runtime > class > sources
@Retention(value = RetentionPolicy.RUNTIME)
// 是否将注解生成早javadoc中
@Documented
// 子类可以继承父类的注解
@Inherited
@interface MyAnnotation {

}

负责注解其他注解,Java 定义了四个标准的元注解类型,被用来提供对其他annotation类型作说明

  • @Target:注解在什么地方使用

    image-20220226170545983

    image-20220226170555076

  • @Retention:表示需要在什么级别保存注解信息,用于描述注解的生命周期

    image-20220226170435380

  • @Document:说明该注解被包含在javadoc中

  • @Inherited:说明子类可以继承父类中的该注解

自定义注解

使用 @interface ,自动继承 java.lang.annotation.Annotation 接口

  • @interface 声明一个注解
  • 其中的每一个方法实际上是声明了一个配置参数
  • 方法的名称就是参数的名称
  • 返回值类型就是参数的类型(Class,String,enum)
  • 可以通过 default 来声明参数的默认值
  • 如果只有一个参数成员,一般参数名为 value
  • 注解元素必须要有值,我们定义注解元素时,经常使用空字符串,0作为默认值
package xyz.qiuqian;

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

// 自定义注解
public class Test03 {

    //
    @MyAnnotation2( hobby = {"one", "two"} )
    public void test() {}

    @MyAnnotation3("test")
    public void test2() {

    }

}

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2 {
    // 注解的参数: 参数类型 + 参数名()
    // 可以显式赋值,如果没有默认值,需要个给注解赋值
    String name() default "";

    int age() default 18;

    // 默认值为-1代表不存在
    int id() default -1;

    String[] hobby();
}

@interface MyAnnotation3 {
    String value();
}

反射

概述

动态语言:在运行时可以改变其结构的语言,如新的函数,对象,甚至代码都可以被引进,已有的函数可以被删除或是其他结构上的变化。主要动态语言:OC, C#,JS,PHP,Py等

静态语言:运行时结构不可变的语言,如Java,C,C++。

Java不是动态语言,但是可以称为准动态语言。因为Java有一定的动态性。可以利用反射机制获取类似动态语言的特性。Java的动态性让编程更加灵活。

反射是Java动态语言的管家,反射机制允许程序在执行期间借助 Reflection API 获取任何类的内部信息,并能直接操作任意对象的内部属性和方法。

加载完类之后,在堆内存的方法区中就产生了一个Class类型的对象(一个类只有一个Class对象),这个对象就包含了完整的类的结构信息。我们可以通过这个对象看到类的结构。这个对象就像镜子,透过这个镜子看到类的结构。

反射机制提供的功能:

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

优点:

  • 可以实现动态创建对象和编译,体现很大的灵活性。

缺点:

  • 对性能有一定影响。使用反射基本上是一种解释操作,我们可以告诉JVM,我们希望做什么并且他满足我们的要求。这类操作总是慢于直接执行想通的操作。

主要API:

  • Method:类的方法
  • Field: 类的成员变量
  • Constructor: 类的构造器

Class类:

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

类的加载与ClassLoader的理解

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

什么时候会发生类初始化?

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

// 类什么时候会初始化
public class Test05 {
    static {
        System.out.println("Main类被加载");
    }
    public static void main(String[] args) throws ClassNotFoundException {
        // 主动引用 父类没有被加载,会先加载父类
//        Son son = new Son();

        // 反射也会产生主动引用
//        Class c1 = Class.forName("xyz.qiuqian.reflection.Son");


        // 不会产生类的引用的方法
//        System.out.println(Son.b); // 子类不会被加载

//        Son[] array = new Son[5]; // 只有Main类被加载

        System.out.println(Son.M); // 常量不会引起父类子类初始化
    }
}

class Father {
    static int b = 2;
    static {
        System.out.println("父类被加载");
    }
}

class Son extends Father {
    static {
        System.out.println("子类被加载");
    }

    static int m = 100;
    static final int M = 1;
}

类加载器的作用

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

public class Test06 {
    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("xyz.qiuqian.reflection.Test06").getClassLoader();
        System.out.println(classLoader);

        // 测试jdk内置类由谁加载
        ClassLoader classLoader2 = Class.forName("java.lang.Object").getClassLoader();
        System.out.println(classLoader);

        // 如何获得系统类加载器可以加载的路径
        String property = System.getProperty("java.class.path");
        System.out.println(property);

        /**
         * /Library/Java/JavaVirtualMachines/jdk1.8.0_311.jdk/Contents/Home/jre/lib/charsets.jar:
         * /Library/Java/JavaVirtualMachines/jdk1.8.0_311.jdk/Contents/Home/jre/lib/deploy.jar:
         * /Library/Java/JavaVirtualMachines/jdk1.8.0_311.jdk/Contents/Home/jre/lib/ext/cldrdata.jar:
         * /Library/Java/JavaVirtualMachines/jdk1.8.0_311.jdk/Contents/Home/jre/lib/ext/dnsns.jar:
         * /Library/Java/JavaVirtualMachines/jdk1.8.0_311.jdk/Contents/Home/jre/lib/ext/jaccess.jar:
         * /Library/Java/JavaVirtualMachines/jdk1.8.0_311.jdk/Contents/Home/jre/lib/ext/jfxrt.jar:
         * /Library/Java/JavaVirtualMachines/jdk1.8.0_311.jdk/Contents/Home/jre/lib/ext/localedata.jar:
         * /Library/Java/JavaVirtualMachines/jdk1.8.0_311.jdk/Contents/Home/jre/lib/ext/nashorn.jar:
         * /Library/Java/JavaVirtualMachines/jdk1.8.0_311.jdk/Contents/Home/jre/lib/ext/sunec.jar:
         * /Library/Java/JavaVirtualMachines/jdk1.8.0_311.jdk/Contents/Home/jre/lib/ext/sunjce_provider.jar:
         * /Library/Java/JavaVirtualMachines/jdk1.8.0_311.jdk/Contents/Home/jre/lib/ext/sunpkcs11.jar:
         * /Library/Java/JavaVirtualMachines/jdk1.8.0_311.jdk/Contents/Home/jre/lib/ext/zipfs.jar:
         * /Library/Java/JavaVirtualMachines/jdk1.8.0_311.jdk/Contents/Home/jre/lib/javaws.jar:
         * /Library/Java/JavaVirtualMachines/jdk1.8.0_311.jdk/Contents/Home/jre/lib/jce.jar:
         * /Library/Java/JavaVirtualMachines/jdk1.8.0_311.jdk/Contents/Home/jre/lib/jfr.jar:
         * /Library/Java/JavaVirtualMachines/jdk1.8.0_311.jdk/Contents/Home/jre/lib/jfxswt.jar:
         * /Library/Java/JavaVirtualMachines/jdk1.8.0_311.jdk/Contents/Home/jre/lib/jsse.jar:
         * /Library/Java/JavaVirtualMachines/jdk1.8.0_311.jdk/Contents/Home/jre/lib/management-agent.jar:
         * /Library/Java/JavaVirtualMachines/jdk1.8.0_311.jdk/Contents/Home/jre/lib/plugin.jar:
         * /Library/Java/JavaVirtualMachines/jdk1.8.0_311.jdk/Contents/Home/jre/lib/resources.jar:
         * /Library/Java/JavaVirtualMachines/jdk1.8.0_311.jdk/Contents/Home/jre/lib/rt.jar:
         * /Users/qiuqian/Projects/test/out/production/Java-Test:
         * /Applications/IntelliJ IDEA.app/Contents/lib/idea_rt.jar
         */

    }
}

获取运行时类的完整结构

Field Method Constructor Superclass Interface Annotation

package xyz.qiuqian.reflection;

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

// 获得类的信息
public class Test07 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException, NoSuchMethodException {
        Class c1 = Class.forName("xyz.qiuqian.reflection.User");

        User user = new User();
        c1 = user.getClass();

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

        System.out.println("=============================================================================================");

        // 获得类的属性
        // 只能找到public方法属性
        for (Field field : c1.getFields()) {
            System.out.println(field);
        }
        // 可以找到全部属性
        for (Field declaredField : c1.getDeclaredFields()) {
            System.out.println(declaredField);
        }
        // 获得指定属性
        Field name = c1.getDeclaredField("name");
        System.out.println(name);

        // 获得类的方法
        System.out.println("=============================================================================================");
        for (Method method : c1.getMethods()) { // 获得本类及其父类全部方法
            System.out.println("method => " + method);
        }
        for (Method declaredMethod : c1.getDeclaredMethods()) { // 获得本类的所有方法
            System.out.println("declaredMethod => " + declaredMethod);
        }

        System.out.println("=============================================================================================");

        // 获得指定方法
        Method getName = c1.getMethod("getName", null);
        Method setName = c1.getMethod("setName", String.class);
        System.out.println(getName);
        System.out.println(setName);

        System.out.println("=============================================================================================");

        // 获取指定构造器
        for (Constructor constructor : c1.getConstructors()) {
            System.out.println(constructor);
        }

        for (Constructor declaredConstructor : c1.getDeclaredConstructors()) {
            System.out.println(declaredConstructor);
        }

        Constructor declaredConstructor = c1.getDeclaredConstructor(String.class, int.class, int.class);
        System.out.println(
                declaredConstructor
        );

    }
}

小结:

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

动态创建对象和执行方法

有个Class对象能做什么?

  • 创建类的对象:调用Class对象的newInstance()方法
    • 类必须有一个无参数的构造器
    • 类的构造器的访问权限需要足够

在没有无参构造器时也能创建对象,只要在操作时明确调用类中的构造器,并将参数传进去,就可以进行实例化操作

步骤:

  • 通过Class类的getDeclaredConstructor(Class…parameterTypes)取得本类的指定形参类型的构造器
  • 想构造器的形参中传递一个对象数组进去,里面包含了构造器中所需的各个参数
  • 通过Constructor实例化对象
package xyz.qiuqian.reflection;

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

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

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

        // 通过反射调用普通方法
        User user3 = (User) c1.newInstance();
        // 通过反射获取一个方法
        Method setName = c1.getDeclaredMethod("setName", String.class);
        setName.invoke(user3, "aowu"); // invoke(object, value) 激活
        System.out.println(user3.getName());

        // 通过反射操作属性 不能直接操作私有属性,需要关闭程序的安全检测
        User user4 = (User) c1.newInstance();
        Field name = c1.getDeclaredField("name");
        name.setAccessible(true); // 关闭安全检测,否则获取不到private属性
        name.set(user4, "hhhaowu");
        System.out.println(user4.getName());

    }
}

性能对比和分析

setAccessible()

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

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

// 分析性能问题
public class Test09 {
    public static void main(String[] args) throws ClassNotFoundException, InvocationTargetException, NoSuchMethodException, IllegalAccessException {
        test01();
        test02();
        test03();
    }

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

        System.out.println("普通 => " + (endTime - startTime) + " ms");
    }

    // 反射方式调用
    public static void test02() throws ClassNotFoundException, NoSuchMethodException, InvocationTargetException, IllegalAccessException {
        // 获取class
        User user = new User();
        Class c1 = user.getClass();
        // 获取方法
        Method getName = c1.getDeclaredMethod("getName", null);
        long startTime = System.currentTimeMillis();
        for (int i = 0; i < 1000000000; i++) {
            getName.invoke(user, null);
        }
        long endTime = System.currentTimeMillis();

        System.out.println("反射 => " + (endTime - startTime) + " ms");
    }

    // 反射方式调用 关闭检测
    public static void test03() throws ClassNotFoundException, NoSuchMethodException, InvocationTargetException, IllegalAccessException {
        // 获取class
        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 < 1000000000; i++) {
            getName.invoke(user, null);
        }
        long endTime = System.currentTimeMillis();

        System.out.println("关检测 => " + (endTime - startTime) + " ms");
    }
}
---console---
普通 => 5 ms
反射 => 2883 ms
关检测 => 1309 ms

获取泛型信息

  • ParameterType:表示一种参数化类型
  • GenericParameterType:表示一种元素类型是参数化类型或者类型变量的数组类型
  • TypeVariable:是各种类型变量的公共父接口
  • WildcardType:代表一种通配符类型表达式
package xyz.qiuqian.reflection;

import java.lang.reflect.Method;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.List;
import java.util.Map;

// 通过反射获取泛型
public class Test10 {

    public void test01(Map<String, User> map, List<User> list) {
        System.out.println("test01");
    }

    public Map<String, User> test02() {
        System.out.println("test02");
        return null;
    }

    public static void main(String[] args) throws NoSuchMethodException {
        Method method = Test10.class.getMethod("test01", Map.class, List.class);

        Type[] genericParameterTypes = method.getGenericParameterTypes();

        for (Type genericParameterType : genericParameterTypes) {
            System.out.println("#" + genericParameterType);
            if ( genericParameterType instanceof ParameterizedType ) {
                Type[] actualTypeArguments = ((ParameterizedType) genericParameterType).getActualTypeArguments();
                for (Type actualTypeArgument : actualTypeArguments) {
                    System.out.println(actualTypeArgument);
                }
            }
        }

        System.out.println("================================================================");
        Method method2 = Test10.class.getMethod("test02");
        Type genericReturnType = method2.getGenericReturnType();
        if ( genericReturnType instanceof ParameterizedType ) {
            for (Type actualTypeArgument : ((ParameterizedType) genericReturnType).getActualTypeArguments()) {
                System.out.println(actualTypeArgument);
            }
        }


    }
}

获取注解信息

  • getAnnnotation
  • getAnnnotations
package xyz.qiuqian.reflection;

import java.lang.annotation.*;
import java.lang.reflect.Field;

// 反射操作注解
public class Test11 {

    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException {
        Class c1 = Class.forName("xyz.qiuqian.reflection.Student2");

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

        System.out.println("=====================================================================");

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

        System.out.println("=====================================================================");

        // 获得类指定的注解
        Field name = c1.getDeclaredField("name");
        MyField annotation = name.getAnnotation(MyField.class);
        System.out.println(annotation.colName());
        System.out.println(annotation.type());
        System.out.println(annotation.length());

        Field id = c1.getDeclaredField("id");
        MyField annotation_id = name.getAnnotation(MyField.class);
        System.out.println(annotation_id.colName());
        System.out.println(annotation_id.type());
        System.out.println(annotation_id.length());

    }

}

@MyTable("db_student")
class Student2 {
    @MyField(colName = "db_id", type = "int", length = 10)
    private int id;

    @MyField(colName = "db_age", type = "int", length = 10)
    private int age;

    @MyField(colName = "db_name", type = "varchar", length = 3)
    private String name;

    public Student2() {
    }

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

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String getName() {
        return name;
    }

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

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

// 类名的注解
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface MyTable {
    String value();
}

// 属性的注解
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface MyField {
    String colName();

    String type();

    int length();
}

本博客所有文章除特别声明外,均采用 CC BY-SA 4.0 协议 ,转载请注明出处!