ToStringBuilder學習

1、簡介與引入
   一、ToStringBuilder、HashCodeBuilder、EqualsBuilder、ToStringStyle、ReflectionToStringBuilder、CompareToBuilder等這些類都是位於commons-lang.jar下面的，因此要使用這些類必定要導入commons-lang.jar。
   二、爲何要使用ToStringBuilder？
     系統中通常都要打印日誌的，由於全部實體的toString()方法 都用的是簡單的"+"，由於每"＋" 一個就會 new 一個 String 對象，這樣若是系統內存小的話會暴內存（前提系統實體比較多）。使用ToStringBuilder就能夠避免暴內存這種問題的。

2、示例學習
  一、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]

二、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

###############################################
附加：
    不管你在開發哪中 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 函數而不想寫代碼把當前類的全部成員信息列出來，能夠用這個函數。

　　其它的幾個類我用得比較少：
　　SerializationUtils  Java中得序列化比較奧妙，容易出錯啊。
　　SystemUtils 能夠讀取一些關於 jdk 信息，操做系統信息的工具類。

 

研究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與設計模式.

 

在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方法來返回咱們指定好的對象了, 單例規則也就獲得了保證. --------------------------------- 上面用的例子來源於這個連接:http://www.javalobby.org/java/forums/t17491.html, 另這個連接中還有一個更爲高級的例子, 若有興趣可去一看.