java-ToStringBuilder介紹

TuxedoLinux發表於2018-06-22

java-ToStringBuilder介紹


1、

專案中一般都需要列印日誌,所有實體的toString()方法都是用簡單的"+",因為每"+" 一個就會 new 一個 String 物件,這樣如果系統記憶體小的話會暴記憶體。使用ToStringBuilder就可以避免暴記憶體這種問題。

ToStringBuilder的reflectionToString方法:

  logger.info("請求資料:"+ToStringBuilder.reflectionToString(req));

2、

ToStringBuilder在包 common-lang 中,主要用於一個類的格式化輸出。ToStringBuilder類中的append方法可以向該類新增基本型別、陣列和物件 ,只有新增的方法才會被toString方法輸出。
        ToStringStyle類則是對輸出的內容進行格式化。

詳細講解

一、簡介與引入 
1、ToStringBuilder、HashCodeBuilder、EqualsBuilder、ToStringStyle、ReflectionToStringBuilder、CompareToBuilder等這些類都是位於commons-lang.jar下面的,所以要使用這些類一定要匯入commons-lang.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

附加:

無論你在開發哪中 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 資訊,作業系統資訊的工具類。