虽然Object提供了toString的实现方法，但是返回的字符串通常不是你的类的用户想看到的。它由类名后跟“at”符号（@）和哈希码的无符号十六进制表示组成，例如，PhoneNumber@163b91。toString的一般约定描述了返回的字符串应该是“一个简洁但信息丰富的表示并易读”。虽然可以认为PhoneNumber@163b91是简洁易读的，但是与707-867-5309相比，它的信息量不大。toString约定继续描述，“建议所有子类覆写这个方法。”好建议，真的!
虽然它不像遵守equals和hashCode约定那么重要（item10
和item11 ），但是提供一个好的toString实现使你的类使用更加愉快，并使用该类的系统更容易去调试。当对象传递给println，printf，字符串连接操作符或断言，或由调试器打印时，toString方法被自动调用。即使你从不在对象上调用toString，其他人可能会。例如，一个具有对象引用的组件可能在记录日志错误消息中包含该对象的字符串表示形式。如果你并未覆写toString，消息可能几乎没用。
如果你为PhoneNumber提供了一个好的toString方法，生成的有用的诊断消息就像这样简单：
System.out.println("Failed to connect to " + phoneNumber);
程序员将会以这种形式生成诊断消息，无论你是否覆写toString，但是除非你这么做，否则消息将一无是处。提供一个好的toString方法的好处是扩展了类的实例以外的引用对象，尤其是集合。在打印map时，你更希望看到哪个，{Jenny=PhoneNumber@163b91} 或者 {Jenny=707-867-5309}?
实际上，toString方法应该返回这个类中包含的所有有趣信息，正如电话号码示例所示。如果对象很大或者它包含了不利于字符串表示的状态，那是不切实际的。基于这些情况下，toString应该返回一个摘要，比如"Manhattan residential phone directory (1487536 listings)"或者"Thread[main,5,main]"这样。理想情况下，字符串应该是不言自明的（线程示例使这个测试失败）。如果未能在其字符串表示中包含所有有趣信息，就会产生一个特别恼人的结果，测试失败报告如下所示:
Assertion failure: expected {abc, 123}, but was {abc, 123}.
当实现toString方法时，你必须做出的一个重要的决定是，是否在文档中指定返回值的格式。建议你对值类做此类操作，比如电话号码或矩阵。指定格式的好处是它可以作为对象的标准，明确，人类可读的表示。该表示可以用于输入和输出以及作为人类可读的持久数据对象，比如CSV文件。如果你指定格式，它通常最好提供一个匹配的静态工厂或构造器，以便于程序员能轻松来回转换其对象和其字符串表示。在Java平台库中许多值类都采用了这种方法，包括BigInteger，BigDecimal和大多数装箱原生类。
指定toString返回值格式的缺点是，一旦你指定了，假设你的类被广泛使用，你就终生被束缚了。程序员将编写代码来解析表示，生成并且嵌入持久层数据。如果你在将来版本更改了表示形式，你将会破坏它们的数据和代码。选择不指定格式，就保留了灵活性可以在后续版本中添加信息或改进格式。
无论你是否决定确定格式，你应该清楚地记录你的意图。如果你指定格式，你应该严格遵守。例如，这是与item11中PhoneNumber类一起用的toString方法：
image.png
如果你决定不指定格式，文档注释应该如下所示：
image.png
阅读这个注释后，当格式改变时，程序员生成的依赖于格式细节的代码或者持久数据也会改变，这谁也不怪，只怪程序员自己。
无论你是否指定格式，应该对toString中包含的信息提供编程访问。例如，PhoneNumber类应该包含区号，前缀和行号的访问器。如果你没有那么做，就要强制需要这个信息的程序员解析字符串。除了降低性能和为程序员带来没有必要的工作以外，这个过程容易出错，并且一旦改变格式，脆弱的系统就会崩溃。由于没有提供访问器，字符串的格式成为了事实上的API，即使你已经指定它会变化。在静态工具类 （item4）中编写toString方法是没有意义的。也不该在大多数枚举类型(item34) 中编写toString，因为Java为你提供了一个更好的方法。然而，你应该在任何子类共享一个公共字符串表示形式的抽象类中编写toString方法。例如，在大多数集合实现的toString方法都是继承于抽象集合类的。
在item10中讨论的Google的开源AutoValue工具，将为你生成toString方法，大多数IDE也一样。这些类非常适合告诉你每个字段的内容，但是并不针对描述类的意义。因此，例如，对于我们的PhoneNumber类使用一个自动生成toString方法是不合适的（作为一个电话号码它应该有标准的字符串表示），但是对于Potion类是完全可以接受的。也就是说，一个自动生成的toString方法远比从Object继承的方法要好，因为它不会告诉你对象的值。
回顾一下，在你编写的每个可实例化的类中都应该覆写Object的toString实现，除非它的超类早已这么做了。这使得类更易用以及更容易调试。toString方法应该返回一个简单，易读，有着有用描述的，格式在审美上令人愉悦的字符串。
本文写于2019.3.6，历时1天
网友评论