shanX
shanX
文章31
标签17
分类9
回到首页
文章归档
Cesium
关于博客
© 2024 shanX Powered by Hexo & Nexmoe
  1. 1. 注解和反射
    1. 1.1. 注解 java.annotation
    2. 1.2. 什么是注解
    3. 1.3. 内置注解
    4. 1.4. 元注解
    5. 1.5. 自定义注解
    6. 1.6. 反射机制
      1. 1.6.1. 静态|动态语言
        1. 1.6.1.1. 动态语言
        2. 1.6.1.2. 静态语言
    7. 1.7. Class 类
    8. 1.8. 类加载内存分析
      1. 1.8.1. 类的加载与 ClassLoader 的理解
    9. 1.9. 类初始化
    10. 1.10. 类加载器的作用
    11. 1.11. 获得运行时类的完整结构
    12. 1.12. 动态创建对象执行方法
    13. 1.13. SetAccessible
    14. 1.14. 反射操作泛型
    15. 1.15. 反射操作注解：练习 ORM
JAVA-注解和反射

JAVA-注解和反射

2021年04月18日 4.7k 字 大概 22 分钟

注解和反射

重中之重，很多主流框架的实现都使用了注解和反射原理

注解 java.annotation

什么是注解

Annotation 是从 JDK1.5 开始引入的新技术；

Annotation 的作用：

  • 不是程序本身，可以对程序作出解释（这一点和注释 comment 没什么区别）；
  • 可以被其他程序（比如：编译器等）读取；

Annotation 的格式：

  • 注解是以 “@注释名” 在代码中存在的，还可以添加一些参数值，例如：

  • @SuppressWarnings(value=”unchecked”)；

Annotation 在哪里使用？

  • 可以附加在 package，class，method，field 上面，相当于添加额外的辅助信息，可以通过反射机制编程实现对这些元数据的访问；

内置注解

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

元注解

元注解的作用就是负责注解其他注解，java 定义了 4 个标准的 meta-annotation 类型，他们被用来提供对其他 annotation 类型作说明

☆ @Target //用于描述注解的适用范围
☆ @Retention //表示在什么级别保存该注释信息，用于描述注解的生命周期(source < class  < RUNTIME)
@Document // 说明该注解将被包含在javadoc中
@Inherited // 说明子类可以继承父类中的该注解

自定义注解

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

分析：

  1. @interface 用来声明一个注解，格式 public @inteface 注解名 { content }
  2. 其中的每一个方法实际上是声明了一个配置参数
  3. 方法的名称就是参数的名称
  4. 返回值类型就是参数的类型（返回值只能是基本类型 class、String、 enum）
  5. 可以通过 default 来声明参数的默认值
  6. 如果只有一个参数成员，一般参数名为 value
  7. 注解元素必须要有值，我们定义注解元素时，经常使用空字符串、0 作为默认值
//测试元注解
public class Test02 {
    // 注解可以显示赋值 如果没有默认值，就必须给注解赋值
    @MyAnnotation(name = "shan", age = 24)
    public void test(){
    }
}
//定义一个注解
//Target表示我们的注解可以用在哪些地方
@Target(value = {ElementType.METHOD, ElementType.TYPE})
//Retention 表示我们的注解在什么地方还有效
//Runtime > class > source
@Retention(RetentionPolicy.RUNTIME)
//@Documented 表示是否将我们的注解生成在JAVADoc中
@Documented
//@Inherited 子类可以继承父类的注解
@Inherited
@interface MyAnnotation {

}

反射机制

静态|动态语言

动态语言

是一类在运动时可以改变其结构的语言：例如新的函数、对象、甚至代码可以被引进，已有的函数可以被删除或是其他结构上的变化。通俗点说就是在运行时代码可以根据某些条件改变自身结构。

静态语言

与动态语言相对应的，运行时结构不可变的语言就是静态语言，如 java、c、c++；

java 不是动态语言，但 java 可以称之为“准动态语言”。即 java 有一定的动态性，我们可以利用反射机制获得类似动态语言的特性。java 的动态性让编程的时候更加灵活。

image-20210414143319605

优点：

​ 可以动态实现创建对象和编译，体现出很大的灵活性；

缺点：

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

一个类在内存中只有一个 Class 对象；

一个类加载后，类的整个结构都会被封装在 class 对象中；

public class Test02 {
    public static void main(String[] args) throws ClassNotFoundException {
        Class c1 = Class.forName("com.annotation.reflection.User");
        System.out.println(c1);

        Class c2 = Class.forName("com.annotation.reflection.User");
        System.out.println(c2.hashCode());
        Class c3 = Class.forName("com.annotation.reflection.User");
        System.out.println(c3.hashCode());
        Class c4 = Class.forName("com.annotation.reflection.User");
        System.out.println(c4.hashCode());

    }
}

class User {
    private String name;
    private int id;
    private int age;

    public User() {
    }

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

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

    public String getName() {
        return name;
    }

    public void setName(String name) {
        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;
    }
}

//运行结果
class com.annotation.reflection.User
460141958
460141958
460141958

Class 类

image-20210414150428147

对象照镜子可以得到的信息：

某个类的属性、方法和构造器、某个类到底实现了哪些接口。对于每个类而言，JRE 都为其保留一个不变的 Class 类型的对象。一个 Class 对象包含了特定某个结构（Class/interface/enum/annotation/primitive type/void[]) 的有关信息。

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

image-20210414153626283

获取 Class 类的实例

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

演示：

//测试class 类的创建方式有哪些
public class Test03 {
    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());

        // 方式二 ： forname 获得
        Class c2 = Class.forName("com.annotation.reflection.Student");
        System.out.println(c2.hashCode());

        //方式三 ： 通过类名.class 获得
        Class<Student> c3 = Student.class;
        System.out.println(c3.hashCode());

        //方式四 ： 内置基本数据类型可以直接用类名.Type；
        Class<Integer> type = Integer.TYPE;
        System.out.println(type.hashCode());

        //获得父类类型
        Class c5 = c1.getSuperclass();
        System.out.println(c5);
    }
}

class Person {
    String name;
    public Person() {}
    public Person(String name) {
        this.name = name;
    }
    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 = "Teac";
    }
}

//结果
这个人是：学生
460141958
460141958
460141958
1163157884
class com.annotation.reflection.Person

类加载内存分析

类的加载与 ClassLoader 的理解

  • 加载：将 class 文件字节码内容加载到内存中，并将这些静态数据转换成方法区的运行时数据结构，然后生成一个代表这个类的 java.lang.Class 对象。

  • 链接：将 java 类的二进制代码合并到 JVM 的运行状态之中的过程。

    • 验证：确保加载的类信息符合 JVM 规范，没有安全方面的问题；
    • 准备：正式为类变量（static）分配内存并设置类变量默认初始值的阶段，这些内存都将在方法去中进行分配；
    • 解析：虚拟机常量池的符号引用（常量名）替换为直接引用（地址）的过程；

  • 初始化：

    • 执行类构造器 () 方法的过程。类构造器() 方法是由编译期自动收集类中所有变量的赋值动作和静态代码块中的语句合并产生的。（类构造器是构造类信息的，不是构造该类对象的构造器）。
    • 当初始化一个类的时候，如果发现其父类还没有进行初始化，则需要先触发其父类的初始化。
    • 虚拟机会保证一个类的() 方法在多线程环境中被正确加锁和同步。

类初始化

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

image-20210414170751285

public class Test05 {
    static {
        System.out.println("Main 被加载");
    }
    public static void main(String[] args) {
        // 1. 主动引用
        Son son = new Son();
        // 2. 反射也会产生主动引用
        try {
            Class.forName("com.annotation.reflection.Son");
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        }
        // 不会产生类的引用方法
        System.out.println(Son.b);
        Son[] array = new Son[100];
    }
}
class Father {
    static int b = 2;
    static {
        System.out.println("父类被加载");
    }
}
class Son extends Father {
    static {
        System.out.println("子类被加载");
        m = 300;
    }
    static int m = 100;
    static final int M = 1;
}

类加载器的作用

  • 类加载的作用：将 class 文件字节码内容加载到内存中，并将这些静态数据转换成方法区的运行时数据结构，然后在堆中生成一个代表这个类的java.lang.Class对象，作为方法区中类数据的访问入口。

  • 类缓存：标准的 javaSE 类加载器可以按要求查找类，但一旦某个类被加载到类加载器中，它将维持加载（缓存）一段时间。不过 JVM 垃圾回收机制可以回收这些 Class 对象。

image-20210414173909852

image-20210414173959254

获得运行时类的完整结构

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("com.annotation.reflection.User");

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

        // 获得类的属性
        System.out.println("------------");
        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);

        // 获得类的方法
        System.out.println("------------");
        Method[] methods = c1.getMethods();// 获得本类及其父类的全部public方法
        for (Method method : methods){
            System.out.println("正常的：" + method);
        }
        methods = c1.getDeclaredMethods(); // 获得本类的全部方法
        for (Method method : methods){
            System.out.println("getDeclaredMethods：" + method);
        }

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

        // 获得指定的构造器
        System.out.println("--------------");
        Constructor[] constructors = c1.getConstructors();
        for (Constructor constructor : constructors){
            System.out.println(constructor);
        }
        constructors  = c1.getDeclaredConstructors();
        for (Constructor constructor : constructors){
            System.out.println(constructor);
        }

        // 获得指定的构造器
        Constructor declaredConstructor = c1.getDeclaredConstructor(String.class, int.class, int.class);
        System.out.println("指定的：" + declaredConstructor);
    }
}

动态创建对象执行方法

有了 Class 对象，能做什么？

  • 创建类的对象：调用 Class 对象的 newInstance()方法
    • 类必须有一个无参构造器。
    • 类的构造器的访问权限需要足够。
  • 思考：难道没有无参的构造器就不能创建对象了吗？
    • 只要在操作的时候明确的调用类中的构造器，并将参数传递进去后，才可以实例化操作
    • 步骤如下：
      • 通过 Class1 类的getDeclaredConstructor(Class ... parameterTypes) 取得本类的指定形参类型的构造器；
      • 向构造器的形参中传递一个对象数组进去，里面包含了构造器中所需的各个参数；
      • 通过 Constructor 实例化对象；

调用指定方法：

  • 通过反射，调用类中的方法，通过 Method 类完成；

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

    image-20210414184512856

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, IllegalAccessException, InstantiationException, NoSuchMethodException, InvocationTargetException, NoSuchFieldException {
        //获得Class对象
        Class<?> c1 = Class.forName("com.annotation.reflection.User");

        //构造一个对象
        User user = (User)c1.newInstance(); //本质是调用了类的无参构造器
        System.out.println(user);

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

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

        //通过反射操作属性
        User user4 = (User)c1.newInstance();
        Field name = c1.getDeclaredField("name");
        //默认状态下不能直接操作私有属性，我们需要关闭程序的安全检测，属性或者方法的setAccessible(true); 此处true为关
        // 会降低程序效率
        name.setAccessible(true);
        name.set(user4, "shanx-2");
        System.out.println(user4.getName());

    }
}

SetAccessible

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

public class Test09 {
    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("普通方法执行10亿次：" + (endTime-startTime) + "ms");
    }

    //反射方式调用
    public static void test02() throws NoSuchMethodException {
        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.getName();
        }
        long endTime = System.currentTimeMillis();
        System.out.println("反射方式调用执行10亿次：" + (endTime-startTime) + "ms");
    }

    //反射方式调用,关闭检测
    public static void test03() throws NoSuchMethodException {
        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.getName();
        }
        long endTime = System.currentTimeMillis();
        System.out.println("反射方式调用,关闭检测执行10亿次：" + (endTime-startTime) + "ms");
    }

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

反射操作泛型

  • java 采用泛型擦除的机制来引入泛型，java 中的泛型仅仅是给编译器 javac 使用的，确保数据的安全性和免去强制类型转换问题，但是，一旦编译完成，所有的泛型有关的类型全部擦除；
  • 为了通过反射操作这些类型，java 新增了 ParameterizedType, GenericArrayType，TypeVariable 和 WildcardType 几种类型来代表不能被归一到 Class 类中的类型但是又和原始类型齐名的类型；
    • ParameterizedType：表示一种参数化类型，比如 Collection；
    • GenericArrayType：表示一种元阿苏类型是参数化类型或者类型变量的数组模型；
    • TypeVariable ：是各种类型变量的公共父接口；
    • WildcardType ：代表一种通配符类型表达式；
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("#"+genericParameterTypes);
            if (genericParameterType instanceof ParameterizedType) {
                Type[] actualTypeArguments = ((ParameterizedType) genericParameterType).getActualTypeArguments();
                for (Type actualTypeArgument : actualTypeArguments) {
                    System.out.println(actualTypeArgument);
                }
            }
        }

        method = Test10.class.getMethod("test02",null);
        Type genericReturnType = method.getGenericReturnType();
        if (genericReturnType instanceof ParameterizedType) {
            Type[] actualTypeArguments = ((ParameterizedType) genericReturnType).getActualTypeArguments();
            for (Type actualTypeArgument : actualTypeArguments) {
                System.out.println(actualTypeArgument);
            }
        }
    }
}

反射操作注解：练习 ORM

什么是 ORM？

  • Object relationship Mapping –> 对象关系映射

image-20210414201814306

  • 类和表结构对应
  • 属性和字段对应
  • 对象和记录对应

要求：利用注解和反射完成类和表结构的映射关系。

//orm

public class Test11 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException {
        Class c1 = Class.forName("com.annotation.reflection.Stu");

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

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


        // 获得类指定注解
        Field f = c1.getDeclaredField("name");
        FieldStu annotation = f.getAnnotation(FieldStu.class);
        System.out.println(annotation.columnName());
        System.out.println(annotation.length());
        System.out.println(annotation.type());
    }
}

@TableStu("db_stu")
class Stu{
    @FieldStu(columnName = "db_id", type = "int", length = 10)
    private int id;
    @FieldStu(columnName = "db_age", type = "int", length = 10)
    private int age;
    @FieldStu(columnName = "db_name", type = "varchar", length = 3)
    private String name;

    public Stu() {
    }

    public Stu(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 "Stu{" +
                "id=" + id +
                ", age=" + age +
                ", name='" + name + '\'' +
                '}';
    }
}

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

// 属性的注解
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface FieldStu{
    String columnName();
    String type();
    int length();
}
本文作者：shanX
本文链接：https://rhymexmove.github.io/2021/04/18/c82a438b4928/
版权声明：本文采用 CC BY-NC-SA 3.0 CN 协议进行许可
java