java - 如何打印我的 Java 对象而不得到 "SomeType@2f92e0f4"？

Question

我有一个类定义如下:

public class Person {
  private String name;

  // constructor and getter/setter omitted
}

我尝试打印我的类的一个实例:

System.out.println(myPerson);

但我得到以下输出:com.foo.Person@2f92e0f4。

当我尝试打印 Person 对象数组时，发生了类似的事情:

Person[] people = //...
System.out.println(people); 

我得到了输出:[Lcom.foo.Person;@28a418fc

这个输出是什么意思？如何更改此输出，使其包含我的姓名？如何打印我的对象集合？

_{注意:这是关于此主题的规范问答。}

Answer 1

背景

所有 Java 对象都有一个 toString() 方法，当您尝试打印对象时会调用该方法。

System.out.println(myObject);  // invokes myObject.toString()

该方法在 Object 类(所有 Java 对象的父类(super class))中定义。 Object.toString() 方法返回一个看起来相当难看的字符串，由类名、@ 符号和对象的十六进制 hashcode 组成。其代码如下所示:

// Code of Object.toString()
public String toString() {
    return getClass().getName() + "@" + Integer.toHexString(hashCode());
}

因此，诸如 com.foo.MyType@2f92e0f4 这样的结果可以解释为:

• com.foo.MyType - 类的名称，即该类是 com.foo 包中的 MyType。
• @ - 将字符串连接在一起
• 2f92e0f4 对象的哈希码。

数组类的名称看起来有点不同，Class.getName() 的 Javadocs 对此进行了很好的解释。例如，[Ljava.lang.String 表示:

• [ - 一维数组(与 [[ 或 [[[ 等)相对)
• L - 数组包含类或接口(interface)
• java.lang.String - 数组中对象的类型

<小时/>

自定义输出

要在调用 System.out.println(myObject) 时打印不同的内容，您必须在自己的类中 override toString() 方法。这是一个简单的例子:

public class Person {

  private String name;
  
  // constructors and other methods omitted
  
  @Override
  public String toString() {
    return name;
  }
}

现在，如果我们打印一个 Person，我们会看到他们的名字，而不是 com.foo.Person@12345678。

请记住，toString() 只是将对象转换为字符串的一种方法。通常，此输出应以清晰简洁的方式完整描述您的对象。对于我们的 Person 类来说，更好的 toString() 可能是:

@Override
public String toString() {
  return getClass().getSimpleName() + "[name=" + name + "]";
}

它将打印，例如，Person[name=Henry]。这对于调试/测试来说是非常有用的数据。

如果您只想专注于对象的一个​​方面或包含大量爵士乐格式，您可能最好定义一个单独的方法，例如String toElegantReport() {...}。

<小时/>

自动生成输出

许多 IDEs 都支持根据类中的字段自动生成 toString() 方法。例如，请参阅 Eclipse 和 IntelliJ 的文档。

一些流行的 Java 库也提供此功能。一些示例包括:

• ToStringBuilder 来自 Apache Commons Lang

• MoreObjects.ToStringHelper 来自 Google Guava

• 来自 @ToString 的 Project Lombok 注释

<小时/>

打印对象组

所以你已经为你的类创建了一个很好的toString()。如果将该类放入数组或集合中会发生什么？

数组

如果您有一个对象数组，则可以调用 Arrays.toString() 来生成数组内容的简单表示。例如，考虑这个 Person 对象数组:

Person[] people = { new Person("Fred"), new Person("Mike") };
System.out.println(Arrays.toString(people));

// Prints: [Fred, Mike]

注意:这是对 Arrays 类中名为 toString() 的静态方法的调用，这与我们上面讨论的不同。

如果您有一个多维数组，则可以使用 Arrays.deepToString() 来实现相同类型的输出。

集合

大多数集合都会基于对每个元素调用 .toString() 来生成漂亮的输出。

List<Person> people = new ArrayList<>();
people.add(new Person("Alice"));
people.add(new Person("Bob"));    
System.out.println(people);

// Prints [Alice, Bob]

因此，您只需要确保您的列表元素定义了一个很好的 toString()，如上所述。