1.什么是ToStringBuilder？

ToStringBuilder 用于構建一個類的toString字符串的工具類，使用該類需要導入commons-lang.jar；或者導入maven倉庫：

<dependency><groupId>org.apache.commons</groupId><artifactId>commons-lang3</artifactId><version>3.8.1</version> </dependency>

然后導入即可：import org.apache.commons.lang3.builder.ToStringBuilder;

2.為什么要使用ToStringBuilder？

因為大部分實體的toString()方法都用的是簡單的"+"，而每"＋"一個就會new一個String對象，這樣如果系統內存小的話會暴內存。使用ToStringBuilder就可以避免暴內存這種問題的。

3.主要方法有哪些？

append()方法： 該方法用于自定義添加需要打印哪些變量，只有使用append添加的變量才會在toString函數中打印。

// 方法源碼 public ToStringBuilder append(Object obj) {this.style.append(this.buffer, (String)null, obj, (Boolean)null);return this;}public ToStringBuilder append(String fieldName, Object obj) {this.style.append(this.buffer, fieldName, obj, (Boolean)null);return this;}...

reflectionToString()方法（靜態）： 該方法使用反射機制打印一個類中的所有變量，該函數還提供一個變量style，建議使用ToStringStyle.DEFAULT_STYLE。

//方法源碼 public static String reflectionToString(Object object) {return ReflectionToStringBuilder.toString(object);}public static String reflectionToString(Object object, ToStringStyle style) {return ReflectionToStringBuilder.toString(object, style); }...

4.具體使用

通過ToStringBuilder->實現toString方法：
1.ToStringBuilder比較適合在打日志時，能夠很方便的自動打印對象中的屬性值;
2.利用反射原理拿到對象中域fields的屬性并添加到新的對象中builder并最終toString;
（注：idea安裝了lombok插件，只要在類前增加@Getter和@Setter注解即可不用手寫方法！）

import lombok.Getter; import lombok.Setter; import org.apache.commons.lang3.builder.ToStringBuilder; import java.io.Serializable; import java.lang.reflect.Field; import java.sql.Timestamp;/*** DTO: 基礎數據傳輸對象(Data Transfer Object)*/ @Getter @Setter public class BaseDTO implements Serializable {private String createBy;private String updatedBy;private Timestamp createTime;private Timestamp updateTime;@Overridepublic String toString() {ToStringBuilder builder = new ToStringBuilder(this);Field[] fields = this.getClass().getDeclaredFields();try {for (Field f : fields) {f.setAccessible(true);builder.append(f.getName(), f.get(this));//builder.append(f.getName(), f.get(this)).append("\n");}} catch (Exception e) {builder.append("toString builder encounter an error");}return builder.toString();} }

也可以這樣使用：

@Override public String toString() {return ToStringBuilder.reflectionToString(this, ToStringStyle.DEFAULT_STYLE); }

5.結果對比

@Test public void testBaseDTO(){BaseDTO dto = new BaseDTO();dto.setCreateBy("createName");dto.setUpdatedBy("updateName");System.out.println(dto.toString()); } 第一種方法（append）: me.zhengjie.base.BaseDTO@2fc14f68[createBy=createName,updatedBy=updateName,createTime=<null>,updateTime=<null>] 第二種方法（reflectionToString）: me.zhengjie.base.BaseDTO@445b84c0[createBy=createName,updatedBy=updateName,createTime=<null>,updateTime=<null>]

兩種方法結果差不多，只是append方法更靈活，還可以在每次屬性添加后換行或者自定義字符串；而reflectionToString靜態方法簡單直白。

總結

以上是生活随笔為你收集整理的通过ToStringBuilder实现toString方法的全部內容，希望文章能夠幫你解決所遇到的問題。

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