Jakarta-Common-BeanUtils使用笔记
第一次接触 BeanUtils 是在学习 Struts 的过程中,在 Struts 中它被大量用于处理 FormBean 。
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 的主要功能都在这个包里实现。
下面分别介绍几个主要的工具类:
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
它实现一个动态的 Bean ,可以直接往里面加入属性,作为一个 JavaBean 一样使用,也可以用上面的 BeanUtils 或 get/set 方法进行操作,而不用事先定义一个标准的 JavaBean 类啦:)
记得在 J2ee 设计模式中有一种 Value Object 的模式,用于在 MVC 各层之间传递数据,避免直接传递大业务对象引起的性能问题,为了避免在项目中出现很多 Bean 类,在书中提供了一个动态 Value Object 的实现(通过扩展 Map )。这里 LazyDynaBean 则可以作为一种更加成熟、稳定的实现来使用。呵呵,原来曾打算自己写一个类似的 value object 类的,现在看来可以直接用这个啦: 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.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 类或自定义类的话,还是不要老它大驾转化了。
所有的 XXXUtils 类都提供的是静态方法,可以直接调用,其主要实现都在相应的 XXXUtilsBean 中:
BeanUtils ——> BeanUtilsBean
ConvertUtils ——> ConvertUtilsBean
PropertyUtils ——> PropertyUtilsBean
其意思看类名也应该知道的差不多了,我就不再废话啦!当然你也可以直接调用那些 XXXUtilsBean ,功能都一样!