在平時我們工作的時候，我們經(jīng)常會使用toString() 方法來輸出一個對象的一些屬性信息。Lombok 給我們提供了一個自動生成 toString()代碼的注解，可以減少代碼行數(shù)，如果代碼屬性比較多的話，可以避免我們些代碼的過程中出現(xiàn)屬性遺漏的問題。
本文我們來講講 Lombok 的 @ToString()相關(guān)內(nèi)容，以便于我們以后更好的使用 Lombok。

Lombok 的使用

首先我們添加一下 maven 依賴。

< dependency >
  < groupId >org.projectlombok< /groupId >
  < artifactId >lombok< /artifactId >
  < version >1.18.22< /version >
  < scope >provided< /scope >
< /dependency >

然后我們創(chuàng)建一個 Account 的 class 來演示我們一下我們的各種操作。

@Getter
@Setter
@ToString
public class Account {

    private String id;

    private String name;

}

默認情況下，我們在調(diào)用 Account 的toString() 方法之后，輸出的結(jié)果可能如下：

Account(id=12345, name=account)

這是一種比較標準的格式輸出。

Lombok的配置

父類 toString() 的調(diào)用

現(xiàn)在假設(shè)我們有一個 SavingAccount 的 class 繼承于 Account ，我們調(diào)用 SavingAccount 的 toString() 方法時，希望把 Account 的一些屬性也能夠一起輸出， 這個時候我們可以設(shè)置 callSupper 屬性來達到我們的目的。

@ToString(callSupper = true)
public class SavingAccount extends Account {
    private String savingAccountId;
    // 省略 get set
}

上述代碼的操作，就能把父類 Account 的屬性都輸出出來：

SavingAccount(super=Account(id=12345, name=An account), savingAccountId=6789)

省略字段名稱

我們知道默認輸出的時候，會包含字段名稱，我們可以通過設(shè)置 includeFieldNames 來控制，是否顯示屬性名稱。

@ToString(includeFieldNames = false)
public class Account {

    private String id;

    private String name;

    // 省略 get set
}

把 includeFieldNames 設(shè)置為 false 之后，輸出結(jié)果如下

Account(12345, An account)

使用字段代替 Getter

我們知道 getter 方法提供了用于打印的字段值。如果該類不包含某個特定字段的getter方法，那么Lombok會直接訪問該字段并獲取其值。
我們可以通過設(shè)置 doNotUseGetters 屬性為 true，將 Lombok 配置為總是使用直接的字段值而不是getter。

@ToString(doNotUseGetters = true)
public class Account {

    private String id;

    private String name;

    // ignored getter
    public String getId() {
        return "this is the id:" + id;
    }

    // standard getters and setters
}

如果沒有這個屬性，我們會得到通過調(diào)用getters得到的輸出。

Account(id=this is the id:12345, name=An account)

相反，通過設(shè)置doNotUseGetters屬性，輸出實際上顯示了id字段的值，而沒有調(diào)用getter。

Account(id=12345, name=An account)

字段的包含和排除

假設(shè)我們想從字符串表示中排除某些字段，例如，密碼、其他敏感信息或大的JSON結(jié)構(gòu)。我們可以通過@ToString.Exclude注解來省略這些字段。
讓我們把名字字段從我們的表示中排除

@ToString
public class Account {

    private String id;

    @ToString.Exclude
    private String name;

}

或者，我們可以只指定輸出中所需的字段，我可以通過使用 @ToString(onlyExplicitlyIncluded = true)和 @ToString.Include來實現(xiàn)。

@ToString(onlyExplicitlyIncluded = true)
public class Account {

    @ToString.Include
    private String id;

    private String name;
    

}

上述兩種方法，最終輸出，都只能輸出 id 字段。

Account(id=12345)

另外，Lombok 會自動忽略以$ 開頭的變量，但是我們可以通過 @ToString.Include 來強制Lombok輸出。

輸出排序

默認情況下，Lombok 的輸出，是按照字段定義的順序進行輸出的，我可以通過設(shè)置 @ToString.Include 來進行排序。
我們先修改一下 Account 的字段順序， 然后對 id 進行標記順序。

@ToString
public class Account {

    private String name;

    @ToString.Include(rank = 1)
    private String id;

}

現(xiàn)在 id 字段輸出的時候，會排在 name 的前面

Account(id=12345, name=An account)

Lombok 輸出的規(guī)則大致如下：

• rank 排名越大，排序越靠前
• 默認的排序值為0
• 相同的排序通過根據(jù)字段定義順序輸出

方法輸出

除了字段之外，我們也可以包括一個不需要參數(shù)的實例方法的輸出。我們可以通過用@ToString.Include標記無參數(shù)的實例方法來做到這一點。

@ToString
public class Account {

    private String id;

    private String name;

    @ToString.Include
    String description() {
        return "Account description";
    }

}

這里 description 將會作為輸出 key 進行打印輸出。

Account(id=12345, name=An account, description=Account description)

如果指定的方法名稱與字段名稱相匹配，那么該方法就會優(yōu)先于字段。換句話說，輸出包含方法調(diào)用的結(jié)果，而不是匹配字段的值。

修改字段名稱

我們可以通過 @ToString.Include 的屬性來修改字段的名稱。

@ToString
public class Account {

    @ToString.Include(name = "identification")
    private String id;

    private String name;

}

現(xiàn)在輸出結(jié)果中，將不會包含字段名稱id ，將會輸出 identification。

Account(identification=12345, name=An account)

打印數(shù)組

Lombok 使用 Arrays.deepToString() 方法打印數(shù)組，將數(shù)組元素轉(zhuǎn)換為其相應的字符串表示。但是數(shù)組有可能包含直接引用或間接循環(huán)引用。為了避免無限遞歸及其相關(guān)的運行時錯誤，該方法將任何從自身內(nèi)部對數(shù)組的循環(huán)引用渲染為"[[...]]"。
讓我們通過給我們的賬戶類添加一個對象數(shù)組字段來看看。

@ToString
public class Account {

    private String id;

    private Object[] relatedAccounts;

}

這 relatedAccounts 數(shù)組的打印如下

Account(id=12345, relatedAccounts=[54321, [...]])

重要的是，循環(huán)引用被deepToString()方法檢測到，并且被Lombok適當?shù)爻尸F(xiàn)出來，沒有引起任何StackOverflowError。

有一些注意點

有幾個細節(jié)值得一提，對避免產(chǎn)生意外的結(jié)果很重要。

• 在類中存在任何名為toString()的方法（不管返回類型如何），Lombok不會生成其 toString() 方法。
• 不同版本的Lombok可能會改變生成方法的輸出格式。在任何情況下，我們應該避免依賴解析toString()方法輸出的代碼。所以這其實不應該是一個問題。
• 我們還可以在枚舉上添加這個注解。這將產(chǎn)生一個枚舉值跟隨枚舉類名稱的表示，例如，AccounType.SAVING。