ToStringBuilder學習
常用方法介紹
一、簡介與引入
1、ToStringBuilder、HashCodeBuilder、EqualsBuilder、ToStringStyle、ReflectionToStringBuilder、CompareToBuilder等這些類都是位于commons-lang.jar下面的，所以要使用這些類一定要導入commons-lang.jar。
2、為什么要使用ToStringBuilder？
系統(tǒng)中一般都要打印日志的，因為所有實體的toString()方法 都用的是簡單的"+"，因為每"＋" 一個就會 new 一個 String 對象，這樣如果系統(tǒng)內(nèi)存小的話會暴內(nèi)存（前提系統(tǒng)實體比較多）。使用ToStringBuilder就可以避免暴內(nèi)存這種問題的。
二、示例學習
1、ToStringBuilder的append方法
ToStringBuilder類主要用于類的格式化輸出。ToStringBuilder中append方法可以向該類添加基本類型、數(shù)組、和對象，只有添加的方法才會被toString輸出。如：
class TaxReturn {
private String ssn;
private int year;
private String lastName;
private BigDecimal taxableIncome;
// get/set方法省略
public TaxReturn() {
}
public TaxReturn(String pSsn, int pYear, String pLastName, BigDecimal pTaxableIncome) {
setSsn(pSsn);
setYear(pYear);
setLastName(pLastName);
setTaxableIncome(pTaxableIncome);
}
public String toString() {
return new ToStringBuilder(this).append("ssn", ssn).append("year", year).append("lastName",
lastName).toString();
}
public int hashCode() {
return new HashCodeBuilder(3, 7).append(ssn).append(year).toHashCode();
}
public boolean equals(Object pObject) {
boolean equals = false;
if (pObject instanceof TaxReturn) {
TaxReturn bean = (TaxReturn) pObject;
equals = (new EqualsBuilder().append(ssn, bean.ssn).append(year, bean.year)).isEquals();
}
return equals;
}
public int compareTo(Object pObject) {
return CompareToBuilder.reflectionCompare(this, pObject);
}
}
public class MainClass {
public static void main(String[] pArgs) throws Exception {
TaxReturn return1 = new TaxReturn("012-68-3242", 1998, "O'Brien", new BigDecimal(43000.00));
TaxReturn return2 = new TaxReturn("012-68-3242", 1999, "O'Brien", new BigDecimal(45000.00));
TaxReturn return3 = new TaxReturn("012-68-3242", 1999, "O'Brien", new BigDecimal(53222.00));
System.out.println("ToStringBuilder: " + return1.toString());
}
}
運行結果如下：
ToStringBuilder: TaxReturn@1503a3[ssn=012-68-3242,year=1998,lastName=O'Brien]
2、ToStringBuilder的reflectionToString方法
該方法主要是把類對應的基本屬性和值輸出來。如：
public class MainClass {
public static void main(String[] args) {
MyClass one = new MyClass("Becker", 35);
MyClass two = new MyClass("Becker", 35);
MyClass three = new MyClass("Agassi", 33);
System.out.println("One>>>" + one);
System.out.println("Two>>>" + two);
System.out.println("Three>>>" + three);
System.out.println("one equals two? " + one.equals(two));
System.out.println("one equals three? " + one.equals(three));
System.out.println("One HashCode>>> " + one.hashCode());
System.out.println("Two HashCode>>> " + two.hashCode());
System.out.println("Three HashCode>>> " + three.hashCode());
}
}
class MyClass {
private String name = null;
private int age = 0;
public MyClass(String name, int age) {
this.name = name;
this.age = age;
}
public boolean equals(Object obj) {
return EqualsBuilder.reflectionEquals(this, obj);
}
public String toString() {
return ToStringBuilder.reflectionToString(this,
ToStringStyle.MULTI_LINE_STYLE);
}
public int hashCode() {
return HashCodeBuilder.reflectionHashCode(this);
}
}
運行結果如下：
One>>>MyClass@743399[
name=Becker
age=35
]
Two>>>MyClass@1d8957f[
name=Becker
age=35
]
Three>>>MyClass@3ee284[
name=Agassi
age=33
]
one equals two? true
one equals three? false
One HashCode>>> 462213092
Two HashCode>>> 462213092
Three HashCode>>> -530629296
ToStringStyle參數(shù)說明：
1. DEFAULT_STYLE
com.entity.Person@182f0db[name=John Doe,age=33,smoker=false]
2. MULTI_LINE_STYLE
com.entity.Person@182f0db[
name=John Doe
age=33
smoker=false
]
3. NO_FIELD_NAMES_STYLE
com.entity.Person@182f0db[John Doe,33,false]
4. SHORT_PREFIX_STYLE （即截去了包名）
Person[name=John Doe,age=33,smoker=false]
5. SIMPLE_STYLE
John Doe,33,false
###############################################
附加：
無論你在開發(fā)哪中 Java 應用程序，都免不了要寫很多工具類/工具函數(shù)。你可知道，有很多現(xiàn)成的工具類可用，并且代碼質(zhì)量都很不錯，不用你寫，不用你調(diào)試，只要你發(fā)現(xiàn)。
在 Apache Jakarta Common 中， Lang 這個 Java 工具包是所有 Apache Jakarta Common 項目中被使用最廣泛的，幾乎你所知道的名氣比較大的軟件里面都有用到它，包括 Tomcat, Weblogic, Websphere, Eclipse 等等。我們就從這個包開始介紹整個 common 項目。
Lang 中工具類比較多，這里介紹幾個主要的：
ClassUtils： getShortClassName，這個函數(shù)應該在 java.lang.Class 類中有的，我看到很多人自己寫這個函數(shù)。getAllInterfaces，convertClassNamesToClasses，isAssignable，primitivesToWrappers，isInnerClass。
NumberUtils： 關于數(shù)字以及數(shù)字和字符串轉換的類 stringToInt，toDouble，createNumber，isAllZeros， int compare(float lhs, float rhs)， isNumber(String str)，double min(double[] array)。
RandomUtils： 用于產(chǎn)生隨機數(shù)的。
DateFormatUtils：日期時間格式轉換，以及本地時間和 UTC 時間轉換。
DateUtils： 日期工具類。isSameDay，truncate，round，modify。
基于反射機制的幾個類：
CompareToBuilder： 比較，用在算法、排序、比較的地方。reflectionCompare，append。
EqualsBuilder： 通過反射機制比較。reflectionEquals 很多項目中用到。
HashCodeBuilder： 可以通過反射生成 hash code，很多算法的地方涉及到 hash code，但是并不是每個人都知道一種 hash code 的生成方法。
ToStringBuilder： 當你需要重載 toString 函數(shù)而不想寫代碼把當前類的所有成員信息列出來，可以用這個函數(shù)。
其它的幾個類我用得比較少：
SerializationUtils Java中得序列化比較奧妙，容易出錯啊。
SystemUtils 可以讀取一些關于 jdk 信息，操作系統(tǒng)信息的工具類。
兩種方法用法優(yōu)缺點及一個問題
研究ApacheCommon源碼, 先從一個最簡單的開始,即圍繞Object類里的toString方法自動化實現(xiàn)的一系列類.
怎么來自動化地實現(xiàn)toString方法, 有兩種:反射和手動設置.這兩種方法在上一篇博客中都有體現(xiàn),這里就不再贅述了.下面列舉下其優(yōu)缺點.
用反射方法的優(yōu)點:
1. 代碼簡潔, 不需要有什么配置的.
2, 若Model屬性有變化時不必再手動更改toString方法的實現(xiàn).
缺點:
1, 有些屬性并不想讓toString給輸入出來, (可能是沒用, 也有可能是出于密碼方面考慮),但用反射時所有屬性值都給輸了出來. (這個已有解決,見下面,不過雖說解決了,但還是不如另一種方式靈活.)
2, 安全方面的考慮. 一般來說,一個java類是的屬性都是private的,這樣用反射來構建toString方法時,就得繞過private的限制. 于是 If your system is running under a restrictive SecurityManager , you may need to alter your configuration to allow Commons Lang to bypass these security restrictions.對Java安全性問題還沒有體會,現(xiàn)在寫在這里,以作備案,提醒以后注意.
相比于這個反射, 直接用ToStringBuilder來配置就靈活多了.
下面說下,彌補用反射方法不夠靈活的一個擴展. 由于這個是我第一次見,就放在這里,作為備案.假設一個類里有名為password這樣的屬性,一般情況下,是不想讓toString輸入的, 但用反射默認情況下是會輸出的. 這怎么辦呢?看ReflectionToStringBuilder源碼里文檔時,發(fā)現(xiàn)這么一個擴展: 通過子類,覆蓋其accept方法來加以篩選.具體如下所示:
public String toString() {
return (new ReflectionToStringBuilder(this) {
// 注意這里為了表達上的簡潔用了匿名內(nèi)部類.
protected boolean accept(Field f) {
return super.accept(f) && !f.getName().equals("password");
}
}).toString();
}
這樣在toString時, 就會跳過名為password的屬性.
上面記錄了兩種方法的優(yōu)缺點和反射時的擴展, 其實研究完這個ToStringBuilder后,有三個收獲,上面只是第一個,第三個相對來說比較大,只能放在下一篇了,這里介紹下第二個收獲.
說是收獲,其實是一個問題,不過問題往往是新收獲的開始. 問題是這樣的: 一個private的靜態(tài)內(nèi)部類,它有一個同樣是private的方法,名為readResolve(詳見ToStringStyle的內(nèi)部類 DefaultToStringStyle),那這個方法有什么用? 不用反射這個方法是不可能被調(diào)用的. 看對這個方法的描述,說是"Ensure Singleton after serialization".看不出來是什么意思? 怎么以前一直沒見過呢?這個問題,先放在這里.
兩個小收獲寫完了, 下一篇中將介紹研究ToStringBuilder帶給我的最大收獲: abstract與設計模式.
abstract、子類與多態(tài)的單例模式
看ToStringBuilder的源碼發(fā)現(xiàn), 這個封裝了三個屬性:StringBuffer類型的buffer,Object類型的object和ToStringStyle類型的style. buffer是用來裝最終結果的, object指的是要toString的那個對象,這兩個屬性都不用多說, style是個新定義的類, 它是來啥的(ToStringBuilder利用這個類來管理最終toString顯示內(nèi)容的格式,即是否分行顯示, 是否要顯示屬性名,分隔符又都用哪些)? 再往下又看到ToStringBuilder類中所有的方法append都是通過調(diào)用屬性style的相應方法實現(xiàn)的.這樣通過組合方式來達到代碼共用及功能調(diào)用與實現(xiàn)的分隔也不是第一次見了, 有些好奇的是ToStringStyle是干啥的? 它的append方法具體是怎么實現(xiàn)的? 這里面是否隱藏著什么秘密?
帶著這些問題, 去看ToStringStyle源碼. ToStringStyle是一個abstract的類, 有六個子類, 如下所示:
看源碼時,發(fā)現(xiàn)一個有意思的問題: 六個子類中有五個是private static修飾的內(nèi)部類. 這樣組合在自己寫的代碼中可是一次也沒用過的.這樣的處理有什么好處?
順著問題往下追. 從abstract這個關鍵字說起, 既然是一個抽象類, 它又有那么多的子類,一般的理解: 抽象類可能會有一些方法也是abstract的, 不同的子類以不同的方式來實現(xiàn)這些個abstract方法. 驗證下自己的猜測,看源碼,可ToStringStyle里沒有一個方法是abstract的! 六個子類中除StandardToStringStyle外的幾個static內(nèi)部類外,沒有一個那怕是覆蓋下非abstract的方法! 這就更不可思議了, 不過直觀告訴我,這樣的不可思議往往預示著新的收獲.
新的收獲應該有, 但現(xiàn)在卻理不出頭緒了, 通往新收獲的被破口又在哪呢? 死扣這個類的關系是得不出答案了, 看看它們的應用. 五個private static的內(nèi)部類無一例外的都是在ToStringStyle類里有了調(diào)用, 隨后再放到public static final修飾的屬性中, 屬性名與子類名對應,如MULTI_LINE_STYLE與MultiLineToStringStyle說的是一回事. 這又怎么樣呢? 還是看不出線索. 再回過頭來看在toString方法中調(diào)用, 有這樣的ToStringStyle.SIMPLE_STYLE使用方式. 電光火石間想起了ToStringStyle類文檔描述: These classes are intended to be used as Singletons. There is no need to instantiate a new style each time. A program will generally use one of the predefined constants on this class. 對,對, 就這個predefined!現(xiàn)在所有類繼承處理就是為了這個predefined.
突破口找到了, 再回過頭來想想. 其實這里邊也沒有什么值得大驚小怪的: 這種策略實際上是單例模式的一種衍生.一般常見的單例模式返回一個自己類的對象, 而這里是返回子類的對象. 有些奇特的是,ToStringStyle通過那些子類對象把一些常用的配置進行了固化處理, 這也就是predefined的由來. 而利用abstract,ToStringStyle類不讓再生成新的對象.
不過這里有一個問題: toString時的顯示格式設置不可能就那么五種, 那么多set方法的組合可以設置出太多種結果, 如果某種情況下這五種predefined的方式不行怎么辦? ToStringStyle又是抽象的, 我們也不能生成一個對象再自己設置. 繼承一個子類出來,再new不就得了? 對, 就是這種方式. ToStringStyle也替我們想到了, StandardToStringStyle就是專門來干這個的, 咱們可以new一個StandardToStringStyle對象, 再隨意地設置顯示格式.
這個收獲寫完了, 現(xiàn)在再具體總結下:
1, 在ToStringBuilder里,通過屬性ToStringBuilder來分離功能的調(diào)用與實現(xiàn). 通過上面的分析,我們也能看到實現(xiàn)是很復雜的, 要考慮多種輸出格式(及多種類型的輸入內(nèi)容). 若設計之初, 把功能的實現(xiàn)與調(diào)用都揉合到ToStringBuilder類里, 那就亂成一鍋粥了, 與軟件設計中的分而治之思想背通而馳.
2, 單例模式耳熟能詳了,但像今天這個通過子類來達到多態(tài)的單例還是第一次見. 再進一步看, 通過子類StandardToStringStyle提供了一個更為靈活的擴展.
3, 真切地體會到內(nèi)部類的一個新用法, 而不僅僅是Swing中那樣老套的clickListener的實現(xiàn).
4, 一個重要的一點, 這樣的設計考慮, 若只看書是學不到的.
元博客地址：http://rmn190.iteye.com/blog/349639
http://blog.sina.com.cn/s/blog_7ffb8dd50101ap0s.html
readResolve()方法與序列化
在ToStringBuilder學習（一）中提到一個問題,即 readResolve方法是干啥的? 當時也沒多想, 只是列在那里, 今天忙里偷閑地把搜點材料整理下這個問題.
原來這個方法跟對象的序列化相關(這樣倒是解釋了為什么 readResolve方法是private修飾的). ??? 怎么跟對象的序列化相關了?
下面我們先簡要地回顧下對象的序列化. 一般來說, 一個類實現(xiàn)了 Serializable接口, 我們就可以把它往內(nèi)存地寫再從內(nèi)存里讀出而"組裝"成一個跟原來一模一樣的對象. 不過當序列化遇到單例時,這里邊就有了個問題: 從內(nèi)存讀出而組裝的對象破壞了單例的規(guī)則. 單例是要求一個JVM中只有一個類對象的, 而現(xiàn)在通過反序列化,一個新的對象克隆了出來.
如下例所示:
public final class MySingleton implements Serializable {
private MySingleton() { }
private static final MySingleton INSTANCE = new MySingleton();
public static MySingleton getInstance() { return INSTANCE; }
}
當把 MySingleton對象(通過getInstance方法獲得的那個單例對象)序列化后再從內(nèi)存中讀出時, 就有一個全新但跟原來一樣的MySingleton對象存在了. 那怎么來維護單例模式呢?這就要用到readResolve方法了. 如下所示:
public final class MySingleton implements Serializable{
private MySingleton() { }
private static final MySingleton INSTANCE = new MySingleton();
public static MySingleton getInstance() { return INSTANCE; }
private Object readResolve() throws ObjectStreamException {
// instead of the object we're on,
// return the class variable INSTANCE
return INSTANCE;
}
}
這樣當JVM從內(nèi)存中反序列化地"組裝"一個新對象時,就會自動調(diào)用這個 readResolve方法來返回我們指定好的對象了, 單例規(guī)則也就得到了保證.
---------------------------------
上面用的例子來源于這個鏈接:http://www.javalobby.org/java/forums/t17491.html, 另這個鏈接中還有一個更為高級的例子, 如有興趣可去一看.
