初用apache.commons.beanutils.BeanUtils
轉(zhuǎn)貼
fy198392
2005-11-25 11:23:59
查看評論 引言
該class提供了一系列的靜態(tài)方法操作業(yè)已存在的符合JavaBean規(guī)范定義的Java Class.這里強調(diào)的JavaBean規(guī)范,簡單來說就是一個Java Class通過一系列g(shù)etter和setter的方法向外界展示其內(nèi)在的成員變量(屬性).通過BeanUtils的靜態(tài)方法,我們可以:
復(fù)制一個JavaBean的實例--BeanUtils.cloneBean(); 在一個JavaBean的兩個實例之間復(fù)制屬性--BeanUtils.copyProperties(),BeanUtils.copyProperty(); 為一個JavaBean的實例設(shè)置成員變量(屬性)值--BeanUtils.populate(),BeanUtils.setProperty(); 從一個一個JavaBean的實例中讀取成員變量(屬性)的值--BeanUtils.getArrayProperty(),BeanUtils.getIndexedProperty(),BeanUtils.getMappedProperty(),BeanUtils.getNestedProperty(),BeanUtils.getSimpleProperty(),BeanUtils.getProperty(),BeanUtils.describe();
總的來看BeanUtils類提供了兩大類的功能:讀,寫成員變量.
準備工作
下面逐一分析使用方法.首先我們建立兩個JavaBean,名位SampleObject和SampleObjectA,具體如下:
package beanutil;
import java.util.HashMap;
import java.util.Map;
/**
* @author samepoint
*
* SampleObject contains some types of member varaibles:String,int,Array,Map,Object(self defined),just for test usaged of apache.commons.beanutils.BeanUtils
*/
public class SampleObject {
String name = null;
String display = null;
int num = -1;
char[] words = {‘a(chǎn)‘,‘b‘,‘c‘,‘d‘};
boolean tag = false;
Map map = new HashMap();
SampleObjectA sample = null;
/**
* default constructor. initialized members of map and sample.
*/
public SampleObject() {
this.map.put("home","localhost");
this.map.put("port","80");
}
//the following is getters and setters
/**
* @return Returns the display.
*/
public String getDisplay() {
return display;
}
/**
* @param display The display to set.
*/
public void setDisplay(String display) {
this.display = display;
}
/**
* @return Returns the name.
*/
public String getName() {
return name;
}
/**
* @param name The name to set.
*/
public void setName(String name) {
this.name = name;
}
/**
* @return Returns the num.
*/
public int getNum() {
return num;
}
/**
* @param num The num to set.
*/
public void setNum(int num) {
this.num = num;
}
/**
* @return Returns the words.
*/
public char[] getWords() {
return words;
}
/**
* @param words The words to set.
*/
public void setWords(char[] words) {
this.words = words;
}
/**
* @return Returns the tag.
*/
public boolean isTag() {
return tag;
}
/**
* @param tag The tag to set.
*/
public void setTag(boolean tag) {
this.tag = tag;
}
/**
* @return Returns the map.
*/
public Map getMap() {
return map;
}
/**
* @param map The map to set.
*/
public void setMap(Map map) {
this.map = map;
}
/**
* @return Returns the sample.
*/
public SampleObject getSample() {
return sample;
}
/**
* @param sample The sample to set.
*/
public void setSample(SampleObject sample) {
this.sample = sample;
}
}
package beanutil;
/**
* @author samepoint
*
* Used to copy properties from SampleOjbect.
* Used to nested property.
*/
public class SampleObjectA {
String name = null;
String display = null;
Double num = null;
/**
* @return Returns the num.
*/
public Double getNum() {
return num;
}
/**
* @param num The num to set.
*/
public void setNum(Double num) {
this.num = num;
}
/**
* @return Returns the display.
*/
public String getDisplay() {
return display;
}
/**
* @param display The display to set.
*/
public void setDisplay(String display) {
this.display = display;
}
/**
* @return Returns the name.
*/
public String getName() {
return name;
}
/**
* @param name The name to set.
*/
public void setName(String name) {
this.name = name;
}
}
所有測試使用的bean,如果未有說明,均使用SampleObject.
所有測試使用的bean,如果未有說明,均使用SampleObject. BeanUtils.cloneBean(java.lang.object bean)
為bean創(chuàng)建一個clone對象,方法返回類型為Object.注意bean即使沒有實現(xiàn)java.lang.Cloneable接口,此方法依然有效.此方法的實現(xiàn)機制建立在bean提供的一系列的getters和setters的基礎(chǔ)之上.此方法的正常使用代碼非常簡單,故略掉.
下面討論下如果bean沒有提供getters和setters,會出現(xiàn)什么情況,很明顯如果將其中的一對getter和setter注釋掉,如getDisplay()和setDisplay(),那么結(jié)果是根本不會針對display這個成員變量進行復(fù)制;另外,如果將setDisplay()的訪問限定符號設(shè)置為private的話,結(jié)果也是一樣的,成員變量-display在clone的過程中不會被復(fù)制.注意上面討論的兩種情況,在運行時不會拋出任何的exception.對于不拋出exception的問題,我也感到非常迷惑,因為此方法的javadoc上明明指出當(dāng)不能訪問bean上的accessor或不存在accessor時,應(yīng)該拋出java.lang.IllegalAccessException或java.lang.NotSuchMethodException.為了再次確認,我將SampleObject中的所有g(shù)etter和setter都注釋掉了,結(jié)果依然一樣,看來要看下源碼了.
BeanUtils.copyProperties(java.lang.Object dest, java.lang.Object orig)
一個bean class有兩個實例:orig和dest,將orig中的成員變量的值復(fù)制給dest,即將已經(jīng)存在的dest變?yōu)閛rig的副本.與BeanUtils.cloneBean(java.lang.object bean)的區(qū)別就在于是不是需要創(chuàng)建新的實例了.同樣正常使用代碼非常簡單,這里也略掉.
如果bean class中沒有提供或是不完全提供getters和setters,結(jié)果如同在BeanUtils.cloneBean(java.lang.object bean)部分中的討論結(jié)果一樣.
另外,我曾經(jīng)這樣想,如果有兩個bean class,他們之間沒有任何關(guān)系,只是在成員變量的命名上有重疊(以SampleObject為例,如果我們有另外的bean class--AnotherSampleObject,也包含了成員變量display,name和num),他們之間是否可以利用BeanUtils.copyProperties(java.lang.Object dest, java.lang.Object orig)進行復(fù)制呢?(這個想法來自于<struts in action>中formBean章節(jié)中關(guān)于formBean與valueObject的討論)答案是可以的,該方法會復(fù)制名稱完全一樣的成員變量,即使成員變量的類型不同也會自動進行轉(zhuǎn)換的(我在AnotherSampleObject中將num的類型定義為Double,而SampleObject中的num為int),感覺真的是很神奇.回頭再去看看javadoc,發(fā)現(xiàn)這個方法原本就是如此設(shè)計的,原文如下:
Copy property values from the origin bean to the destination bean for all cases where the property names are the same.
其中for all cases where the property names are the same正是很好的明證,以后可以放心大膽的使用了.
ps:又對javadoc的重要性進行重新認識,同時認識到自己的英文是那么的爛.
BeanUtils.copyProperty(java.lang.Object bean,java.lang.String name,java.lang.Object value)
這個方法簡單的說就是將bean中的成員變量name賦值為value.使用方法如下:
SampleObject sample = new SampleObject();
BeanUtils.copyProperty(sample,"num",new Integer(10));
如果成員變量為數(shù)組,如何為數(shù)據(jù)內(nèi)的成員賦值呢?apache的java doc上說的很明白,就是要提供一個包含索引參數(shù)的setter,所以要將以下代碼加到SampleObject的源代碼中.
/**
* set word with against
* @param index
* @param word
*/
public void setWords(int index,char word){
this.words[index] = word;
}
如果我們要為SampleObject中的words[2]賦值為S,那么代碼如下:
BeanUtils.copyProperty(a,"words[2]","S");
如果成員變量為Map,如何為Map內(nèi)指定key賦值呢?同上面講的數(shù)組的方式一樣,就是要提供一個包含key參數(shù)的setter,在SampleObject中添加如下代碼:
/**
* set map with key
* @param key
* @param value
*/
public void setMap(Object key,Object value){
this.map.put(key,value);
}
如果我們要將SampleObject.map中home對應(yīng)值改為remote,那么代碼如下:
BeanUtils.copyProperty(a,"map(home)","remote");
最后說下如何為嵌套屬性的賦值,(所謂嵌套屬性就是beanA中一個成員變量是另外一個beanB,那么beanB中的屬性就叫做beanA的嵌套屬性了.),用法如下:
BeanUtils.copyProperty(a,"sample.display","second one");
BeanUtils.setProperty(java.lang.Object bean,java.lang.String name,java.lang.Object value)
這個方法讓我郁悶了一會,因為它提供的功能與上面說的BeanUtils.copyProperty(java.lang.Object bean,java.lang.String name,java.lang.Object value)完全一致,apache的hero們沒理由為同一功能提供兩種展示方法啊,后來我看了apache.commons.beanutils.BeanUtilsBean中的javadoc,才明白了一點點.如果我們只是為bean的屬性賦值的話,使用copyProperty()就可以了;而setProperty()方法是實現(xiàn)BeanUtils.populate()(后面會說到)機制的基礎(chǔ),也就是說如果我們需要自定義實現(xiàn)populate()方法,那么我們可以override setProperty()方法.
所以,做為一般的日常使用,setProperty()方法是不推薦使用的.
BeanUtils.populate(java.lang.Object bean, java.util.Map properties)
使用一個map為bean賦值,該map中的key的名稱與bean中的成員變量名稱相對應(yīng).注意:只有在key和成員變量名稱完全對應(yīng)的時候,populate機制才發(fā)生作用;但是在數(shù)量上沒有任何要求,如map中的key如果是成員變量名稱的子集,那么成員變量中有的而map中不包含的項將會保留默認值;同樣,如果成員變量是map中key的子集,那么多余的key不會對populate的結(jié)果產(chǎn)生任何影響.恩,結(jié)果就是populate只針對map中key名稱集合與bean中成員變量名稱集合的交集產(chǎn)生作用.(很饒口啊)
正常用法很簡單,這里略掉.
同樣,這個方法也支持對數(shù)組中單個元素,map中單個元素和嵌套屬性的賦值,具體做法和copyProperty()方法類似,具體如下:
values.put("words[1]","U");
values.put("map(home)","remote");
values.put("sample.display",new Double(5.0));
注意:apache的javadoc中,明確指明這個方法是為解析http請求參數(shù)特別定義和使用的,在正常的使用中不推薦使用.他們推薦使用BeanUtils.copyProperties()方法.(struts中的FormBean應(yīng)該是用這個方法裝配的)
BeanUtils.getArrayProperty(java.lang.Object bean,java.lang.String name)
獲取bean中數(shù)組成員變量(屬性)的值.
沒什么好說的,用法很簡單,略.
還是要說一句,如果我們指定的name不是數(shù)組類型的成員變量,結(jié)果會如何?會不會拋出類型錯誤的exception呢?回答是不會,仍然會返回一個String的數(shù)組,數(shù)組的第一項就是name對應(yīng)的值(如果不是String類型的話,JVM會自動的調(diào)用toString()方法的).
BeanUtils.getIndexedProperty(java.lang.Object bean,java.lang.String name)
BeanUtils.getIndexedProperty(java.lang.Object bean,java.lang.String name,int index)
這兩個方法都是獲取數(shù)組成員變量(屬性)中的單一元素值的方法.比如,我想得到SampleObject中words[1]的值,用法如下:
BeanUtils.getIndexedProperty(sampleOjbectInstance,"words[1]");
BeanUtils.getIndexedProperty(sampleOjbectInstance,"words",1);
BeanUtils.getMappedProperty(java.lang.Object bean,java.lang.String name)
BeanUtils.getMappedProperty(java.lang.Object bean,java.lang.String name,java.lang.String key)
這兩個方法是獲取map成員變量中單一元素值的方法,用法與getIndexedProperty()方法相似,如我想得到SampleObject中map中home對應(yīng)的值,用法如下:
BeanUtils.getMappedProperty(sampleOjbectInstance,map(home));
BeanUtils.getMappedProperty(sampleOjbectInstance,map,"home");
BeanUtils.getNestedProperty(java.lang.Object bean,java.lang.String name)
獲取嵌套屬性值的方法,如我想得到SampleOjbect中成員變量sample中的display的值,用法如下:
BeanUtils.getNestedProperty(sampleOjbectInstance,"sample.display");
BeanUtils.getSimpleProperty(java.lang.Object bean, java.lang.String name)
BeanUtils.getProperty(java.lang.Object bean, java.lang.String name)
獲取屬性值的方法.api已經(jīng)很清楚了,我唯一的問題是這個simple是什么意思.javadoc只是說了getProperty()方法中的name參數(shù)可以為普通屬性名稱,數(shù)組屬性名稱或嵌套屬性名稱的一種,而getSimpleProperty()方法中的name參數(shù)應(yīng)該為普通屬性名稱了.我的想法是通過對方法簽名的不同,讓developers可以顯示區(qū)別對待普通屬性,數(shù)組屬性,map屬性和嵌套屬性.
ps:具體有何區(qū)別,看來要仔細看看源代碼了.
BeanUtils.describe(java.lang.Object bean)
將一個bean以map的形式展示.(這個方法和populate()是我夢想中的雙手劍)
但是使用這個方法得到的結(jié)果有點令我失望,以SampleObject為例,代碼片段如下:
SampleObject a = new SampleObject();
a.setDisplay("first one");
a.setName("A");
a.setNum(5);
a.setWords("goto".toCharArray());
SampleObjectA b = new SampleObjectA();
b.setDisplay("nested property");
b.setNum(new Double(2.0));
b.setName("sampleA");
a.setSample(b);
try {
Map descMap = BeanUtils.describe(a);
System.out.println(descMap);
}
......
運行結(jié)果如下:
{num=5, display=first one, class=class beanutil.SampleObject, words=g, tag=false,
sample=beanutil.SampleObjectA@be2358, map={port=80, home=localhost}, name=A}
首先可以看出,除了輸出SampleObject中定義的key-value外,還會包含class=class beanutil.SampleObject這一項,我想這是為了通過獲得的map我們可以知道原來的bean的具體類型; 其次,作為數(shù)組成員變量(屬性)的words,在map中只包含了首個元素,而map類型的成員變量的輸出結(jié)果到是非常令人滿意.為什么明明長度為4的words數(shù)組現(xiàn)在輸出只有一個字符呢,我又進行了debug,并監(jiān)控了words變量,發(fā)現(xiàn)在返回的descMap中,words對應(yīng)的值的類型為String,長度為1.
ps:不知道是不是我使用錯誤,真不知道為什么會這樣. 最后,嵌套屬性不會逐一進行輸出的,除非你override了toString()方法.
與apache.commons.beanutils.BeanUtilsBean的關(guān)系
apache.commons.beanutils.BeanUtils中每個方法是通過apache.commons.beanutils.BeanUtilsBean實現(xiàn)的,apache.commons.beanutils.BeanUtils中靜態(tài)方法功能是默認方法,也就是最基本和最普通的,如果需要更復(fù)雜的功能實現(xiàn)的話,則需要使用apache.commons.beanutils.BeanUtilsBean中的方法.apache.commons.beanutils.BeanUtilsBean可以在不同的緩沖區(qū)內(nèi)存在不同的實例,從而可以提供不同的服務(wù),主要是converter的不同.通過這個機制可以為不同的用戶提供本地化的支持(我想這個在internet application上經(jīng)常要用到吧).我想這也是為什么apache.commons.beanutils.BeanUtilsBean不是interface而是class的原因.
標簽:
初用apache.commons.beanutils.BeanUtils[發(fā)起辯論][收藏到我的網(wǎng)摘][推薦] |
[評論] |
[投訴] |
[打印]本文章被推薦到了0 個圈子點擊數(shù): 4
評論數(shù):
1本文章引用通告地址(TrackBack Ping URL)為:
http://blog.hexun.com/fy198392/trackback.aspx?articleid=1544118
本文章尚未被引用。
上一篇:
慈禧名號的來歷下一篇:
HIBERNATE - 符合Java習(xí)慣的關(guān)系數(shù)據(jù)庫持久化進入該博客主頁fy198392[
發(fā)送私信]
[
加為好友]Re: 初用apache.commons.beanutils.BeanUtils [2005-11-25 11:39:01]
BeanUtils簡讀本
一、簡介：
BeanUtils提供對 Java反射和自省API的包裝。其主要目的是利用反射機制對JavaBean的屬性進行處理。我們知道，一個JavaBean通常包含了大量的屬性，很多情況下，對JavaBean的處理導(dǎo)致大量get/set代碼堆積，增加了代碼長度和閱讀代碼的難度。
二、用法：
BeanUtils是這個包里比較常用的一個工具類，這里只介紹它的copyProperties()方法。該方法定義如下：
public static void copyProperties(java.lang.Object dest,java.lang.Object orig) throws java.lang.IllegalAccessException, java.lang.reflect.InvocationTargetException
如果你有兩個具有很多相同屬性的JavaBean，一個很常見的情況就是Struts里的PO對象（持久對象）和對應(yīng)的ActionForm，例如 Teacher和TeacherForm。我們一般會在Action里從ActionForm構(gòu)造一個PO對象，傳統(tǒng)的方式是使用類似下面的語句對屬性逐個賦值：
//得到TeacherFormTeacherForm teacherForm=(TeacherForm)form;//構(gòu)造Teacher對象Teacher teacher=new Teacher();//賦值teacher.setName(teacherForm.getName());teacher.setAge(teacherForm.getAge());teacher.setGender(teacherForm.getGender());teacher.setMajor(teacherForm.getMajor());teacher.setDepartment(teacherForm.getDepartment());//持久化Teacher對象到數(shù)據(jù)庫HibernateDAO=;HibernateDAO.save(teacher);而使用BeanUtils后，代碼就大大改觀了，如下所示：//得到TeacherFormTeacherForm teacherForm=(TeacherForm)form;//構(gòu)造Teacher對象Teacher teacher=new Teacher();//賦值BeanUtils.copyProperties(teacher,teacherForm);//持久化Teacher對象到數(shù)據(jù)庫HibernateDAO=;HibernateDAO.save(teacher);
如果Teacher和TeacherForm間存在名稱不相同的屬性，則BeanUtils不對這些屬性進行處理，需要程序員手動處理。例如 Teacher包含modifyDate（該屬性記錄最后修改日期，不需要用戶在界面中輸入）屬性而TeacherForm無此屬性，那么在上面代碼的 copyProperties()后還要加上一句：
teacher.setModifyDate(new Date());
怎么樣，很方便吧！除BeanUtils外還有一個名為PropertyUtils的工具類，它也提供copyProperties()方法，作用與BeanUtils的同名方法十分相似，主要的區(qū)別在于后者提供類型轉(zhuǎn)換功能，即發(fā)現(xiàn)兩個JavaBean的同名屬性為不同類型時，在支持的數(shù)據(jù)類型范圍內(nèi)進行轉(zhuǎn)換，而前者不支持這個功能，但是速度會更快一些。BeanUtils支持的轉(zhuǎn)換類型如下：
* java.lang.BigDecimal * java.lang.BigInteger * boolean and java.lang.Boolean * byte and java.lang.Byte * char and java.lang.Character * java.lang.Class * double and java.lang.Double * float and java.lang.Float * int and java.lang.Integer * long and java.lang.Long * short and java.lang.Short * java.lang.String * java.sql.Date * java.sql.Time * java.sql.Timestamp
這里要注意一點，java.util.Date是不被支持的，而它的子類java.sql.Date是被支持的。因此如果對象包含時間類型的屬性，且希望被轉(zhuǎn)換的時候，一定要使用java.sql.Date類型。否則在轉(zhuǎn)換時會提示argument mistype異常。
三、優(yōu)缺點：
Apache Jakarta Commons項目非常有用。我曾在許多不同的項目上或直接或間接地使用各種流行的commons組件。其中的一個強大的組件就是BeanUtils。我將說明如何使用BeanUtils將local實體bean轉(zhuǎn)換為對應(yīng)的value 對象：
BeanUtils.copyProperties(aValue, aLocal)
上面的代碼從aLocal對象復(fù)制屬性到aValue對象。它相當(dāng)簡單！它不管local（或?qū)?yīng)的value）對象有多少個屬性，只管進行復(fù)制。我們假設(shè)local對象有100個屬性。上面的代碼使我們可以無需鍵入至少100行的冗長、容易出錯和反復(fù)的get和set方法調(diào)用。這太棒了！太強大了！太有用了！
現(xiàn)在，還有一個壞消息：使用BeanUtils的成本驚人地昂貴！我做了一個簡單的測試，BeanUtils所花費的時間要超過取數(shù)據(jù)、將其復(fù)制到對應(yīng)的 value對象（通過手動調(diào)用get和set方法），以及通過串行化將其返回到遠程的客戶機的時間總和。所以要小心使用這種威力！
