今天來(lái)講一下Groovy的groovy.transform包的第一個(gè)故事，先簡(jiǎn)單介紹一下這個(gè)包：transform是Groovy設(shè)計(jì)者在編譯期對(duì)語(yǔ)言做出的一些優(yōu)化，這些優(yōu)化不會(huì)觸及到JVM層次的字節(jié)碼，但是又能為開發(fā)者提供更簡(jiǎn)潔優(yōu)雅的coding風(fēng)格，詳情我另文介紹。開始說(shuō)說(shuō)今天的主角。

1、@ToString
在JVM實(shí)現(xiàn)里，所有的類都默認(rèn)是java.lang.Object的子類，因此所有的類都可以繼承和覆寫Object類里的toString方法，在打印的時(shí)候，這個(gè)toString就相當(dāng)于這個(gè)類的名片，可以根據(jù)寫作者的意愿來(lái)返回一個(gè)String。一般來(lái)說(shuō)，在Java開發(fā)過(guò)程中，我們會(huì)把一些關(guān)鍵的信息組合到這個(gè)String里面來(lái)，或者是全部的屬性值組合到這個(gè)String來(lái)，為我們提供一些運(yùn)行時(shí)的數(shù)據(jù)信息。不過(guò)更多的時(shí)候，我們會(huì)選擇不實(shí)現(xiàn)這個(gè)方法，并非有別的考慮，只是“怕麻煩”。（在Java里，可以借助org.apache.common.lang.builder.ReflectionToStringBuilder的toString方法，以反射的方式來(lái)生成屬性值的組合）
在groovy里，這個(gè)問(wèn)題得到了更妥善的解決，我們可以給需要實(shí)現(xiàn)toString的類加上@toString注解來(lái)簡(jiǎn)單完成此需求，看下面的代碼。

  public class Person {
    String name
    String address
    int age
  }
def p = new Person("name":"xiaoming","address":"網(wǎng)商路599號(hào)","age":100) 
println p

執(zhí)行結(jié)果是：
com.xiaonanzhi.transform.model.Person@1bf7857f

其中@后面的字符串是不確定的，這個(gè)實(shí)際上調(diào)用的是java.lang.Object對(duì)象的toString方法，這個(gè)方法是這么實(shí)現(xiàn)的:

  public String toString() {
    return getClass().getName() + "@" + Integer.toHexString(hashCode());
}

@后面的數(shù)字實(shí)際上對(duì)應(yīng)了Object里面native實(shí)現(xiàn)的hashCode方法，實(shí)際上對(duì)應(yīng)的是對(duì)象的內(nèi)存地址?，F(xiàn)在給Person加上@toString注解，我們?cè)倏聪陆Y(jié)果：

com.xiaonanzhi.transform.model.Person(xiaoming, 網(wǎng)商路599號(hào), 100)

ToString注解幫我們把這個(gè)類的屬性都輸出了，不過(guò)貌似沒(méi)有屬性名稱啊，真是缺憾啊……且慢，我們?cè)僮屑?xì)看看ToString注解的文檔，原來(lái)只要加上includeNames=true的參數(shù)，就可以連著屬性名打印了，所以現(xiàn)在注解變?yōu)椋?/p>

   @ToString(includeNames=true)

輸出則變成了

 com.xiaonanzhi.transform.model.Person(name:xiaoming, address:網(wǎng)商路599號(hào), age:100)

如此一來(lái)我們知道了toString的參數(shù)設(shè)置方式，就是往注解里填參數(shù)，已有的參數(shù)提供了豐富的定制，比如cache，可以幫我們緩存住一些復(fù)雜的計(jì)算結(jié)果，不用每次都耗費(fèi)性能， excludes則可以幫我們?nèi)サ裟切┎幌Ｍ敵龅淖侄危ū热缫粋€(gè)有一千字的小說(shuō)字段，無(wú)疑會(huì)讓我們看調(diào)試信息的時(shí)候走神），有興趣的同學(xué)可以仔細(xì)看末尾的toString文檔。

2、@EqualsAndHashCode
第二個(gè)出場(chǎng)的兄弟名字有點(diǎn)長(zhǎng)，不過(guò)做Java開發(fā)的人都不陌生——equals和hashCode。他們也都是來(lái)自java.lang.Object的兩個(gè)方法，用于對(duì)象的比較。一般實(shí)踐上認(rèn)為，equals相等的兩個(gè)對(duì)象，其hashCode也應(yīng)該相等，這樣在使用HashSet等容器的時(shí)候才不會(huì)有令人錯(cuò)愕的結(jié)果。
在groovy里面，對(duì)類使用了@EqualsAndHashCode注解后，我們將會(huì)自動(dòng)（在編譯期）獲得equals和hashCode方法，還是用上面的代碼來(lái)舉例：
先不做任何處理

    def p = new Person("name":"xiaoming","address":"網(wǎng)商路599號(hào)","age":100)
    def p2 = new Person("name":"xiaoming","address":"網(wǎng)商路599號(hào)","age":100)
    println p==p2

我們知道，在groovy的對(duì)象之間，==號(hào)是形同equals方法的，所以這里的p==p2,就相當(dāng)于Java的p.equals(p2)，對(duì)于未覆寫equals的兩個(gè)對(duì)象來(lái)說(shuō)，這時(shí)候比較的就是兩個(gè)對(duì)象的內(nèi)存地址。結(jié)果和我們預(yù)期的一樣。

false

我們用新學(xué)習(xí)的@EqualsAndHashCode注解來(lái)試試看。

@ToString(includeNames=true)
@EqualsAndHashCode
public class Person {
   String name
   String address
   int age
}

加了這個(gè)注解之后，我們?cè)賵?zhí)行剛才的腳本，這時(shí)候返回的結(jié)果為

true

如果我們只對(duì)某些參數(shù)使用equals和hashCode，我們和上面的@ToString一樣，可以參考@EqualsAndHashCode的參數(shù)來(lái)設(shè)置。比如如果我們使用 excludes來(lái)排除某個(gè)屬性的話，則就算兩個(gè)對(duì)象這個(gè)屬性的值不一樣，他們的比較結(jié)果也是true。

3、@TupleConstructor
這個(gè)注解的含義直接看起來(lái)不是很好理解，元組構(gòu)造器？我們知道，Groovy對(duì)JavaBean做了很棒的改造，可以默認(rèn)為類構(gòu)造一個(gè)Map的構(gòu)造器。比如剛才的Person類，可以使用：

def p = new Person("name":"xiaoming","address":"網(wǎng)商路599號(hào)","age":100)

來(lái)創(chuàng)建一個(gè)對(duì)象。不過(guò)還能不能更簡(jiǎn)單一點(diǎn)呢？這就是我們現(xiàn)在要講的TupleConstructor，加上這個(gè)注解之后，將會(huì)為加上此注解的類對(duì)應(yīng)的對(duì)象加上一個(gè)基于元組的構(gòu)造器，直接上代碼：

@TupleConstructor
@ToString(includeNames=true)
public class Person {
   String name
   String address
   int age
}
def p = new Person("xiaoming","網(wǎng)商路599號(hào)",100)
println p

簡(jiǎn)單吧，詳細(xì)的信息可以看后面的官方文檔，不過(guò)值得注意的是，元組的構(gòu)造器是和字段定義的位置相關(guān)的，在某種意義上并不如map構(gòu)造器那么明了，如果類型不匹配還會(huì)報(bào)運(yùn)行時(shí)異常，應(yīng)該是需要慎用的。

4、講完三個(gè)小弟，終于輪到大哥了。Canonical注解（不知道為什么叫這個(gè)名字），小弟都講了不少，輪到大哥是不是有點(diǎn)緊張了？不用緊張，大哥實(shí)際上就是三個(gè)小弟的合集。你沒(méi)看錯(cuò)，加了@Canonical注解，這個(gè)類就具備了1、2、3個(gè)注解的全部能力，頗有點(diǎn)葫蘆娃合體變成葫蘆小金剛的味道，有木有？

ToString：http://beta.groovy-lang.org/docs/latest/html/gapi/groovy/transform/ToString.html
EqualsAndHashCode: http://beta.groovy-lang.org/docs/latest/html/gapi/groovy/transform/EqualsAndHashCode.html
TupleConstructor： http://beta.groovy-lang.org/docs/latest/html/gapi/groovy/transform/TupleConstructor.html
Canonical ： http://beta.groovy-lang.org/docs/latest/html/gapi/groovy/transform/Canonical.html