Jakarta-Common-BeanUtils使用笔记

[b] 原文转发[url]http://blog.csdn.net/fanjun/article/details/291662[/url][/b][u][/u]

1. 概述
BeanUtils主要提供了对于JavaBean进行各种操作， 大量用于表单转化。

BeanUtils一共分4个包：

Ø org.apache.commons.beanutils

Ø org.apache.commons.beanutils.converters

Ø org.apache.commons.beanutils.locale

Ø org.apache.commons.beanutils.locale.converters

其中上面两个是BeanUtils的默认实现，它没有针对本地化的任何处理，这个可以提高执行效率。但是若你的程序对于本地化有要求的话，那还是使用下面2个包比较安全。

2. org.apache.commons.beanutils

这个包主要提供用于操作JavaBean的工具类，Jakarta-Common-BeanUtils的主要功能都在这个包里实现。

下面分别介绍几个主要的工具类：

2.1. BeanUtil

1、首先，我先定义一个JavaBean作为之后例子的操作对象。

public class Company

{

    private String    name;
    private HashMap   address = new HashMap();
    private String[]  otherInfo;
    private ArrayList product;
    private ArrayList employee;
    private HashMap   telephone;

    public Company(){
    }

    public String getName() {
        return name;
    }

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

    public String getAddress(String type) {
        return address.get(type).toString();
    }

    public void setAddress(String type, String address) {
        this.address.put(type, address);
    }

    public String[] getOtherInfo()
    {
       return otherInfo;
    }

    public void setOtherInfo(String[] otherInfo)
    {
        this.otherInfo = otherInfo;
    }

    public ArrayList getProduct()
    {
        return product;
    }

    public void setProduct(ArrayList product)
    {
        this.product = product;
    }

    public ArrayList getEmployee()
    {
        return employee;
    }

    public void setEmployee(ArrayList employee)
    {
        this.employee = employee;
    }

    public HashMap getTelephone()
    {
        return telephone;
    }

    public void setTelephone(HashMap telephone)
    {
        this.telephone = telephone;
    }

}

2、BeanUtils可以直接get和set一个属性的值。它将property分成3种类型：

Simple——简单类型，如Stirng、Int……

Indexed——索引类型，如 数组、arrayList……

Maped——这个不用说也该知道，就是指Map啦，比如HashMap……

访问不同类型的数据可以直接调用函数getProperty和setProperty。它们都只有2个参数，第一个是JavaBean对象，第二个是要操作的属性名。

Company c = new Company();

c.setName("Simple");

对于Simple类型，参数二直接是属性名即可

//Simple

System.out.println(BeanUtils.getProperty(c, "name"));

对于Map类型，则需要以“属性名（key值）”的形式

//Map

System.out.println(BeanUtils.getProperty(c, "address (A2)"));

HashMap am = new HashMap();

am.put("1","234-222-1222211");

am.put("2","021-086-1232323");

BeanUtils.setProperty(c,"telephone",am);

System.out.println(BeanUtils.getProperty(c, "telephone (2)"));

对于Indexed，则为“属性名[索引值]”，注意这里对于ArrayList和数组都可以用一样的方式进行操作。

//index

System.out.println(BeanUtils.getProperty(c, "otherInfo[2]"));
BeanUtils.setProperty(c, "product[1]", "NOTES SERVER");
System.out.println(BeanUtils.getProperty(c, "product[1]"));
当然这3种类也可以组合使用啦！

//nest

System.out.println(BeanUtils.getProperty(c, "employee[1].name"));

3、此外，还有一个很重要的方法copyProperty，可以直接进行Bean之间的clone。

Company c2 = new Company();

BeanUtils.copyProperties(c2, c);

但是这种copy都是浅拷贝，复制后的2个Bean的同一个属性可能拥有同一个对象的ref，这个在使用时要小心，特别是对于属性为类的情况。

4、最后还有populate，它用于将一个map的值填充到一个bean中，其函数原型如下：

public void populate(java.lang.Object bean,

java.util.Map properties)

throws java.lang.IllegalAccessException,

java.lang.reflect.InvocationTargetException

在struts中这个函数被用于从http request中取得参数添加到FormBean，目前好像我也没有看到这个函数还有什么其他的用途？！以后想到再说吧：P


2.2. LazyDynaBean

它实现一个动态的Bean，可以直接往里面加入属性，作为一个JavaBean一样使用，也可以用上面的BeanUtils或get/set方法进行操作，而不用事先定义一个标准的JavaBean类啦：）

记得在《J2ee设计模式》中有一种Value Object的模式，用于在MVC各层之间传递数据，避免直接传递大业务对象引起的性能问题，为了避免在项目中出现很多Bean类，在书中提供了一个动态Value Object的实现（通过扩展Map）。这里LazyDynaBean则可以作为一种更加成熟、稳定的实现来使用：P

言归正传，LazyBean的确提供了一个很不错的DynaBean的实现，用起来几乎不需要写什么多余的代码^_^，下面就看看使用的例子吧！

//这里使用LazyDynaMap，它是LazyBean的一个轻量级实现

LazyDynaMap dynaBean1 = new LazyDynaMap();
dynaBean1.set("foo", "bar"); // simple
dynaBean1.set("customer", "title", "Mr"); // mapped
dynaBean1.set("address", 0, "address1"); // indexed
System.out.println(dynaBean1.get("address",0));

Map myMap = dynaBean1.getMap(); // retrieve the Map
System.out.println(myMap.toString());

上面的例子可以看到，它可以在set时自动增加bean的property（既赋值的同时增加Bean中的property），同时也支持3中类型的property，并且LazyDynaMap还可以导出为map。
对于这个类还有两个重要的Field要注意：
returnnull——指定在get方法使用了一个没有定义过的property时，DynaBean的行为。
//取的字段的信息
dynaBean1.setReturnNull(true);//设为ture。若Bean中没有此字段，返回null
//默认为false。若Bean中没有此字段，自动增加一个：）
System.out.println(dynaBean1.get("aaa"));//此时返回null

Restricted——指定是否允许改变这个bean的property。

//MutableDynaClass.setRestricted设为true后，字段不可再增删和修改.

//默认为false，允许增删和修改

dynaBean1.setRestricted(true);

dynaBean1.set("test","error");//这里会出错！



通过设置这两个属性，可以防止意外修改DynaBean的property。在设计架构时，你可以在后台从数据表或xml文件自动产生DynaBean，在传到控制层和表示层之前设置上述属性使其Bean结构不允许修改，如此就不可能无意中修改Bean包含的属性……这样既可以享用它的便利，又可以防止由此引入的错误可能！！

3. 其他

3.1. BeanUtils和PropertyUtils

这两个类几乎有一摸一样的功能，唯一的区别是：BeanUtils在对Bean赋值是会进行类型转化。举例来说也就是在copyProperty时只要属性名相同，就算类型不同，BeanUtils也可以进行copy；而PropertyBean则可能会报错！！

针对上面的例子，新建一个Company2的类，其中代码与Company一样，只是将otherinfo从String[]改为String。

Company c = init();
Company2 c2 = new Company2();
BeanUtils.copyProperties(c2,c);
// PropertyUtils.copyProperties(c2,c); 这句会报错！！
System.out.println(c2.getOtherInfo());

当然2个Bean之间的同名属性的类型必须是可以转化的，否则用BeanUtils一样会报错。

若实现了org.apache.commons.beanutils.Converter接口则可以自定义类型之间的转化。

由于不做类型转化，用PropertyUtils在速度上会有很大提高！

此外，不作类型转化还有一个好处，如下面的代码：

//test data type convert

// ArrayList a1 = BeanUtils.getProperty(c,"product"); //BeanUtils返回的是String

System.out.println("--" + BeanUtils.getProperty(c,"product")); //取出后直接被转为String

ArrayList a = (ArrayList)PropertyUtils.getProperty(c,"product");//PropertyUtils返回的是Object

System.out.println("--" + a.get(1));

用BeanUtils无法返回一个对象（除非自己写一个Converter），它会自动进行类型转化，然后返回String。对于想返回java类或自定义类的话，还是不要老它大驾转化了。


3.2. Utils类

所有的XXXUtils类都提供的是静态方法，可以直接调用，其主要实现都在相应的XXXUtilsBean中：

BeanUtils ——> BeanUtilsBean

ConvertUtils ——> ConvertUtilsBean

PropertyUtils ——> PropertyUtilsBean


其意思看类名也应该知道的差不多了，我就不再废话啦！当然你也可以直接调用那些XXXUtilsBean，功能都一样！