[Jakarta Commons筆記] Commons BeanUtils - Read Sean(轉載)
Posted on 2007-08-13 22:06 卓韋 閱讀(348) 評論(0) 編輯 收藏Jakarta Commons項目提供了相當豐富的API,我們之前了解到的Commons Lang只是眾多API的比較核心的一小部分而已。Commons下面還有相當數量的子項目,用于解決各種各樣不同方向的實際問題,BeanUtils就是其中的一個,用于處理JavaBeans。它利用Java的反射機制,從動態的生成對bean的getter和setter的調用代碼,到模擬創建一個動態的bean,等等。這個包看似簡單,卻是很多開源項目的基石:如在著名的Struts和Spring Framework中,我們都能找到BeanUtils的影子。大家猜猜看,有哪位名人是BeanUtils的作者之一?沒錯,就是Struts的創始人Craig McClanahan。
BeanUtils最核心的好處在于:我們在編碼時,并不需要知道我們處理的JavaBeans具體是什么類型,有哪些屬性,這些信息是可以動態獲取的,甚至我們都可以不必去關心事實上是否存在這樣一個具體的JavaBean類。我們只需要知道有一個JavaBean的實例,我們需要從中取得某個屬性,設定某個屬性的值,或者僅僅是需要一個屬性表。要做到這些,依靠Sun提供的JavaBean規范似乎找不到一個很直接的方式,除非硬編碼,將getXxxx()和setXxxx()直接寫進我們的程序。但是這樣就大大增加了代碼的復雜度、耦合性和維護成本。還好Commons BeanUtils對這個問題提供了一種優雅的解決方案。
我們有兩種途徑獲取Commons BeanUtils的binary:
1- 從Struts、Spring或者任何依賴BeanUtils的開源產品的發行包中找到相應的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個包:
org.apache.commons.beanutils – 核心包,定義一組Utils類和需要用到的接口規范
org.apache.commons.beanutils.converters – 轉換String到需要類型的類,實現Converter接口
org.apache.commons.beanutils.locale – beanutils的locale敏感版本
org.apache.commons.beanutils.locale.converters – converters的locale敏感版本
org.apache.commons.collections – beanutils使用到的Collection類
其中需要我們特別關注的是這個org.apache.commons.beanutils包,其他包都是起輔助作用的。接下來我們就仔細看一看這個包都有些什么東東:
[4個接口]
Converter
該接口定義了如下方法:
public java.lang.Object convert(java.lang.Class type, java.lang.Object value);
只要實現了這個Converter接口并注冊到ConvertUtils類即可被我們的BeanUtils包所使用,它的主要目的是提供將給定的Object實例轉換為目標類型的算法。我們可以在beanutils.converters包中找到相當多的已經實現的轉換器。
DynaBean
該接口定義的是一個動態的JavaBean,它的屬性類型、名稱和值都是可以動態改變的。
DynaClass
該接口定義的是針對實現了DynaBean接口的類的java.lang.Class對象,提供如getName()、newInstance()等方法。
MutableDynaClass
該接口是對DynaClass的擴展,使得動態bean的屬性可以動態增加或刪除。
[24個類]
BasicDynaBean
DynaBean接口的最精簡實現
BasicDynaClass
DynaClass接口的最精簡實現
BeanUtils
提供通過反射機制填寫JavaBeans屬性的工具/靜態方法
BeanUtilsBean
BeanUtils類的實例化實現,區別于BeanUtils的靜態方法方式,使得自定義的配置得以保持
ConstructorUtils
同MethodUtils類似,不過專注于構造方法
ContextClassLoaderLocal
針對每個classloader的唯一標識
ConvertingWrapDynaBean
包含了標準JavaBean實例的DynaBean實現,使得我們可以使用DynaBean的API來訪問起屬性,同時提供設定屬性時的類型轉換,繼承自并區別于WrapDynaBean
ConvertUtils
提供工具/靜態方法,用于將String對象及其數組轉換為指定的類型的對象及其數組。
ConvertUtilsBean
ConvertUtils類的實例化實現,區別于ConvertUtils的靜態方法方式,使得自定義的配置得以保持
DynaProperty
用于描述DynaBean的屬性
JDBCDynaClass
為DynaClass的JDBC實現提供公用的邏輯
LazyDynaBean
懶載入DynaBean,自動往DynaClass添加屬性并提供懶載入List和懶載入Map的功能
LazyDynaClass
實現MutableDynaClass接口的類
LazyDynaMap
為Map實例提供一個輕量級的DynaBean包裝
MappedPropertyDescriptor
用于描述映射的屬性
MethodUtils
包含了針對一般意義上的方法而非特定屬性的反射工具/靜態方法
MethodUtils.MethodDescriptor
描述通過反射查找某個方法所使用的鍵值
PropertyUtils
提供利用Java反射API調用具體對象的getter和setter的工具/靜態方法
PropertyUtilsBean
PropertyUtils類的實例化實現,區別于PropertyUtils的靜態方法方式,使得自定義的配置得以保持
ResultSetDynaClass
包裝java.sql.ResultSet中的java.sql.Row實例的DynaBean所對應的DynaClass實現
ResultSetIterator
針對ResultSetDynaClass的java.util.Iterator實現
RowSetDynaClass
DynaClass的一種實現,用于在內存中創建一組表示SQL查詢結果的DynaBeans,區別于ResultSetDynaClass,它不需要保持ResultSet打開
WrapDynaBean
DynaBean的一種實現,包含一個標準的JavaBean實例,以便我們可以使用DynaBean的API去訪問它的屬性,區別于ConvertingWrapDynaBean,它不做專門的類型轉換
WrapDynaClass
DynaClass的一種實現,針對那些包裝標準JavaBean實例的DynaBeans
[3個Exception]
(略)
看到這么多東西是不是有點頭暈?不要慌,看幾個例子就明白了。只要把握好BeanUtils本身要完成的事,就不難理解這些類存在的道理。我們不妨把BeanUtils的基礎應用分解成:訪問JavaBean的屬性、設定JavaBean的屬性、以及創建和使用DynaBeans。這樣來看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則可以作為一種更加成熟、穩定的實現來使用: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();
Company
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,功能都一樣