始终要覆盖toString

始终要覆盖toString

  虽然java.lang.Object提供了toString方法的一个实现，但它返回的字符串通常并不是类的用户所期望看到的。它包含类的名称，以及一个“@”符号，接着是散列码的无符号十六进制表示法，例如“PhoneNumber@163b91”。toString的通用约定指出，被返回的字符串应该是一个“简介的，但信息丰富，并且易于阅读的表达形式”[JavaSE6]。尽管有人认为“PhoneNumber@163b91”算得上简洁和易于阅读，但是与“(707)867-5309”比较起来，它还算不上信息丰富的。toString的约定进一步指出，“建议所有的类都覆盖这个方法。”这是一个很好的建议，真的！

  虽然遵守toString的约定并不像遵守equals和hashCode的约定那么重要，但是，提供好的toString实现可以使类用起来更舒适。当对象被传递给println、print、字符串联操作符(+)以及assert或者被调试器打印出来时，toString方法都会被自动调用。(Java 1.5发行版本在平台增加了printf方法，还提供了好的String.format的先关方法。)

  在实际应用中，toString方法返回对象中包含的所有值得关注的信息。如果对象太大，或者对象中包含的状态信息难以用字符串表达，这样做就有点不切合实际。在这种情况下，toString应该返回一个摘要信息难以用字符串来表达，这样做就有点不切合实际。在这种情况下，toString应该返回一个摘要信息。理想情况下，字符串应该是自描述的(self-explanatory)，(Thread例子不满足这样的要求。)

  在实现toString的时候，必须要做出一个很重要的决定：是否在文档中制定返回值的格式。对于值类(value class)，比电话号码、矩阵类，也建议这么做。指定格式的好处是，它可以被用作一种标准的、明确的、适合人阅读的对象表示法。例如XML文档。如果你指定了格式，最好再提供一个相匹配的静态工厂或者构造器，以便程序员可以很容易地在对象和它的字符串表示法之间来回转换。Java平台中很多值类都采用了这种做法，包括BigInteger、BigDecimal和绝大多数的基本类型包装类(boxed primitive class)。

  指定toString返回值的格式也有不足之处：如果这个类已经被广泛使用，一旦指定格式，就必须始终如一的坚持这种格式。程序员将会编写出相应的代码来解析这种字符串表示法、产生字符串表示法，以及把字符串表示法嵌入到持久的数据中。如果将来的发行版本中改变了这种表示法，就会破坏他们的代码和数据，他们当然就会抱怨。如果不指定格式，就可以保留灵活性，便于在将来的新版本中增加信息，或者改进格式。

  无论你是否决指定格式，都应该在文档中明确地表明你的意图，如果你要指定格式，则应该严格的去做。

  对于那些依赖格式细节编程或者产生永久数据的程序员，在读到注释之后，一旦格式被改变，则只能自己承担结果。

  无论是否指定格式，都为toString返回值中包含所有信息，提供一种编程式的访问途径。