关于Canonical和它的三个小弟

今天来讲一下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方法,实际上对应的是对象的内存地址。现在给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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,033评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,725评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,473评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,846评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,848评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,691评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,053评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,700评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,856评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,430评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,034评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2 343

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,598评论 18 139
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,577评论 18 399
  • 前言 人生苦多,快来 Kotlin ,快速学习Kotlin! 什么是Kotlin? Kotlin 是种静态类型编程...
    任半生嚣狂阅读 26,142评论 9 118
  • 带娃去海南玩之前我是很担心的,毕竟在北京爸爸妈妈爷爷奶奶四个人伺候娃一个人有时还觉得累,在海南虽然有姥姥姥爷,但是...
    corlorwind阅读 373评论 0 0
  • 汶川地震九周年,当年的随行排长在救灾日记中写了这么一段,他问护士是接到谁的命令在这儿开设救护站的,护士说:“谁的命...
    凤歌儿阅读 2,039评论 0 3