Jakarta-Common-BeanUtils使用筆記
?????? 第一次接觸 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),它沒有針對(duì)本地化的任何處理,這個(gè)可以提高執(zhí)行效率。但是若你的程序?qū)τ诒镜鼗幸蟮脑挘沁€是使用下面
2
個(gè)包比較安全。
2. ?? org.apache.commons.beanutils
??????
這個(gè)包主要提供用于操作
JavaBean
的工具類,
Jakarta-Common-BeanUtils
的主要功能都在這個(gè)包里實(shí)現(xiàn)。
??? 下面分別介紹幾個(gè)主要的工具類:
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 種類型:
?????? Simple ——簡(jiǎn)單類型,如 Stirng 、 Int ……
?????? Indexed ——索引類型,如 數(shù)組、 arrayList ……
?????? Maped ——這個(gè)不用說(shuō)也該知道,就是指 Map 啦,比如 HashMap ……
?????? 訪問不同類型的數(shù)據(jù)可以直接調(diào)用函數(shù) getProperty 和 setProperty 。它們都只有 2 個(gè)參數(shù),第一個(gè)是 JavaBean 對(duì)象,第二個(gè)是要操作的屬性名。
Company c = new Company();
c.setName("Simple");
對(duì)于 Simple 類型,參數(shù)二直接是屬性名即可
//Simple
???
System.out.println(BeanUtils.getProperty(c, "name"));
??? 對(duì)于 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)"));
??? 對(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 種類也可以組合使用啦!
???
//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ì)于屬性為自定義類的情況。
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 ,目前好像我也沒有看到這個(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 類啦:)
記得在 J2ee 設(shè)計(jì)模式中有一種 Value Object 的模式,用于在 MVC 各層之間傳遞數(shù)據(jù),避免直接傳遞大業(yè)務(wù)對(duì)象引起的性能問題,為了避免在項(xiàng)目中出現(xiàn)很多 Bean 類,在書中提供了一個(gè)動(dòng)態(tài) Value Object 的實(shí)現(xiàn)(通過(guò)擴(kuò)展 Map )。這里 LazyDynaBean 則可以作為一種更加成熟、穩(wěn)定的實(shí)現(xiàn)來(lái)使用。呵呵,原來(lái)曾打算自己寫一個(gè)類似的 value object 類的,現(xiàn)在看來(lái)可以直接用這個(gè)啦: P
?????? 言歸正傳, LazyBean 的確提供了一個(gè)很不錯(cuò)的 DynaBean 的實(shí)現(xiàn)。而且就像它的名字中表述的那樣,它的確是為我這樣的懶人考慮的很周到,用起來(lái)幾乎不需要寫什么多余的代碼 ^_^ ,下面就看看使用的例子吧!
??????
?
//
這里使用
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 中類型的 property ,并且 LazyDynaMap 還可以導(dǎo)出為 map 。
?????? 對(duì)于這個(gè)類還有兩個(gè)重要的 Field 要注意:
?????? returnnull ——指定在 get 方法使用了一個(gè)沒有定義過(guò)的 property 時(shí), DynaBean 的行為。
??????
?
//
取的字段的信息
?????
dynaBean1.setReturnNull(true);
//
設(shè)為
ture
。若
Bean
中沒有此字段,返回
null
???
????????????????????????????//
默認(rèn)為
false
。若
Bean
中沒有此字段,自動(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ò)誤可能,設(shè)計(jì)者實(shí)在深得偷懶的精髓啊!!!!!
3.1. BeanUtils 和 PropertyUtils
?????? 這兩個(gè)類幾乎有一摸一樣的功能,唯一的區(qū)別是: BeanUtils 在對(duì) Bean 賦值是會(huì)進(jìn)行類型轉(zhuǎn)化。舉例來(lái)說(shuō)也就是在 copyProperty 時(shí)只要屬性名相同,就算類型不同, BeanUtils 也可以進(jìn)行 copy ;而 PropertyBean 則可能會(huì)報(bào)錯(cuò)!!
?????? 針對(duì)上面的例子,新建一個(gè) Company2 的類,其中代碼與 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 之間的同名屬性的類型必須是可以轉(zhuǎn)化的,否則用 BeanUtils 一樣會(huì)報(bào)錯(cuò)。
?????? 若實(shí)現(xiàn)了 org.apache.commons.beanutils.Converter 接口則可以自定義類型之間的轉(zhuǎn)化。
由于不做類型轉(zhuǎn)化,用 PropertyUtils 在速度上會(huì)有很大提高!
此外,不作類型轉(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ì)象(除非自己寫一個(gè) Converter ),它會(huì)自動(dòng)進(jìn)行類型轉(zhuǎn)化,然后返回 String 。對(duì)于想返回 java 類或自定義類的話,還是不要老它大駕轉(zhuǎn)化了。
?????? 所有的 XXXUtils 類都提供的是靜態(tài)方法,可以直接調(diào)用,其主要實(shí)現(xiàn)都在相應(yīng)的 XXXUtilsBean 中:
BeanUtils? ??
——> BeanUtilsBean
??????
ConvertUtils?
——> ConvertUtilsBean
??? PropertyUtils ——> PropertyUtilsBean
其意思看類名也應(yīng)該知道的差不多了,我就不再?gòu)U話啦!當(dāng)然你也可以直接調(diào)用那些 XXXUtilsBean ,功能都一樣!
posted on 2006-03-26 15:13 chenhui 閱讀(121) 評(píng)論(0) 編輯 收藏