注解和反射

1. `Annotation`注解

1.1 什么是`Annotation`注解

Annotation注解是从JDK 5.0开始引入的新技术，可以看作是对一个类/方法的一个扩展的模版，每个类/方法按照注解类中的规则，来为类/方法注解不同的参数，在用到的地方可以得到不同的类/方法中注解的各种参数与值。

1.2 `Annotation`注解的作用

不是程序本身，可以对程序做出解释（和Comment注释没什么区别）
可以被其他程序（比如编译器等）读取

1.3 `Annotation`的格式

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

@SuppressWarnings(value="unchecked")

1.4 `Annotation`可以在哪里使用

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

1.5 内置注解

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

1.6 元注解

1.6.1 元注解的作用

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

1.6.2 几个常用的元注解

@Target：表示描述注解的使用范围（被描述的注解可以用在什么地方）
@Retention：表示描述注解的生命周期（SOURCE < CLASS < RUNTIME）
@Document：表示该注解将被包含在javadoc中
@Inherited：说明子类可以继承父类中的该注解

1.7 自定义注解

使用关键字@interface自定义注解是，自动继承了java.lang.Annotation接口

@interface用来声明一个注解，格式：

public @interface testAnnotationName { 
	// 自定义内容
}

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

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

public class AnnotationTest {
    @Target(value = {ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Deprecated
    public @interface testAnnotation {
        // 注解的参数：参数类型 + 参数名（）；
		int id() default -1;
        int age();
        String name default "";
    }
}

2. 反射

2.1 `Java`反射机制概述

Java的反射（Reflection）机制是指在程序的运行状态中，可以构造任意一个类的对象，可以了解任意一个对象所属的类，可以了解任意一个类的成员变量和方法，可以调用任意一个对象的属性和方法。这种动态获取程序信息以及动态调用对象的功能称为Java语言的反射机制。反射被视为动态语言的关键。

正常方式：引入需要的“包类”名称 --> 通过new实例化 --> 取得实例化对象
反射方式：实例化对象 --> getClass()方法 --> 取得完整的“包类”名称
Java反射机制提供的功能
- 在运行时判断任意一个对象所属的类
- 在运行时构造任意一个类的对象
- 在运行时判断任意一个类所具有的成员变量和方法
- 在运行时获取泛型信息
- 在运行时调用任意一个对象的成员变量和方法
- 在运行时处理注解
- 生成动态代理
- …………
反射的优点和缺点
- 优点：可以实现动态创建对象和编译，体现出很大的灵活性
- 缺点：对性能有影响，使用反射基本上是一种解释操作，我们可以告诉JVM，我们希望做什么并且它满足我们的要求。这类操作总是慢于直接执行相同的操作

2.2 理解`Class`类并获取`Class`实例

在Object类中定义了一下的方法，此方式将被所有子类继承

public final Class getClass()

以上的方法返回值的类型是一个Class类，此类是Java反射的源头，实际上所谓反射从程序的运行结果来看也很好理解，即：可以通过对象反射求出类的名称。

Class类

对象照镜子后可以得到的信息：某个类的属性、方法和构造器、某个类实现了哪些接口。对于每个类而言，JRE都为其保留一个不变Class类型的对象。一个Class对象包含了特定某个结构的有关信息
- Class本身也是一个类
- Class对象只能由系统建立对象
- 一个加载的类在JVM中只会有一个Class实例
- 一个Class对象对应的是一个加载到JVM中的一个.class文件
- 每个类的实例都会记得自己是由哪个Class实例所生成
- 通过Class可以完整地得到一个类中的所有被加载的结构
- Class是Reflection的根源，针对任何你想动态加载、运行的类，唯有先获得相应的Class对象
Class类的常用方法

方法名	功能说明
static ClassforName(String name)	返回制定类名name的Class对象
Object newInstance()	调用缺省函数，返回Class对象的一个实例
getName()	返回次Class对象所表示的实体（类、接口、数组类或void）的名称
Class getSuperClass()	返回当前Class对象的父类Class对象
Class[] getinterfaces()	获取当前Class对象的接口
ClassLoader getClassLoader()	返回该类的类加载器
Construtor[] getConstructors()	返回一个包含某些Constructor对象的数组
Method getMothed(String name, Class.. T)	返回一个Method对象，此对象的形参类型为paramType
Field[] getDeclaredFields()	返回Field对象的一个数组

获取Class类的实例

已知具体的类，通过类的class 属性获取，该方法最为可靠，程序性能最高。
```
Class class = Person.class;
```
已知某个类的实例，调用该实例的getClass()方法获取Class对象
```
Class class = person.getClass();
```
已知一个类的全类名，且该类在类路径下，可通过Class类的静态方法forName()获取，可能抛出ClassNotFoundException异常
```
Class class = Class.forName("com.artherlee.Person");
```
内置基本数据类型可以直接用类名.Type
还可以利用ClassLoader类加载器

package com.artherlee.test;

class Person {
    private String name;

    public Person() {
    }

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

    public String getName() {
        return name;
    }

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

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

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

class Teacher extends Person {
    public Teacher() {
        this.setName("老师");
    }
}

public class ReflectionTest {
    public static void main(String[] args) throws ClassNotFoundException {
        Person person = new Student();
        System.out.println("这个对象是：" + person.getName());

        // 方法一：已知具体的类，通过类的`class`属性获取
        Class class1 = Person.class;
        System.out.println(class1.hashCode());

        // 方法二：已知某个类的实例，调用该实例的`getClass()`方法获取`Class`对象
        Class class2 = person.getClass();
        System.out.println(class2.hashCode());

        // 方法三：已知一个类的全类名，且该类在类路径下，可通过`Class`类的静态方法`forName()`获取，可能抛出`ClassNotFoundException`异常
        Class class3 = Class.forName("com.artherlee.test.Student");
        System.out.println(class3.hashCode());

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

        // 方法五：获取当前Class对象的父类Class对象
        Class class5 = class2.getSuperclass();
        System.out.println(class5);
    }
}

2.3 类的加载与`ClassLoader`

2.3.1 `Java`内存

Java内存

2.3.2 类的加载过程

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

类的加载过程

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

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

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

2.3.4 类加载器（`ClassLoader`）的作用

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

类加载器ClassLoader

类加载器的类型

引导类加载器：用C++编写的，是JVM自带的类加载器，负责Java平台核心库，用来加载核心类库。该加载器无法直接获取
扩展类加载器：负责jre/lib/ext目录下的jar包或-D java.ext.dirs指定目录下的jar包装入工作库

系统类加载器：负责java -classpath或-D java.class.path所指的目录下的类与jar包装入工作，是最常用的加载器

public class GetClassLoaderTest {
    public static void main(String[] args) {
        // 获取系统类加载器
        ClassLoader systemClassLoader = ClassLoader.getSystemClassLoader();

        // 获取扩展类加载器
        ClassLoader parent = systemClassLoader.getParent();

        // 引导类加载器
        ClassLoader parentParent = parent.getParent();

        System.out.println(systemClassLoader); // sun.misc.Launcher$AppClassLoader@18b4aac2
        System.out.println(parent); // sun.misc.Launcher$ExtClassLoader@2503dbd3
        System.out.println(parentParent); // null
    }
}

2.4 获取运行时类的完整结构

User类

public class User {
    public int id;
    private String userName;
    private VipLevel vipLevel;

    public User() {
    }

    public User(String userName, VipLevel vipLevel) {
        this.userName = userName;
        this.vipLevel = vipLevel;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public VipLevel getVipLevel() {
        return vipLevel;
    }

    public void setVipLevel(VipLevel vipLevel) {
        this.vipLevel = vipLevel;
    }

    @Override
    public String toString() {
        return "Users{" +
                "userName='" + userName + '\'' +
                ", vipLevel=" + vipLevel +
                '}';
    }
}

VipLevel枚举

public enum VipLevel {
    VIP1,
    VIP2,
    VIP3
}

获取完整结构

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

public class GetClassLoaderInfo {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException, NoSuchMethodException {
        Class userClass = Class.forName("com.artherlee.entity.User");

        // 获取类名
        System.out.println("=====获得类名信息=====");
        System.out.println("获取包名 + 类名：" + userClass.getName());
        System.out.println("获取类名：" + userClass.getSimpleName());

        // 获取构造器
        System.out.println("=====获得构造器信息=====");
        Constructor[] publicConstructors = userClass.getConstructors();
        if (publicConstructors.length > 0) {
            for (Constructor constructor : publicConstructors) {
                System.out.println("public修饰符的构造器：" + constructor);
            }
        }

        Constructor[] allConstructors = userClass.getDeclaredConstructors();
        if (allConstructors.length > 0) {
            for (Constructor constructor : allConstructors) {
                System.out.println("所有的构造器：" + constructor);
            }
        }

        System.out.println("获取指定public修饰符的无参构造器：" + userClass.getConstructor());
        System.out.println("获取指定public修饰符的有参构造器：" + userClass.getConstructor(String.class, VipLevel.class));

        // 获取属性
        System.out.println("=====获取属性信息=====");
        Field[] publicFields = userClass.getFields();
        if (publicFields.length > 0) {
            for (Field field : publicFields) {
                System.out.println("public修饰符的属性：" + field);
            }
        }

        Field[] allFields = userClass.getDeclaredFields();
        if (allFields.length > 0) {
            for (Field field : allFields) {
                System.out.println("所有的属性" + field);
            }
        }

        System.out.println("获取指定public修饰符的属性：" + userClass.getField("id"));
        System.out.println("获取指定非public修饰符的属性：" + userClass.getDeclaredField("userName"));

        // 获取方法
        System.out.println("=====获取方法信息=====");
        Method[] publicMethods = userClass.getMethods();
        if (publicMethods.length > 0) {
            for (Method method : publicMethods) {
                System.out.println("public修饰符的方法：" + method);
            }
        }

        Method[] allMethods = userClass.getMethods();
        if (allMethods.length > 0) {
            for (Method method : allMethods) {
                System.out.println("所有的方法：" + method);
            }
        }

        System.out.println("获取指定public修饰符的无参方法：" + userClass.getMethod("getUserName", null));
        System.out.println("获取指定public修饰符的有参方法：" + userClass.getMethod("setUserName", String.class));
    }
}

2.5 调用运行时类的制定结构

User类

public class User {
    public int id;
    private String userName;
    private VipLevel vipLevel;

    public User() {
    }

    public User(String userName, VipLevel vipLevel) {
        this.userName = userName;
        this.vipLevel = vipLevel;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public VipLevel getVipLevel() {
        return vipLevel;
    }

    public void setVipLevel(VipLevel vipLevel) {
        this.vipLevel = vipLevel;
    }

    @Override
    public String toString() {
        return "Users{" +
                "userName='" + userName + '\'' +
                ", vipLevel=" + vipLevel +
                '}';
    }
}

VipLevel枚举

public enum VipLevel {
    VIP1,
    VIP2,
    VIP3
}

调用运行时类的指定结构

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

public class InvokeReflectionTest {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchMethodException, IllegalAccessException, InstantiationException, InvocationTargetException, NoSuchFieldException {
        Class userClass = Class.forName("com.artherlee.entity.User");

        /* 通过反射Class对象.newInstance()方法获取类的对象
         * 调用此方法需要类中有一个无参的构造函数
        **/
        User user = (User) userClass.newInstance();

        // 通过反射Class类对象.getDeclaredMethod()方法获取到方法对象
        Method setUserName = userClass.getDeclaredMethod("setUserName", String.class);

        // 通过方法对象.invoke(对象, 方法参数)可以执行该方法；
        setUserName.invoke(user, "Arhter Lee");
        System.out.println(user.getUserName());

        // 通过反射Class类对象.getDeclaredField()方法获取到方法属性
        Field vipLevel = userClass.getDeclaredField("vipLevel");

        /* 如果该属性访问权限不足，则可以关闭程序的安全检测，如果不设置则会抛出非法异常（java.lang.IllegalAccessException）
         * 解决方法：属性或者方法.setAccessible(true)
         **/
        vipLevel.setAccessible(true);

        // 通过属性对象.set(对象, 值)可以设置属性值
        vipLevel.set(user, VipLevel.VIP1);
        System.out.println(user.getVipLevel());
    }
}

2.6 反射操作泛型

Java采用泛型擦除的机制来引入泛型，Java中的泛型仅仅是给编译器javac使用的，确保数据的安全性和免去强制类型转换问题，但是一旦编译完成，所有和泛型有关的类型全部擦除

为了通过反射操作这些类型，Java新增了ParameterizedType、GenericArrayType、TypeVariable和WildcardType几种类型来代表不能被归一到Class类中的类型，但是又和原始类型齐名的类型

ParameterizedType：表示一种参数化类型，比如Collection<String>
GenericArrayType：表示一种元素类型是参数化类型或者类型变量的数组类型
TypeVariable：是各种类型变量的公共父接口
WildcardType：代表一种通配符类型表达式

User类

public class User {
    public int id;
    private String userName;
    private VipLevel vipLevel;

    public User() {
    }

    public User(String userName, VipLevel vipLevel) {
        this.userName = userName;
        this.vipLevel = vipLevel;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public VipLevel getVipLevel() {
        return vipLevel;
    }

    public void setVipLevel(VipLevel vipLevel) {
        this.vipLevel = vipLevel;
    }

    @Override
    public String toString() {
        return "Users{" +
                "userName='" + userName + '\'' +
                ", vipLevel=" + vipLevel +
                '}';
    }
}

获取反射操作类型

import com.artherlee.entity.User;

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 GetGenericReflection {
    public void testOne (Map<String, User> map, List<User> list) {
        System.out.println("这是testOne()方法！");
    }

    public Map<String, User> testTwo() {
        System.out.println("testTwo()方法！");
        return null;
    }

    public static void main(String[] args) throws NoSuchMethodException {
        // 通过反射方式获取GetGenericReflection类的testOne()方法
        Method methodTestOne = GetGenericReflection.class.getDeclaredMethod("testOne", Map.class, List.class);

        // 获取该方法的泛型参数类型数组
        Type[] genericParameterTypes = methodTestOne.getGenericParameterTypes();

        // 循环遍历此数组
        for (Type genericParameterType : genericParameterTypes) {
            System.out.println(genericParameterType);

            // 判断genericParameterType此类型是否属于参数化类型
            if (genericParameterType instanceof ParameterizedType) {

                // 获取该类型的真实参数类型
                Type[] actualTypeArguments = ((ParameterizedType) genericParameterType).getActualTypeArguments();
                for (Type actualTypeArgument : actualTypeArguments) {
                    /**
                     * 输出的结果集如下：
                     * java.util.Map<java.lang.String, com.artherlee.entity.User>
                     * class java.lang.String
                     * class com.artherlee.entity.User
                     * java.util.List<com.artherlee.entity.User>
                     * class com.artherlee.entity.User
                     */
                    System.out.println(actualTypeArgument);
                }
            }
        }

        System.out.println("=====华丽的分割线=====");

        // 通过反射方式获取GetGenericReflection类的testTwo()方法
        Method methodTestTwo = GetGenericReflection.class.getDeclaredMethod("testTwo", null);

        // 获取该方法的泛型参数类型(返回值只有一个)
        Type genericReturnType = methodTestTwo.getGenericReturnType();

        System.out.println(genericReturnType);
        // 判断genericReturnType此类型是否属于参数化类型
        if (genericReturnType instanceof ParameterizedType) {

            // 获取该类型的真实参数类型
            Type[] actualTypeArguments = ((ParameterizedType) genericReturnType).getActualTypeArguments();
            for (Type actualTypeArgument : actualTypeArguments) {
                /**
                 * 输出的结果集如下：
                 * java.util.Map<java.lang.String, com.artherlee.entity.User>
                 * class java.lang.String
                 * class com.artherlee.entity.User
                 */
                System.out.println(actualTypeArgument);
            }
        }
    }
}

2.7 获取注解信息

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

public class GetAnnotationInfoByReflection {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException {
        // 通过反射获取类的Class对象
        Class classHuman = Class.forName("com.artherlee.test.Humman");

        // 通过反射获取所有注解数组
        Annotation[] annotations = classHuman.getAnnotations();
        for (Annotation annotation : annotations) {
            System.out.println("类的注解为：" + annotation);
        }

        // 获取类制定注解value的值
        TableName tableName = (TableName) classHuman.getAnnotation(TableName.class);
        System.out.println("类注解TableName的值为：" + tableName.value());

        // 获取指定属性的注解value值
        FieldName nameAnnotation = classHuman.getDeclaredField("name").getAnnotation(FieldName.class);
        System.out.println("属性注解FieldName的name值为：" + nameAnnotation.name());
        System.out.println("属性注解FieldName的type值为：" + nameAnnotation.type());
        System.out.println("属性注解FieldName的length值为：" + nameAnnotation.length());
    }
}

/**
 * 创建一个类名的注解
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface TableName {
    String value();
}

/**
 * 创建一个属性的注解
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface FieldName {
    String name();
    String type();
    int length();
}

@TableName("db_Human")
class Humman {
    @FieldName(name = "db_id", type = "int", length = 10)
    private int id;
    @FieldName(name = "db_name", type = "varchar", length = 20)
    private String name;

    public Humman() {
    }

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

    public int getId() {
        return id;
    }

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

    public String getName() {
        return name;
    }

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

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

posted @ 2021-11-11 10:00 爱Ni说不出口阅读(9) 评论(0) 编辑收藏举报

刷新页面返回顶部

停雨在心

注解和反射

注解和反射

1. Annotation注解

1.1 什么是Annotation注解

1.2 Annotation注解的作用

1.3 Annotation的格式

1.4 Annotation可以在哪里使用

1.5 内置注解

1.6 元注解

1.6.1 元注解的作用

1.6.2 几个常用的元注解

1.7 自定义注解

2. 反射

2.1 Java反射机制概述

2.2 理解Class类并获取Class实例

2.3 类的加载与ClassLoader

2.3.1 Java内存

2.3.2 类的加载过程

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

2.3.4 类加载器（ClassLoader）的作用

2.4 获取运行时类的完整结构

2.5 调用运行时类的制定结构

2.6 反射操作泛型

2.7 获取注解信息

1. `Annotation`注解

1.1 什么是`Annotation`注解

1.2 `Annotation`注解的作用

1.3 `Annotation`的格式

1.4 `Annotation`可以在哪里使用

2.1 `Java`反射机制概述

2.2 理解`Class`类并获取`Class`实例

2.3 类的加载与`ClassLoader`

2.3.1 `Java`内存

2.3.4 类加载器（`ClassLoader`）的作用