使用BeanUtils来进行对象的组装

jopen 11年前

对于BeanUtils这个工具,我也用的不是很多,但是还是有点心得和大家分享下,呵呵~~用过spring的都知道spring的MVC框架中有一个 BaseCommandController对象,利用这个对象我们就可以很方便的将从客户端传递过来的参数封装到一个JavaBean对象中去,而不需要我们request.getParameter("name");bean.setName(name);了,从而也简化了不少的工作。其实在 structs中也有这样的功能的,不过它用的BeanUtils这个工具类,也就是我今天要给大家说的这个类。

    commons-beanutils组件是Jakarta Commons项目组中的一个,可以到Jakarta官网上去下载。我们今天讨论的主要就是commons-beanutils中的BeanUtils这个类,这个类都是静态方法,可以很方便的操纵各个JavaBean对象,包括获取属性、设置属性等,我们以例子来进行说明。

    假设有如下一个JavaBean对象:

public TestBean
{
    private String stringValue;

    private int intValue;

    public void setStringValue(String value)
    {
        this.stringValue = value;
    }

    public String getStringValue()
    {
        return this.stringValue;
    }

    public void setIntValue(int value)
    {
        this.intValue = value;
    }

    public int getIntValue()
    {
        return this.intValue;
    }
}

    那么我们就可以使用BeanUtils来对其进行设置值和获取值了。如下:

TestBean tb = new TestBean();
BeanUtils.setProperty(tb, "stringValue", "hello world!");
BeanUtils.setProperty(tb, "intValue", 123);

    通过上述的语句我们就可以给新new的对象设置两个属性了,注意其中第一个参数就是我们的属性名称,这里也是我们在使用这个工具的时候最需要注意的地方。这个属性名称就是我们的TestBean中的getXXX方法中的XXX,比如getStringValue中其属性名称就是stringValue,在使用属性名称的时候,除了XXX中的第一个字母不需要大小写之外,其他的部分是需要严格区分大小写的,这也是JavaBean的规范。这里有一点需要特别注意的就是,如果属性名称中第一个单词(我们界定的)只有一个字母的话,那么其属性名称必须大写!我们可以看这样一个例子:

我们给TestBean加如下一个属性:

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

public void getTName()
{
    return this.name;
}
……

    那么在使用BeanUtils进行属性赋值的时候,如果你这样写:

BeanUtils.setProperty(tb, "tName", "hello");

那么就会被抛出一个异常,表示这个属性找不到,因为按照JavaBean的规范,属性名称中如果有多个单词,则每一个单词的首字母要大写!这里BeanUtils就会认为属性TName是两个单词,分别是T和Name,所以取属性的时候第一个字母必须要大写,所以其属性就应该是;TName,那么我们就应该如下写操作语句: 

BeanUtils.setProperty(tb, "TName", "hello");

    这样写才是正确的。那么我们来看在B/S结构的程序中,如何将表单域的参数(不一定是表单域,是参数都可以)转换成一个JavaBean对象,我们以上面的Bean为例子,我们在页面上进行编写如下:

……
<form name="form1" action="/getbean.jsp">
    字符串值:<input type="text" name="stringValue" /><br/>
    数字值:<input type="text" name="intValue" /><br/>
</form>
……

    然后我们在服务器端进行编写如下代码来获取参数,并组装成一个TestBean对象,代码如下:

……
TestBean tb = new TestBean();
BeanUtils.populate(tb, request.getParameterMap());
// 使用BeanUtils工具类来获取对象的属性
System.out.println(BeanUtils.getProperty("stringValue"));
System.out.print(BeanUtils.getProperty("intValue"));
// 直接获取对象的属性
System.out.println(tb.getStringValue());
System.out.println(tb.getIntValue());
……

    我们注意到,在表单区域中编写的几个输入框的名称(红色标识的部分)就是我们的TestBean对象的属性名称,然后服务器端的代码中,我们首先使用 request.getParameterMap()来获取提交的参数,并转换成一个map对象存储(键是参数名称,值是提交的值),然后我们使用 BeanUtils的populate方法来进行赋值。通过打印后,我们可以看到我们输入的值被成功的设置到对象中去了,可以看到简单的两行代码就可以搞定参数到对象的数据绑定工作,如果一个对象有十几个甚至几十个参数属性的话,那么这样的方式将是非常简便的,至少可以少写十几行甚至几十行的代码。

    可以看到利用BeanUtils这个工具类可以很方便的进行JavaBean的属性操作和request的参数到JavaBean的属性绑定操作。其他的功能大家就可以参看它的API文档了~~~~

BeanUtils.populate的作用

首先,它是在org.apache.commons.beanutils.BeanUtils包中的一个方法。方法的作用:用来将一些 key-value 的值(例如 hashmap)映射到 bean 中的属性。 
servlet中有这样的使用:先定义form表单内容的Info对象(当然你要先写一个bean,这个bean中包含form表单中各个对象的属性)    InsuranceInfo info = new InsuranceInfo();  (这是一个javabean)    BeanUtilities.populateBean(info, request);——> populateBean(info, request.getParameterMap());(先将request内容转为Map类型)—— >BeanUtils.populate(info, propertyMap);(调用包中方法映射) 

BeanUtils.populate 有局限性  

如果大家用过BeanUtils.populate的话,就知道,这个方法是可以很方便的将request提交的页面表单自动填写到你创建的对象中。
今天突然做一个有文件上传功能的页面,BeanUtils.populate(model, request.getParameterMap());本想用这个方法的,发现request.getParameterMap 得不到数据,单独用request.getParameter确可以。
<FORM name=uploadFrm action="bidFileTemplate?method=add" method="post" encType="multipart/form-data" >
如果将form 的encType属性去掉了就可以了。看来以后做事要小心点了,不过用struts等框架的话当然没这个讨论性了。