toString()：用于调试还是用于人类？

Question

class Address
{
  private enum Component
  {
    NUMBER,
    STREET,
    STATE,
    COUNTRY
  }

  private Map<Component, String> componentToValue = ...;
}

我希望我的类包含两种方法：

1. 一种用于指示每个地址组件的值（这样我可以在出现问题时进行调试）。
2. 以人类期望的形式返回地址：“1600 Amphitheatre Parkway Mountain View, CA 94043”。

Object.toString() 的最佳实践是什么？它主要是针对#1还是#2？这些方法的命名是否有最佳实践？

Answer 1

您是否会在 SMS 消息和 HTML 页面中以相同的方式设置地址格式？英语、法语和日语的格式是否相同？

如果不是，那么您就有了答案：表示不属于该对象，而是属于显示该对象的表示层。除非该对象是专门为表示层制作的，例如如果它是 HtmlI18nedAddress，则使用 toString 进行调试。

考虑 Date 与 SimpleDateFormat。 Date 包含状态，SimpleDateFormat 返回多种表示形式。

Answer 2

我想说的是第一个。数据格式化不应硬编码到对象的 ToString() 函数中。

我这样看：我尝试使 ToString() 输出数据可由匹配的 Parse(string data) 函数读取（该函数是否实际存在并不重要）。因此，在这种情况下，如果您想要特定的格式，请编写特定的函数，并将通用数据转储例程留给 ToString()。

Answer 3

我通常使用 Apache Commons ToStringBuilder http: //commons.apache.org/lang/api-2.5/org/apache/commons/lang/builder/ToStringBuilder.html 仅包含我认为调试绝对必要的部分。

Answer 4

根据 Effective Java 第 12 项：“始终重写 toString “toString() 的约定是：

结果应该是简洁但信息丰富的表示形式，易于人们阅读。 [...]提供良好的 toString 实现可以使您的类更易于使用，并使使用该类的系统更易于调试。

因此，它是为了调试。

关于toString()的更多注释：

• 添加JavaDoc（这里应该解释格式）
• 一旦格式固定，请记住该格式将用于解析。

我强烈推荐投资《Effective Java》这本书。这是一本非常好的读物。一个项目只需五到十分钟，但您的 Java 生活将永远改变！

Answer 5

您可以从动态配置的某些调试属性中读取：

@Override
public String toString() { 

    if(debug) {
        return debugAddrString()
    }
    return normalAddrString();

}

Answer 6

ToString 通常应该仅用于调试信息。请记住，您正在重写 Object 上的方法；对 Object 引用进行方法调用返回人类可读的地址在概念上准确吗？在某些情况下，根据项目的不同，这实际上可能是有意义的，但对我来说听起来有点奇怪。我会实施一种新方法。

另一件需要注意的事情是，大多数现代 IDE 在检查对象时使用 ToString 方法来打印有关对象的调试信息。

Answer 7

您可以做的一件事是使用调试标志来根据需要更改此设置：

public String toString(boolean debug) {
    if (debug) return debugStringVersion;
    else return humanVersion;
}

public String toString() {
    return toString(Util.DEBUG);
}

当然，这假设您有一个带有调试标志的实用程序类。