今天來講一下Groovy的groovy.transform包的第一個故事,先簡單介紹一下這個包:transform是Groovy設計者在編譯期對語言做出的一些優化,這些優化不會觸及到JVM層次的字節碼,但是又能為開發者提供更簡潔優雅的coding風格,詳情我另文介紹。開始說說今天的主角。
1、@ToString
在JVM實現里,所有的類都默認是java.lang.Object的子類,因此所有的類都可以繼承和覆寫Object類里的toString方法,在打印的時候,這個toString就相當于這個類的名片,可以根據寫作者的意愿來返回一個String。一般來說,在Java開發過程中,我們會把一些關鍵的信息組合到這個String里面來,或者是全部的屬性值組合到這個String來,為我們提供一些運行時的數據信息。不過更多的時候,我們會選擇不實現這個方法,并非有別的考慮,只是“怕麻煩”。(在Java里,可以借助org.apache.common.lang.builder.ReflectionToStringBuilder的toString方法,以反射的方式來生成屬性值的組合)
在groovy里,這個問題得到了更妥善的解決,我們可以給需要實現toString的類加上@toString注解來簡單完成此需求,看下面的代碼。
public class Person {
String name
String address
int age
}
def p = new Person("name":"xiaoming","address":"網商路599號","age":100)
println p
執行結果是:
com.xiaonanzhi.transform.model.Person@1bf7857f
其中@后面的字符串是不確定的,這個實際上調用的是java.lang.Object對象的toString方法,這個方法是這么實現的:
public String toString() {
return getClass().getName() + "@" + Integer.toHexString(hashCode());
}
@后面的數字實際上對應了Object里面native實現的hashCode方法,實際上對應的是對象的內存地址?,F在給Person加上@toString注解,我們再看下結果:
com.xiaonanzhi.transform.model.Person(xiaoming, 網商路599號, 100)
ToString注解幫我們把這個類的屬性都輸出了,不過貌似沒有屬性名稱啊,真是缺憾啊……且慢,我們再仔細看看ToString注解的文檔,原來只要加上includeNames=true的參數,就可以連著屬性名打印了,所以現在注解變為:
@ToString(includeNames=true)
輸出則變成了
com.xiaonanzhi.transform.model.Person(name:xiaoming, address:網商路599號, age:100)
如此一來我們知道了toString的參數設置方式,就是往注解里填參數,已有的參數提供了豐富的定制,比如cache,可以幫我們緩存住一些復雜的計算結果,不用每次都耗費性能, excludes則可以幫我們去掉那些不希望輸出的字段(比如一個有一千字的小說字段,無疑會讓我們看調試信息的時候走神),有興趣的同學可以仔細看末尾的toString文檔。
2、@EqualsAndHashCode
第二個出場的兄弟名字有點長,不過做Java開發的人都不陌生——equals和hashCode。他們也都是來自java.lang.Object的兩個方法,用于對象的比較。一般實踐上認為,equals相等的兩個對象,其hashCode也應該相等,這樣在使用HashSet等容器的時候才不會有令人錯愕的結果。
在groovy里面,對類使用了@EqualsAndHashCode注解后,我們將會自動(在編譯期)獲得equals和hashCode方法,還是用上面的代碼來舉例:
先不做任何處理
def p = new Person("name":"xiaoming","address":"網商路599號","age":100)
def p2 = new Person("name":"xiaoming","address":"網商路599號","age":100)
println p==p2
我們知道,在groovy的對象之間,==號是形同equals方法的,所以這里的p==p2,就相當于Java的p.equals(p2),對于未覆寫equals的兩個對象來說,這時候比較的就是兩個對象的內存地址。結果和我們預期的一樣。
false
我們用新學習的@EqualsAndHashCode注解來試試看。
@ToString(includeNames=true)
@EqualsAndHashCode
public class Person {
String name
String address
int age
}
加了這個注解之后,我們再執行剛才的腳本,這時候返回的結果為
true
如果我們只對某些參數使用equals和hashCode,我們和上面的@ToString一樣,可以參考@EqualsAndHashCode的參數來設置。比如如果我們使用 excludes來排除某個屬性的話,則就算兩個對象這個屬性的值不一樣,他們的比較結果也是true。
3、@TupleConstructor
這個注解的含義直接看起來不是很好理解,元組構造器?我們知道,Groovy對JavaBean做了很棒的改造,可以默認為類構造一個Map的構造器。比如剛才的Person類,可以使用:
def p = new Person("name":"xiaoming","address":"網商路599號","age":100)
來創建一個對象。不過還能不能更簡單一點呢?這就是我們現在要講的TupleConstructor,加上這個注解之后,將會為加上此注解的類對應的對象加上一個基于元組的構造器,直接上代碼:
@TupleConstructor
@ToString(includeNames=true)
public class Person {
String name
String address
int age
}
def p = new Person("xiaoming","網商路599號",100)
println p
簡單吧,詳細的信息可以看后面的官方文檔,不過值得注意的是,元組的構造器是和字段定義的位置相關的,在某種意義上并不如map構造器那么明了,如果類型不匹配還會報運行時異常,應該是需要慎用的。
4、講完三個小弟,終于輪到大哥了。Canonical注解(不知道為什么叫這個名字),小弟都講了不少,輪到大哥是不是有點緊張了?不用緊張,大哥實際上就是三個小弟的合集。你沒看錯,加了@Canonical注解,這個類就具備了1、2、3個注解的全部能力,頗有點葫蘆娃合體變成葫蘆小金剛的味道,有木有?
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