Jakarta-Common-BeanUtils使用筆記

碼頭工人 11年前發布 | 17K 次閱讀 BeanUtils Java開發

1. 概述

第一次接觸 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 的主要功能都在這個包里實現。

下面分別介紹幾個主要的工具類:

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 則可以作為一種更加成熟、穩定的實現來使用。呵呵,原來曾打算自己寫一個類似的 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. 其他

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 ,功能都一樣!

 本文由用戶 碼頭工人 自行上傳分享,僅供網友學習交流。所有權歸原作者,若您的權利被侵害,請聯系管理員。
 轉載本站原創文章,請注明出處,并保留原始鏈接、圖片水印。
 本站是一個以用戶分享為主的開源技術平臺,歡迎各類分享!