無論你在開發哪中 Java 應用程序，都免不了要寫很多工具類/工具函數。你可知道，有很多現成的工具類可用，并且代碼質量都很不錯，不用你寫，不用你調試，只要你發現。

????????在 Apache Jakarta Common 中， Lang 這個 Java 工具包是所有 Apache Jakarta Common 項目中被使用最廣泛的，幾乎你所知道的名氣比較大的軟件里面都有用到它，包括 Tomcat, Weblogic, Websphere, Eclipse 等等。我們就從這個包開始介紹整個 common 項目。

Lang 中工具類比較多，這里介紹幾個主要的：
　　ClassUtils：??getShortClassName，這個函數應該在 java.lang.Class 類中有的，我看到很多人自己寫這個函數。getAllInterfaces，convertClassNamesToClasses，isAssignable，primitivesToWrappers，isInnerClass。
　　NumberUtils： 關于數字以及數字和字符串轉換的類 stringToInt，toDouble，createNumber，isAllZeros， int compare(float lhs, float rhs)， isNumber(String str)，double min(double[] array)。
　　RandomUtils： 用于產生隨機數的。
　　DateFormatUtils： 日期時間格式轉換，以及本地時間和 UTC 時間轉換。
　　DateUtils：?日期工具類。isSameDay，truncate，round，modify。

　　基于反射機制的幾個類：
　　CompareToBuilder：?比較，用在算法、排序、比較的地方。reflectionCompare，append。
　　EqualsBuilder：?通過反射機制比較。reflectionEquals 很多項目中用到。
　　HashCodeBuilder：?可以通過反射生成 hash code，很多算法的地方涉及到 hash code，但是并不是每個人都知道一種 hash code 的生成方法。
　　ToStringBuilder： 當你需要重載 toString 函數而不想寫代碼把當前類的所有成員信息列出來，可以用這個函數。

一、簡介與引入
???1、ToStringBuilder、HashCodeBuilder、EqualsBuilder、ToStringStyle、ReflectionToStringBuilder、CompareToBuilder等這些類都是位于commons-lang3.jar下面的，所以要使用這些類一定要導入commons-lang3.jar。
???2、為什么要使用ToStringBuilder？
?????系統中一般都要打印日志的，因為所有實體的toString()方法 都用的是簡單的"+"，因為每"＋" 一個就會 new 一個 String 對象，這樣如果系統內存小的話會暴內存（前提系統實體比較多）。使用ToStringBuilder就可以避免暴內存這種問題的。

二、示例學習
??1、ToStringBuilder的append方法
?????ToStringBuilder類主要用于類的格式化輸出。ToStringBuilder中append方法可以向該類添加基本類型、數組、和對象，只有添加的方法才會被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參數說明：
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

兩種方法用法優缺點及一個問題

研究ApacheCommon源碼, 先從一個最簡單的開始,即圍繞Object類里的toString方法自動化實現的一系列類.
???
??? 怎么來自動化地實現toString方法, 有兩種:反射和手動設置.這兩種方法在上一篇博客中都有體現,這里就不再贅述了.下面列舉下其優缺點.

??? 用反射方法的優點:
??????? 1. 代碼簡潔, 不需要有什么配置的.
??????? 2, 若Model屬性有變化時不必再手動更改toString方法的實現.

??? 缺點:
??????? 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安全性問題還沒有體會,現在寫在這里,以作備案,提醒以后注意.

??? 相比于這個反射, 直接用ToStringBuilder來配置就靈活多了.

??? 下面說下,彌補用反射方法不夠靈活的一個擴展. 由于這個是我第一次見,就放在這里,作為備案.假設一個類里有名為password這樣的屬性,一般情況下,是不想讓toString輸入的, 但用反射默認情況下是會輸出的. 這怎么辦呢?看ReflectionToStringBuilder源碼里文檔時,發現這么一個擴展: 通過子類,覆蓋其accept方法來加以篩選.具體如下所示:

public String toString() {
????? return (new ReflectionToStringBuilder(this) {
// 注意這里為了表達上的簡潔用了匿名內部類.
????? protected boolean accept(Field f) {
??????? return super.accept(f) && !f.getName().equals("password");
????????? }
????? }).toString();
}
這樣在toString時, 就會跳過名為password的屬性.

??? 上面記錄了兩種方法的優缺點和反射時的擴展, 其實研究完這個ToStringBuilder后,有三個收獲,上面只是第一個,第三個相對來說比較大,只能放在下一篇了,這里介紹下第二個收獲.

??? 說是收獲,其實是一個問題,不過問題往往是新收獲的開始. 問題是這樣的:?一個private的靜態內部類,它有一個同樣是private的方法,名為readResolve(詳見ToStringStyle的內部類 DefaultToStringStyle),那這個方法有什么用? 不用反射這個方法是不可能被調用的. 看對這個方法的描述,說是"Ensure Singleton after serialization".看不出來是什么意思? 怎么以前一直沒見過呢?這個問題,先放在這里.

??? 兩個小收獲寫完了, 下一篇中將介紹研究ToStringBuilder帶給我的最大收獲: abstract與設計模式.

readResolve()方法與序列化

在ToStringBuilder學習（一）中提到一個問題,即 readResolve方法是干啥的? 當時也沒多想, 只是列在那里, 今天忙里偷閑地把搜點材料整理下這個問題.
原來這個方法跟對象的序列化相關(這樣倒是解釋了為什么 readResolve方法是private修飾的). ??? 怎么跟對象的序列化相關了?

下面我們先簡要地回顧下對象的序列化.?一般來說, 一個類實現了 Serializable接口, 我們就可以把它往內存地寫再從內存里讀出而"組裝"成一個跟原來一模一樣的對象. 不過當序列化遇到單例時,這里邊就有了個問題:?從內存讀出而組裝的對象破壞了單例的規則. 單例是要求一個JVM中只有一個類對象的, 而現在通過反序列化,一個新的對象克隆了出來.
如下例所示:
public final class MySingleton implements Serializable {
???? private MySingleton() { }
???? private static final MySingleton INSTANCE = new MySingleton();
???? public static MySingleton getInstance() { return INSTANCE; }
}

當把 MySingleton對象(通過getInstance方法獲得的那個單例對象)序列化后再從內存中讀出時, 就有一個全新但跟原來一樣的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從內存中反序列化地"組裝"一個新對象時,就會自動調用這個 readResolve方法來返回我們指定好的對象了, 單例規則也就得到了保證.

轉載于:https://my.oschina.net/u/3213541/blog/878816

總結

以上是生活随笔為你收集整理的ToStringBuilder、HashCodeBuilder、EqualsBuilder、ToStringStyle、ReflectionToStringBuilder等学习...的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。