一、简介

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

二、反射的作用

一般下面几种场景会用到反射机制:

  • 需要访问隐藏属性(private)或者调用方法改变程序原来的逻辑,系统并没有开放相应的接口,这个时候利用反射可以强行访问私有属性。
  • 自定义注解,注解是在运行时利用反射机制来获取的。
  • 在开发中动态加载类。模块化和插件化开发都离不开反射机制。

三、反射的组成

由于反射最终也必须有类参与,因此反射的组成一般有下面几个方面组成:

  • java.lang.Class.java:类对象;
  • java.lang.reflect.Field.java:类的属性对象;
  • java.lang.reflect.Method.java:类的方法对象;
  • java.lang.reflect.Constructor.java:类的构造器对象;

四、Class类

Class代表类的实体,在运行的Java应用程序中表示类和接口。

要想解剖一个类,必须先要获取到该类的字节码文件对象,而解剖使用的就是Class类中的方法,所以先要获取到每一个字节码文件对应的Class类型的对象。

获取class文件对象有三种方式:

  • Object类的getClass()方法

由于对象都继承于Object类,所以通过对象的getClass()方法可以获得对应的Class对象

Person p = new Person();
// 通过getClass()方法获得class对象
Class<?> cls=p.getClass();
// 调用Class对象的newInstance()方法可以创建一个对应的实例
Person p2=(Person)cls.newInstance();
  • 静态属性 class

    Class<?> cls=Person.Class();
    Person p=(Person)cls.newInstance();
  • Class类中的静态方法forName()

通过JVM查找并加载指定的类(下面的代码指定加载了com.demo包中的Person类)

Class<?> cls=Class.forName("com.demo.Person"); // forName(包名.类名)
Person p= (Person) cls.newInstance();

---

## 五、反射机制的相关类和方法

详细信息请查阅官方文档,这里只列出部分常见方法。

1. Class类

  • 获得类相关的方法
方法用途
asSubclass(Class<U> clazz)把传递的类的对象转换成代表其子类的对象
Cast把对象转换成代表类或是接口的对象
getClassLoader()获得类的加载器
getClasses()返回一个数组,数组中包含该类中所有公共类和接口类的对象
getDeclaredClasses()返回一个数组,数组中包含该类中所有类和接口类的对象
forName(String className)根据类名返回类的对象
getName()获得类的完整路径名字
newInstance()创建类的实例
getPackage()获得类的包
getSimpleName()获得类的名字
getSuperclass()获得当前类继承的父类的名字
getInterfaces()获得当前类实现的类或是接口
  • 获得类中属性相关的方法
方法用途
getField(String name)获得某个公有的属性对象
getFields()获得所有公有的属性对象
getDeclaredField(String name)获得某个属性对象
getDeclaredFields()获得所有属性对象
  • 获得类中注解相关的方法
方法用途
getAnnotation(Class annotationClass)返回该类中与参数类型匹配的公有注解对象
getAnnotations()返回该类所有的公有注解对象
getDeclaredAnnotation(Class annotationClass)返回该类中与参数类型匹配的所有注解对象
getDeclaredAnnotations()返回该类所有的注解对象
  • 获得类中构造器相关的方法
方法用途
getConstructor(Class...<?> parameterTypes)获得该类中与参数类型匹配的公有构造方法
getConstructors()获得该类的所有公有构造方法
getDeclaredConstructor(Class...<?> parameterTypes)获得该类中与参数类型匹配的构造方法
getDeclaredConstructors()获得该类所有构造方法
  • 获得类中方法相关的方法
方法用途
getMethod(String name, Class...<?> parameterTypes)获得该类某个公有的方法
getMethods()获得该类所有公有的方法
getDeclaredMethod(String name, Class...<?> parameterTypes)获得该类某个方法
getDeclaredMethods()获得该类所有方法
  • 类中其他重要的方法
方法用途
isAnnotation()如果是注解类型则返回true
isAnnotationPresent(Class<? extends Annotation> annotationClass)如果是指定类型注解类型则返回true
isAnonymousClass()如果是匿名类则返回true
isArray()如果是一个数组类则返回true
isEnum()如果是枚举类则返回true
isInstance(Object obj)如果obj是该类的实例则返回true
isInterface()如果是接口类则返回true
isLocalClass()如果是局部类则返回true
isMemberClass()如果是内部类则返回true

2. Field类

Field代表类的成员变量(成员变量也称为类的属性)。

返回值名字和参数作用
Objectget(Object obj)返回这个object对应field字段的Object
xxxgetXXX(Object obj)同上,不过XXX可以是Int,Char,Boolean等
voidset(Object obj, Object value)设置obj对象的调用方法的这个field的值为value
voidsetXXX(Object obj, XXX value)设置特定类型值,例setInt(Object obj,int value)
ClassgetDeclaringClass()返回定义中的Class对象
StringgetName()得到名字的字符串
intgetModifier()返回一个修饰符的值
ClassgetType()返回这个field的对象Class
voidsetAccessible(boolean flag)设置是否允许set get
booleanisAccessible()查看field是否允许set和get。
.........

3. Method类

Method代表类的方法。

方法用途
invoke(Object obj, Object... args)传递object对象及参数调用该对象对应的方法
getName()获得方法名
getModifiers()获得修饰符
getReturnTypes()返回值类型。返回class
getParameterTypes()返回Class[],参数类型的数组

4. Constructor类

Constructor代表类的构造方法。

方法用途
newInstance(Object... initargs)根据传递的参数创建类的对象

六、通过反射机制实现自定义注解的示例

此示例实现通过自定义注解实现将实体类对象插入数据库的操作。自定义两个注解分别标注在实体类和实体类属性上。

首先定义两个注解 @Table 和 @Columns :

// 定义@Table注解,标注在实体类上,value值表示要操作的数据库表名
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Table
{
    String value();
}
// 定义@Columns,标注在属性上,value值表示要操作的数据库表的字段名
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Columns
{
    String value();
}

然后编写实体类:

@Table("sm_user")
public class SmUser implements Serializable
{
    private static final long serialVersionUID = 1L;
    
    @Columns("user_id")
    private Long userId;
    
    @Columns("user_name")
    private String userName;
    
    ···省略getter、setter以及构造方法等
        
}

以上准备工作就做好了,接下来编写一个函数,传入一个实体类对象,实现通过反射机制将该对象插入数据库。

// 编写函数,参数为一个实体类对象,使用泛型
public <T> String insertData(T entity)
    {
        // 表名
        String tableName = null;
        // Sql
        StringBuffer sql = new StringBuffer();
        StringBuffer values = new StringBuffer();
        // 获取该对象对应的Class对象
        Class<T> clazz = (Class<T>)entity.getClass();
        // 如果含有@Table注解,获取其value值
        if (clazz.isAnnotationPresent(Table.class))
        {
            Table table = clazz.getAnnotation(Table.class);
            tableName = table.value();
        }
        else
        {
            return null;
        }
        // 拼接SQL语句
        sql.append("INSERT INTO " + tableName + " (");
        // 获取所有属性字段
        Field[] fields = clazz.getDeclaredFields();
        // 遍历所有属性字段
        for (Field field : fields)
        {    // 如果属性字段上含有Columns注解
            if (field.isAnnotationPresent(Columns.class))
            {    // 获取该注解
                Columns column = field.getAnnotation(Columns.class);
                // 获取注解的value(获取列名)
                String columnName = column.value();
                sql.append(columnName + ",");
                // 取消java语言访问检查,即可以访问private属性值
                field.setAccessible(true);
                try
                {
                    values.append("'" + field.get(entity) + "',");
                }
                catch (IllegalArgumentException | IllegalAccessException e)
                {
                    e.printStackTrace();
                }
            }
        }
        // 去掉结尾的逗号
        sql.deleteCharAt(sql.length() - 1);
        values.deleteCharAt(values.length() - 1);
        sql.append(") VALUES (" + values + ")");
        // 返回生成的SQL语句
        return sql.toString();
    }

编写测试函数,调用以上函数,测试生成的SQL:

public static void main(String[] args)
    {
        SmUser user = new SmUser(9874646479L, "admin");
        AnnotationTest test = new AnnotationTest();
        // 调用函数,传入user对象
        String sql = test.insertData(user);
        // 打印SQL语句
        System.out.println(sql);
    }

/**
* 运行结果为:
* INSERT INTO sm_user (user_id,user_name) VALUES ('9874646479','admin')
/

这里解释一下为什么编写函数public <T> String insertData(T entity) 要使用泛型参数呢,因为我们自定义注解在实体类上是可以通用的,你传入哪个实体对象就会解析对应实体类的注解,进而操作对应的数据库表和字段。如果不采用泛型而指定了某个类的话,就失去了自定义注解的意义。

文章目录