[Jakarta Commons筆記](méi) Commons BeanUtils - Read Sean(轉(zhuǎn)載)
Posted on 2007-08-13 22:06 卓韋 閱讀(347) 評(píng)論(0) 編輯 收藏Jakarta Commons項(xiàng)目提供了相當(dāng)豐富的API,我們之前了解到的Commons Lang只是眾多API的比較核心的一小部分而已。Commons下面還有相當(dāng)數(shù)量的子項(xiàng)目,用于解決各種各樣不同方向的實(shí)際問(wèn)題,BeanUtils就是其中的一個(gè),用于處理JavaBeans。它利用Java的反射機(jī)制,從動(dòng)態(tài)的生成對(duì)bean的getter和setter的調(diào)用代碼,到模擬創(chuàng)建一個(gè)動(dòng)態(tài)的bean,等等。這個(gè)包看似簡(jiǎn)單,卻是很多開(kāi)源項(xiàng)目的基石:如在著名的Struts和Spring Framework中,我們都能找到BeanUtils的影子。大家猜猜看,有哪位名人是BeanUtils的作者之一?沒(méi)錯(cuò),就是Struts的創(chuàng)始人Craig McClanahan。
BeanUtils最核心的好處在于:我們?cè)诰幋a時(shí),并不需要知道我們處理的JavaBeans具體是什么類(lèi)型,有哪些屬性,這些信息是可以動(dòng)態(tài)獲取的,甚至我們都可以不必去關(guān)心事實(shí)上是否存在這樣一個(gè)具體的JavaBean類(lèi)。我們只需要知道有一個(gè)JavaBean的實(shí)例,我們需要從中取得某個(gè)屬性,設(shè)定某個(gè)屬性的值,或者僅僅是需要一個(gè)屬性表。要做到這些,依靠Sun提供的JavaBean規(guī)范似乎找不到一個(gè)很直接的方式,除非硬編碼,將getXxxx()和setXxxx()直接寫(xiě)進(jìn)我們的程序。但是這樣就大大增加了代碼的復(fù)雜度、耦合性和維護(hù)成本。還好Commons BeanUtils對(duì)這個(gè)問(wèn)題提供了一種優(yōu)雅的解決方案。
我們有兩種途徑獲取Commons BeanUtils的binary:
1- 從Struts、Spring或者任何依賴BeanUtils的開(kāi)源產(chǎn)品的發(fā)行包中找到相應(yīng)的jar文件;
2- 從http://www.apache.org/dist/jakarta/commons/beanutils/binaries/下載。
Commons BeanUtils的源碼下載地址:
http://www.apache.org/dist/jakarta/commons/beanutils/source/
Commons BeanUtils一共包括如下5個(gè)包:
org.apache.commons.beanutils – 核心包,定義一組Utils類(lèi)和需要用到的接口規(guī)范
org.apache.commons.beanutils.converters – 轉(zhuǎn)換String到需要類(lèi)型的類(lèi),實(shí)現(xiàn)Converter接口
org.apache.commons.beanutils.locale – beanutils的locale敏感版本
org.apache.commons.beanutils.locale.converters – converters的locale敏感版本
org.apache.commons.collections – beanutils使用到的Collection類(lèi)
其中需要我們特別關(guān)注的是這個(gè)org.apache.commons.beanutils包,其他包都是起輔助作用的。接下來(lái)我們就仔細(xì)看一看這個(gè)包都有些什么東東:
[4個(gè)接口]
Converter
該接口定義了如下方法:
public java.lang.Object convert(java.lang.Class type, java.lang.Object value);
只要實(shí)現(xiàn)了這個(gè)Converter接口并注冊(cè)到ConvertUtils類(lèi)即可被我們的BeanUtils包所使用,它的主要目的是提供將給定的Object實(shí)例轉(zhuǎn)換為目標(biāo)類(lèi)型的算法。我們可以在beanutils.converters包中找到相當(dāng)多的已經(jīng)實(shí)現(xiàn)的轉(zhuǎn)換器。
DynaBean
該接口定義的是一個(gè)動(dòng)態(tài)的JavaBean,它的屬性類(lèi)型、名稱(chēng)和值都是可以動(dòng)態(tài)改變的。
DynaClass
該接口定義的是針對(duì)實(shí)現(xiàn)了DynaBean接口的類(lèi)的java.lang.Class對(duì)象,提供如getName()、newInstance()等方法。
MutableDynaClass
該接口是對(duì)DynaClass的擴(kuò)展,使得動(dòng)態(tài)bean的屬性可以動(dòng)態(tài)增加或刪除。
[24個(gè)類(lèi)]
BasicDynaBean
DynaBean接口的最精簡(jiǎn)實(shí)現(xiàn)
BasicDynaClass
DynaClass接口的最精簡(jiǎn)實(shí)現(xiàn)
BeanUtils
提供通過(guò)反射機(jī)制填寫(xiě)JavaBeans屬性的工具/靜態(tài)方法
BeanUtilsBean
BeanUtils類(lèi)的實(shí)例化實(shí)現(xiàn),區(qū)別于BeanUtils的靜態(tài)方法方式,使得自定義的配置得以保持
ConstructorUtils
同MethodUtils類(lèi)似,不過(guò)專(zhuān)注于構(gòu)造方法
ContextClassLoaderLocal
針對(duì)每個(gè)classloader的唯一標(biāo)識(shí)
ConvertingWrapDynaBean
包含了標(biāo)準(zhǔn)JavaBean實(shí)例的DynaBean實(shí)現(xiàn),使得我們可以使用DynaBean的API來(lái)訪問(wèn)起屬性,同時(shí)提供設(shè)定屬性時(shí)的類(lèi)型轉(zhuǎn)換,繼承自并區(qū)別于WrapDynaBean
ConvertUtils
提供工具/靜態(tài)方法,用于將String對(duì)象及其數(shù)組轉(zhuǎn)換為指定的類(lèi)型的對(duì)象及其數(shù)組。
ConvertUtilsBean
ConvertUtils類(lèi)的實(shí)例化實(shí)現(xiàn),區(qū)別于ConvertUtils的靜態(tài)方法方式,使得自定義的配置得以保持
DynaProperty
用于描述DynaBean的屬性
JDBCDynaClass
為DynaClass的JDBC實(shí)現(xiàn)提供公用的邏輯
LazyDynaBean
懶載入DynaBean,自動(dòng)往DynaClass添加屬性并提供懶載入List和懶載入Map的功能
LazyDynaClass
實(shí)現(xiàn)MutableDynaClass接口的類(lèi)
LazyDynaMap
為Map實(shí)例提供一個(gè)輕量級(jí)的DynaBean包裝
MappedPropertyDescriptor
用于描述映射的屬性
MethodUtils
包含了針對(duì)一般意義上的方法而非特定屬性的反射工具/靜態(tài)方法
MethodUtils.MethodDescriptor
描述通過(guò)反射查找某個(gè)方法所使用的鍵值
PropertyUtils
提供利用Java反射API調(diào)用具體對(duì)象的getter和setter的工具/靜態(tài)方法
PropertyUtilsBean
PropertyUtils類(lèi)的實(shí)例化實(shí)現(xiàn),區(qū)別于PropertyUtils的靜態(tài)方法方式,使得自定義的配置得以保持
ResultSetDynaClass
包裝java.sql.ResultSet中的java.sql.Row實(shí)例的DynaBean所對(duì)應(yīng)的DynaClass實(shí)現(xiàn)
ResultSetIterator
針對(duì)ResultSetDynaClass的java.util.Iterator實(shí)現(xiàn)
RowSetDynaClass
DynaClass的一種實(shí)現(xiàn),用于在內(nèi)存中創(chuàng)建一組表示SQL查詢結(jié)果的DynaBeans,區(qū)別于ResultSetDynaClass,它不需要保持ResultSet打開(kāi)
WrapDynaBean
DynaBean的一種實(shí)現(xiàn),包含一個(gè)標(biāo)準(zhǔn)的JavaBean實(shí)例,以便我們可以使用DynaBean的API去訪問(wèn)它的屬性,區(qū)別于ConvertingWrapDynaBean,它不做專(zhuān)門(mén)的類(lèi)型轉(zhuǎn)換
WrapDynaClass
DynaClass的一種實(shí)現(xiàn),針對(duì)那些包裝標(biāo)準(zhǔn)JavaBean實(shí)例的DynaBeans
[3個(gè)Exception]
(略)
看到這么多東西是不是有點(diǎn)頭暈?不要慌,看幾個(gè)例子就明白了。只要把握好BeanUtils本身要完成的事,就不難理解這些類(lèi)存在的道理。我們不妨把BeanUtils的基礎(chǔ)應(yīng)用分解成:訪問(wèn)JavaBean的屬性、設(shè)定JavaBean的屬性、以及創(chuàng)建和使用DynaBeans。這樣來(lái)看BeanUtils,你就會(huì)覺(jué)得簡(jiǎn)單清晰得多。
用法:
第一次接觸BeanUtils是在學(xué)習(xí)Struts的過(guò)程中,在Struts中它被大量用于處理FormBean。
BeanUtils主要提供了對(duì)于JavaBean進(jìn)行各種操作,
BeanUtils一共分4個(gè)包:
Ø org.apache.commons.beanutils
Ø org.apache.commons.beanutils.converters
Ø org.apache.commons.beanutils.locale
Ø org.apache.commons.beanutils.locale.converters
其中上面兩個(gè)是BeanUtils的默認(rèn)實(shí)現(xiàn),它沒(méi)有針對(duì)本地化的任何處理,這個(gè)可以提高執(zhí)行效率。但是若你的程序?qū)τ诒镜鼗幸蟮脑挘沁€是使用下面2個(gè)包比較安全。
2. org.apache.commons.beanutils
這個(gè)包主要提供用于操作JavaBean的工具類(lèi),Jakarta-Common-BeanUtils的主要功能都在這個(gè)包里實(shí)現(xiàn)。
下面分別介紹幾個(gè)主要的工具類(lèi):
1、首先,我先定義一個(gè)JavaBean作為之后例子的操作對(duì)象。
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一個(gè)屬性的值。它將property分成3種類(lèi)型:
Simple——簡(jiǎn)單類(lèi)型,如Stirng、Int……
Indexed——索引類(lèi)型,如 數(shù)組、arrayList……
Maped——這個(gè)不用說(shuō)也該知道,就是指Map啦,比如HashMap……
訪問(wèn)不同類(lèi)型的數(shù)據(jù)可以直接調(diào)用函數(shù)getProperty和setProperty。它們都只有2個(gè)參數(shù),第一個(gè)是JavaBean對(duì)象,第二個(gè)是要操作的屬性名。
Company c = new Company();
c.setName("Simple");
對(duì)于Simple類(lèi)型,參數(shù)二直接是屬性名即可
//Simple
System.out.println(BeanUtils.getProperty(c, "name"));
對(duì)于Map類(lèi)型,則需要以“屬性名(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)"));
對(duì)于Indexed,則為“屬性名[索引值]”,注意這里對(duì)于ArrayList和數(shù)組都可以用一樣的方式進(jìn)行操作。
//index
System.out.println(BeanUtils.getProperty(c, "otherInfo[2]"));
BeanUtils.setProperty(c, "product[1]", "NOTES SERVER");
System.out.println(BeanUtils.getProperty(c, "product[1]"));
當(dāng)然這3種類(lèi)也可以組合使用啦!
//nest
System.out.println(BeanUtils.getProperty(c, "employee[1].name"));
3、此外,還有一個(gè)很重要的方法copyProperty,可以直接進(jìn)行Bean之間的clone。
Company c2 = new Company();
BeanUtils.copyProperties(c2, c);
但是這種copy都是淺拷貝,復(fù)制后的2個(gè)Bean的同一個(gè)屬性可能擁有同一個(gè)對(duì)象的ref,這個(gè)在使用時(shí)要小心,特別是對(duì)于屬性為類(lèi)的情況。
4、最后還有populate,它用于將一個(gè)map的值填充到一個(gè)bean中,其函數(shù)原型如下:
public void populate(java.lang.Object bean,
java.util.Map properties)
throws java.lang.IllegalAccessException,
java.lang.reflect.InvocationTargetException
在struts中這個(gè)函數(shù)被用于從http request中取得參數(shù)添加到FormBean,目前好像我也沒(méi)有看到這個(gè)函數(shù)還有什么其他的用途?!以后想到再說(shuō)吧:P
它實(shí)現(xiàn)一個(gè)動(dòng)態(tài)的Bean,可以直接往里面加入屬性,作為一個(gè)JavaBean一樣使用,也可以用上面的BeanUtils或get/set方法進(jìn)行操作,而不用事先定義一個(gè)標(biāo)準(zhǔn)的JavaBean類(lèi)啦:)
記得在《J2ee設(shè)計(jì)模式》中有一種Value Object的模式,用于在MVC各層之間傳遞數(shù)據(jù),避免直接傳遞大業(yè)務(wù)對(duì)象引起的性能問(wèn)題,為了避免在項(xiàng)目中出現(xiàn)很多Bean類(lèi),在書(shū)中提供了一個(gè)動(dòng)態(tài)Value Object的實(shí)現(xiàn)(通過(guò)擴(kuò)展Map)。這里LazyDynaBean則可以作為一種更加成熟、穩(wěn)定的實(shí)現(xiàn)來(lái)使用:P
言歸正傳,LazyBean的確提供了一個(gè)很不錯(cuò)的DynaBean的實(shí)現(xiàn),用起來(lái)幾乎不需要寫(xiě)什么多余的代碼^_^,下面就看看使用的例子吧!
//這里使用LazyDynaMap,它是LazyBean的一個(gè)輕量級(jí)實(shí)現(xiàn)
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時(shí)自動(dòng)增加bean的property(既賦值的同時(shí)增加Bean中的property),同時(shí)也支持3中類(lèi)型的property,并且LazyDynaMap還可以導(dǎo)出為map。
對(duì)于這個(gè)類(lèi)還有兩個(gè)重要的Field要注意:
returnnull——指定在get方法使用了一個(gè)沒(méi)有定義過(guò)的property時(shí),DynaBean的行為。
//取的字段的信息
dynaBean1.setReturnNull(true);//設(shè)為ture。若Bean中沒(méi)有此字段,返回null
//默認(rèn)為false。若Bean中沒(méi)有此字段,自動(dòng)增加一個(gè):)
System.out.println(dynaBean1.get("aaa"));//此時(shí)返回null
Restricted——指定是否允許改變這個(gè)bean的property。
//MutableDynaClass.setRestricted設(shè)為true后,字段不可再增刪和修改.
//默認(rèn)為false,允許增刪和修改
dynaBean1.setRestricted(true);
dynaBean1.set("test","error");//這里會(huì)出錯(cuò)!
通過(guò)設(shè)置這兩個(gè)屬性,可以防止意外修改DynaBean的property。在設(shè)計(jì)架構(gòu)時(shí),你可以在后臺(tái)從數(shù)據(jù)表或xml文件自動(dòng)產(chǎn)生DynaBean,在傳到控制層和表示層之前設(shè)置上述屬性使其Bean結(jié)構(gòu)不允許修改,如此就不可能無(wú)意中修改Bean包含的屬性……這樣既可以享用它的便利,又可以防止由此引入的錯(cuò)誤可能!!
3.1. BeanUtils和PropertyUtils
這兩個(gè)類(lèi)幾乎有一摸一樣的功能,唯一的區(qū)別是:BeanUtils在對(duì)Bean賦值是會(huì)進(jìn)行類(lèi)型轉(zhuǎn)化。舉例來(lái)說(shuō)也就是在copyProperty時(shí)只要屬性名相同,就算類(lèi)型不同,BeanUtils也可以進(jìn)行copy;而PropertyBean則可能會(huì)報(bào)錯(cuò)!!
針對(duì)上面的例子,新建一個(gè)Company2的類(lèi),其中代碼與Company一樣,只是將otherinfo從String[]改為String。
Company c = init();
Company
BeanUtils.copyProperties(c2,c);
// PropertyUtils.copyProperties(c2,c); 這句會(huì)報(bào)錯(cuò)!!
System.out.println(c2.getOtherInfo());
當(dāng)然2個(gè)Bean之間的同名屬性的類(lèi)型必須是可以轉(zhuǎn)化的,否則用BeanUtils一樣會(huì)報(bào)錯(cuò)。
若實(shí)現(xiàn)了org.apache.commons.beanutils.Converter接口則可以自定義類(lèi)型之間的轉(zhuǎn)化。
由于不做類(lèi)型轉(zhuǎn)化,用PropertyUtils在速度上會(huì)有很大提高!
此外,不作類(lèi)型轉(zhuǎn)化還有一個(gè)好處,如下面的代碼:
//test data type convert
// ArrayList a1 = BeanUtils.getProperty(c,"product"); //BeanUtils返回的是String
System.out.println("--" + BeanUtils.getProperty(c,"product")); //取出后直接被轉(zhuǎn)為String
ArrayList a = (ArrayList)PropertyUtils.getProperty(c,"product");//PropertyUtils返回的是Object
System.out.println("--" + a.get(1));
用BeanUtils無(wú)法返回一個(gè)對(duì)象(除非自己寫(xiě)一個(gè)Converter),它會(huì)自動(dòng)進(jìn)行類(lèi)型轉(zhuǎn)化,然后返回String。對(duì)于想返回java類(lèi)或自定義類(lèi)的話,還是不要老它大駕轉(zhuǎn)化了。
3.2. Utils類(lèi)
所有的XXXUtils類(lèi)都提供的是靜態(tài)方法,可以直接調(diào)用,其主要實(shí)現(xiàn)都在相應(yīng)的XXXUtilsBean中:
BeanUtils ——> BeanUtilsBean
ConvertUtils ——> ConvertUtilsBean
PropertyUtils ——> PropertyUtilsBean
其意思看類(lèi)名也應(yīng)該知道的差不多了,我就不再?gòu)U話啦!當(dāng)然你也可以直接調(diào)用那些XXXUtilsBean,功能都一樣