Java 编程之内省
0x01 前言
内省(Introspector)是 Java 语言对 Bean 类属性、事件的一种缺省处理方法。一般的做法是通过类 Introspector 来获取某个对象的 BeanInfo 信息,然后通过 BeanInfo 来获取属性的描述器(PropertyDescriptor),通过这个属性描述器就可以获取某个属性对应的 getter / setter 方法,然后我们就可以通过反射机制来调用这些方法。
0x02 Java内省和反射的联系
- 反射
反射就是运行时获取一个类的所有信息,可以获取到 .class 的任何定义的信息(包括成员 变量,成员方法,构造器等)。可以操纵类的字段、方法、构造器等部分。
- 内省
内省基于反射实现,主要用于操作 JavaBean,通过内省可以获取 Bean 的 getter / setter
0x03 JavaBean 规范
规范
JavaBean 是一种 JAVA 语言写成的可重用组件(类),必须遵循一定的规范。
-
类必须使用 public 修饰。
-
必须保证有公共无参数构造器。
-
包含了属性的操作手段(给属性赋值,获取属性值)。
分类
JavaBean 可分为两种:一种是有用户界面(UI,User Interface)的 JavaBean;还有一种是没有用户界面,主要负责处理事务(如数据运算,操纵数据库)的 JavaBean。
成员
属性(properties) JavaBean 提供了高层次的属性概念,属性在 JavaBean 中不只是传统的面向对象的概念里的属性,它同时还得到了属性读取和属性写入的 API 的支持。
方法(method) JavaBean 中的方法就是通常的 Java 方法,它可以从其他组件或在脚本环境中调用。
事件(event) Bean 与其他软件组件交流信息的主要方式是发送和接受事件。
Eclipse 插件 Lombok
Lombok是一款小巧的代码生成工具。自动生成默认的 getter / setter 方法、自动化的资源管理(通过 @Cleanup 注解)及注解驱动的异常处理等。通过注解的方式,作用域至编译过程中,因此运行效率和项目部署都没有任何影响。
0x04 Java内省具体操作
关键方法和步骤。
-
BeanInfo getBeanInfo(class<?> beanclass)
进行 Bean 内省,获得 Bean 所有属性、公开的方法和事件。 -
PropertyDescriptor[] getPropertyDescriptors()
获取所有属性的描述器(ropertyDescriptor类,用于描述 Java Bean,通过一对存储器方法导出的JavaBean类的一个属性)。 -
迭代
PropertyDescriptor[]
对每个属性进行操作。
@Test
public void testIntrospector() {
try {
// BeanInfo beanInfo = Introspector.getBeanInfo(User.class);
BeanInfo beanInfo = Introspector.getBeanInfo(User.class, Object.class); // 在给定的“断点”(前闭后开),在 Java Bean 上进行内省所有属性和公开的方法。
// User user = User.class.newInstance(); // 反射创建User对象
User user = User.class.getConstructor(String.class, String.class).newInstance("admin", "admin"); // 反射获取有参构造器创建对象
PropertyDescriptor[] pds = beanInfo.getPropertyDescriptors();
for (PropertyDescriptor pd : pds) {
System.out.println("属性名 = " + pd.getName()); // 获取属性名
System.out.println("getter = " + pd.getReadMethod()); // 获取属性getter
System.out.println("setter = " + pd.getWriteMethod()); // 获取属性setter
}
for (PropertyDescriptor pd : pds) { // 调用getter并获取返回值
Object result = pd.getWriteMethod().invoke(user, "admin");
System.out.println(result);
}
} catch (Exception e) {
e.printStackTrace();
}
}
0x05 JavaBean 和 Map 之间的互相转换
Bean 转换为 Map
-
形参:
Object
类对象bean
。返回值:Map
类集合。 -
创建
HashMap
对象map
用于存储 Bean 的描述信息。 -
创建
BeanInfo
类型对象beanInfo
,用Introspector.getBeanInfo()
内省所有属性、字段和公开的方法。 -
创建
PropertyDescriptor[] pds
,存储多个属性的描述信息(描述符)。 -
遍历
pds
,赋值给map
中的<Key, Value>
。
方法代码
public static Map<String, Object> beanToMap(Object bean) {
Map<String, Object> map = new HashMap<>();
try {
BeanInfo beanInfo = Introspector.getBeanInfo(bean.getClass(), Object.class);
PropertyDescriptor[] pds = beanInfo.getPropertyDescriptors();
for (PropertyDescriptor pd : pds) {
String key = pd.getName();
Object value = pd.getReadMethod().invoke(bean);
map.put(key, value);
}
} catch (Exception e) {
e.printStackTrace();
}
return map;
}
测试实例
@Test
public void testBeanToMap() {
Map<String, Object> map = beanToMap(new User("admin", "admin"));
System.out.println(map);
}
Map 转换为 Bean
-
形参:为
Map
类集合map
和泛型T
的字节码类型beanType
,返回值:泛型T
实例。 -
生成指定类型
bean
实例。 -
创建
BeanInfo
类型对象beanInfo
,用Introspector.getBeanInfo()
内省所有属性、字段和公开的方法。 -
创建
PropertyDescriptor[] pds
,存储多个属性的描述信息(描述符)。 -
遍历
pds
,获取Map
中的<Key, Value>
,调用bean
中的setter
给bean
赋值。
方法代码
public static <T> T mapToBean(Map<String, Object> map, Class<T> beanType) {
Object bean = null;
try {
bean = beanType.newInstance();
BeanInfo beanInfo = Introspector.getBeanInfo(beanType, Object.class);
PropertyDescriptor[] pds = beanInfo.getPropertyDescriptors();
for (PropertyDescriptor pd : pds) {
Object value = map.get(pd.getName());
pd.getWriteMethod().invoke(bean, value);
}
} catch (Exception e) {
e.printStackTrace();
}
return (T) bean;
}
测试实例
@Test
public void testMapToBean() {
HashMap<String, Object> map = new HashMap<String, Object>();
map.put("username", "root");
map.put("password", "root");
System.out.println(mapToBean(map, User.class));
}