ITEM 12: ALWAYS OVERRIDE TOSTRING
Object 提供 toString 方法的默认实现，但它返回的字符串通常不是类的用户想要看到的。它由类名后跟“at”符号(@)和散列代码的无符号十六进制表示形式组成，例如 PhoneNumber@163b91。toString的一般契约规定，返回的字符串应该是“简洁但信息丰富的表示形式，便于阅读”。虽然可以认为PhoneNumber@163b91简洁易懂，但与707-867-5309相比，它的信息量还是过少。
toString 的契约提供了一个很好的解决方案： “建议所有子类重写这个方法。”。
虽然它没有遵守 equals 和 hashCode 契约那么重要，但是提供一个好的toString 实现会使您的类更易于使用，并且使使用该类的系统更容易调试。当对象传递给println、printf、字符串连接操作符或 assert ，或由调试器打印时，toString方法将自动被调用。即使您从来没有调用对象上的 toString 方法，其他人可能会这样做。例如，输出一个错误日志，信息中包含一个引用了没有覆盖toString方法的类，那么此时我们输出的消息可能几乎毫无用处。如果您已经为 PhoneNumber 提供了一个好的 toString 方法，那么生成一个有用的诊断消息就像这样简单：
System.out.println("Failed to connect to " + phoneNumber);
无论您是否覆盖 toString，程序员都将以这种方式生成诊断消息，但是除非您这样做，否则这些消息将毫无用处。提供好的 toString 方法的好处不仅限于类的实例，还包括包含对这些实例的引用的对象，尤其是集合。在打印地图时，{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 返回值格式的缺点是，一旦指定了它，就必须一直使用它，假设您的类被广泛使用。程序员将编写代码来解析表示，生成表示，并将其嵌入到持久数据中。如果您在将来的版本中更改表示形式，您将破坏他们的代码和数据，而他们将会咆哮。通过选择不指定格式，您可以保留在后续版本中添加信息或改进格式的灵活性。无论您是否决定指定格式，您都应该清楚地记录您的意图。如果指定了格式，就应该精确地指定。例如，这里有一个 toString 方法与item 11中的 PhoneNumber 类一起使用：
/**
* Returns the string representation of this phone number.
* The string consists of twelve characters whose format is
* "XXX-YYY-ZZZZ", where XXX is the area code, YYY is the
* prefix, and ZZZZ is the line number. Each of the capital
* letters represents a single decimal digit. *
* If any of the three parts of this phone number is too small
* to fill up its field, the field is padded with leading zeros.
* For example, if the value of the line number is 123, the last
* four characters of the string representation will be "0123".
*/
@Override
public String toString() {
return String.format("%03d-%03d-%04d", areaCode, prefix, lineNum);
}
如果您决定不指定格式，文档注释应该如下所示:
/**
* Returns a brief description of this potion. The exact details
* of the representation are unspecified and subject to change,
* but the following may be regarded as typical: *
* "[Potion #9: type=love, smell=turpentine, look=india ink]"
*/
@Override public String toString() { ... }
在阅读了注释之后，当格式发生更改时，生成依赖于格式细节的代码或持久数据的程序员只能怪他们自己。无论是否指定格式，都要提供对toString返回的值中包含的信息的编程访问。例如，PhoneNumber 类应该包含区号、前缀和行号的访问器。如果做不到这一点，就会迫使需要此信息的程序员解析字符串。除了降低性能和为程序员做不必要的工作之外，这个过程还容易出错，如果更改格式，会导致脆弱的系统崩溃。由于无法提供访问器，您可以将字符串格式转换为事实上的API，即使您已经指定它可能会发生更改。
在静态实用程序类中编写 toString 方法毫无意义，也不应该在大多数 enum 类型中编写 toString 方法，因为Java为您提供了一个非常好的方法。但是，应该对抽象类编写 toString 方法，这样它的子类能使用公共的字符串表示方法。例如，大多数集合实现上的 toString 方法都是从抽象集合类继承的。
item 10 中讨论的谷歌开源自动值工具将为您生成 toString 方法，大多数 IDE 也有这样的功能。这些方法可以很好地告诉您每个字段的内容，但并不专门针对类的含义。例如，为我们的 PhoneNumber 类使用自动生成的toString方法是不合适的(因为电话号码有一个标准的字符串表示)，但是对于我们的 Potion 类来说，这是完全可以接受的。也就是说，自动生成的 toString 方法要比从 Object 继承的方法好得多，后者对对象的值一无所知。
重述一下，除非超类已经这样做了，否则您应该在编写的每个实例化类中重写 Object的 toString 实现。它使类更易于使用，并有助于调试。toString 方法应该以美观的格式返回对象的简洁、有用的描述。
