第10条:始终要覆盖toString

java.lang.Object的toString方法的实现:
public String toString() {
    return getClass().getName() + "@" + Integer.toHexString(hashCode());
}

        这通常不是用户期望看到的,它包含类名称,一个“@”符号,以及散列码的无符号十六进制表示法。toString通用约定指出,被返回的字符串应该是一个“简洁的,但信息丰富,并且易于阅读的表达形式”,进一步的约定指出,建议所有的子类都覆盖这个方法。

        在实际应用中,toString方法应该返回对象中包含的所有值得关注的信息,如果对象太大或者对象中包含的状态信息难以用字符来表达,这样做就有点不切实际了。在这种情况下toString方法应该返回一个摘要信息。提供好的toString方法可以使类用起来更加舒适,当对象被传递给println、printf、字符串联操作符(+)以及assert或者被调试器打印出来时,toString方法会被自动调用,产生有用的诊断信息也会非常容易:
public class TFyAj1 {
    public String CBh;
    public String CAh;
    public String getCBh() { return CBh; }
    public void setCBh(String cBh) { CBh = cBh; }
    public String getCAh() { return CAh; }
    public void setCAh(String cAh) { CAh = cAh; }
}
public class TFyAj2 {
    public String CBh;
    public String CAh;
    public String getCBh() { return CBh; }
    public void setCBh(String cBh) { CBh = cBh; }
    public String getCAh() { return CAh; }
    public void setCAh(String cAh) { CAh = cAh; }

    /*
     * Returns 案号
     */
    @Override public String toString() { return "案号:" + CAh; }
}

        在实现toString方法时,应该做出一个重要的决定,是否在文档中指定返回值的格式,对于值类也建议这么做,因为这可以被用做一种标准的、明确的、适合人阅读的对象表示法。这种表示法可以用于输入和输出以及用在永久的适合于人类阅读的数据对象中,如xml文档。如果指定了格式,那么就最好再提供一个相匹配的静态工厂方法或者构造器,以便程序员可以很容易地在对象和它的字符串表示法之间来回切换。Java平台类库中的许多值类都采用这种做法,包括BigInteger、BigDecimal和绝大多数的基本类型包装类(boxed primitive class)。

        指定格式也有其不足的地方,就是限制了toString()的灵活性,一旦指定了格式就必须坚持这种格式,程序员会编写相应的代码来解析这种字符串表示法,产生字符串表示法,以及把字符串表示嵌入到持久的数据中。如果将来的版本中改变了这种做法就会破坏他们的代码和数据。如果不指定格式的话就可以保留灵活。无论是否决定指定格式,都应该在文档中明确地表明你的意图。如果要指定格式必须严格遵守这条约定,如果不指定格式那么文档注释部分也应该有指示的指示信息。对于那些依赖于格式的细节进行编程或者产生永久数据的程序员在读到这行注释后,一旦格式改变就得自己承担后果了。

        无论是否指定格式,都为toString返回值中包含的所有信息,提供一种编程式的访问途径。(get?)如果不这么做,就会迫使那些需要这些信息的程序员不得不自己去解析这些字符串。降低了程序的性能,使得程序员去做这些不必要的工作,而且解析过程也很容易出错,会导致系统不稳定,如果格式发生变化还会导致系统崩溃。如果没有提供这些方法,即使你已经指明字符串格式是可以变化的,这个字符串格式也成了事实上的API。

总结:
        1、toString方法应该包含对象中所有值得关注的信息。
        2、无论你是否决定指定格式,都应该在文档中明确地表明你的意图:
            1)如果你要指定格式,则应该严格地这样去做。
            2) 如果你决定不指定格式,那么文档注释部分也应该有指示信息。
        3、无论是否指定格式,都为toString返回值中包含的所有信息,提供一种编程式的访问途径。

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,497评论 18 139
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,500评论 18 399
  • ¥开启¥ 【iAPP实现进入界面执行逐一显】 〖2017-08-25 15:22:14〗 《//首先开一个线程,因...
    小菜c阅读 6,327评论 0 17
  • 一. Java基础部分.................................................
    wy_sure阅读 3,774评论 0 11
  • “心存感激地生活吧。我们来自偶然,生命是最宝贵的礼物。爱你所爱的人,温柔对待一切,不要因不幸怨恨和悲戚。无论前途怎...
    简不悔阅读 883评论 4 2