Apache Commons BeanUtils包学习

 

Apache Commons BeanUtils 包学习

一、简介：

BeanUtils 提供对   Java 反射和自省 API 的包装。其主要目的是利用反射机制对 JavaBean 的属性进行处理。我们知道，一个 JavaBean 通常包含了大量的属性，很多情况下，对 JavaBean 的处理导致大量 get/set 代码堆积，增加了代码长度和阅读代码的难度。

二、用法：

BeanUtils 是这个包里比较常用的一个工具类，这里只介绍它的 copyProperties() 方法。该方法定义如下：

public static void copyProperties(java.lang.Object dest,java.lang.Object orig)
   throws java.lang.IllegalAccessException,
         java.lang.reflect.InvocationTargetException

如果你有两个具有很多相同属性的 JavaBean ，一个很常见的情况就是 Struts 里的 PO 对象（持久对象）和对应的 ActionForm ，例如   Teacher 和 TeacherForm 。我们一般会在 Action 里从 ActionForm 构造一个 PO 对象，传统的方式是使用类似下面的语句对属性逐个赋值：

// 得到 TeacherForm
TeacherForm teacherForm=(TeacherForm)form;
// 构造 Teacher 对象
Teacher teacher=new Teacher();
// 赋值
teacher.setName(teacherForm.getName());
teacher.setAge(teacherForm.getAge());
teacher.setGender(teacherForm.getGender());
teacher.setMajor(teacherForm.getMajor());
teacher.setDepartment(teacherForm.getDepartment());

// 持久化 Teacher 对象到数据库
HibernateDAO=;
HibernateDAO.save(teacher);

而使用 BeanUtils 后，代码就大大改观了，如下所示：
// 得到 TeacherForm
TeacherForm teacherForm=(TeacherForm)form;
// 构造 Teacher 对象
Teacher teacher=new Teacher();
// 赋值
BeanUtils.copyProperties(teacher,teacherForm);
// 持久化 Teacher 对象到数据库
HibernateDAO=;
HibernateDAO.save(teacher);

如果 Teacher 和 TeacherForm 间存在名称不相同的属性，则 BeanUtils 不对这些属性进行处理，需要程序员手动处理。例如   Teacher 包含 modifyDate （该属性记录最后修改日期，不需要用户在界面中输入）属性而 TeacherForm 无此属性，那么在上面代码的   copyProperties() 后还要加上一句：

teacher.setModifyDate(new Date());

怎么样，很方便吧！除 BeanUtils 外还有一个名为 PropertyUtils 的工具类，它也提供 copyProperties() 方法，作用与 BeanUtils 的同名方法十分相似，主要的区别在于后者提供类型转换功能，即发现两个 JavaBean 的同名属性为不同类型时，在支持的数据类型范围内进行转换，而前者不支持这个功能，但是速度会更快一些。 BeanUtils 支持的转换类型如下：

     * java.lang.BigDecimal
     * java.lang.BigInteger
     * boolean and java.lang.Boolean
     * byte and java.lang.Byte
     * char and java.lang.Character
     * java.lang.Class
     * double and java.lang.Double
     * float and java.lang.Float
     * int and java.lang.Integer
     * long and java.lang.Long
     * short and java.lang.Short
     * java.lang.String
     * java.sql.Date
     * java.sql.Time
     * java.sql.Timestamp

这里要注意一点， java.util.Date 是不被支持的，而它的子类 java.sql.Date 是被支持的。因此如果对象包含时间类型的属性，且希望被转换的时候，一定要使用 java.sql.Date 类型。否则在转换时会提示 argument mistype 异常。

三、优缺点：

Apache Jakarta Commons 项目非常有用。我曾在许多不同的项目上或直接或间接地使用各种流行的 commons 组件。其中的一个强大的组件就是 BeanUtils 。我将说明如何使用 BeanUtils 将 local 实体 bean 转换为对应的 value   对象：

BeanUtils.copyProperties(aValue, aLocal)

有关动态 bean 的一些用法，涉及到的类如下：  

1 、 DynaBean 是一个接口，它的实现类有 BasicDynaBean 、 LazyDynaBean 、 ResultSetIterator 、 WrapDyna­Bean  
2 、 DynaClass ，也是接口，它的实现类有 BasicDynaClass 、 WrapDynaClass 等  
3 、 DynaProperty ，用来设置动态 bean 的属性  
4 、 PropertyUtils ，工具类，主要用来设置、取得属性值  
等等，可以查阅 commons-beanutils.jar  

这里列举一个例子，讲述它的用法，代码如下：  

① 动态设置了三个属性 id 、 name 、 email

DynaProperty[] property = { 
new DynaProperty("id", Class.forName("java.lang.String")), 
new DynaProperty("name", Class.forName("java.lang.String")), 
new DynaProperty("email", Class.forName("java.lang.String")) 
};

② 创建一个 dynaClass ，通过 dynaClass 来创建 DynaBean 的实例

DynaClass dynaClass = new BasicDynaClass("bean", null, property); 
DynaBean bean = dynaClass.newInstance();

③ 通过 PropertyUtils 来设置属性值

PropertyUtils.setProperty (bean, "id", "001"); 
PropertyUtils.setProperty (bean, "name", "iplan"); 
PropertyUtils.setProperty (bean, "email", "l...@love.com");

④ 通过以上的设置，这个 bean 就可以像平时的 javabean 一样来使用了  
当然，不是 xxx.getId() ，而是 bean.get("id"); 的用法  

说明：在 ① 处，除了设置一般的类型外，也可以设置其它类型（如 java.util.List 等），还可以是一般的 javabean 。  
在 ② 处，在构造函数中的 "bean" ，是描述它的一个标记  
在 ③ 处，可以不采用 PropertyUtils 来设置属性值，而是直接通过如下方式

bean.set("id", "001"); 
bean.set("name", "iplan"); 
bean.set("email", "l...@love.com");

总结一下：要使用 BasicDynaBean ，就首先要构造一个 BasicDynaClass 来包含期望的数据结构。

上面的代码从 aLocal 对象复制属性到 aValue 对象。它相当简单！它不管 local （或对应的 value ）对象有多少个属性，只管进行复制。我们假设 local 对象有 100 个属性。上面的代码使我们可以无需键入至少 100 行的冗长、容易出错和反复的 get 和 set 方法调用。这太棒了！太强大了！太有用了！

现在，还有一个坏消息：使用 BeanUtils 的成本惊人地昂贵！我做了一个简单的测试， BeanUtils 所花费的时间要超过取数据、将其复制到对应的   value 对象（通过手动调用 get 和 set 方法），以及通过串行化将其返回到远程的客户机的时间总和。所以要小心使用这种威力！