我有一个类定义如下:

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

这个输出意味着什么?如何更改此输出,使其包含我的人的名字?我如何打印对象的集合?

注意:这是一个关于这个主题的规范问答。


背景

所有Java对象都有toString()方法,在尝试打印对象时调用该方法。

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

此方法在Object类(所有Java对象的超类)中定义。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。字符串的意思是:

[-一维数组(相对于[[或[[[等)) L -数组包含一个类或接口 string——数组中对象的类型


自定义输出

要在调用System.out.println(myObject)时打印不同的东西,必须在自己的类中重写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(){…}。


自动生成输出

许多ide提供了基于类中的字段自动生成toString()方法的支持。例如,请参阅Eclipse和IntelliJ的文档。

一些流行的Java库也提供了这一特性。一些例子包括:

ToStringBuilder来自Apache Commons Lang MoreObjects。ToStringHelper从谷歌番石榴 来自Project Lombok的@ToString注释


打印对象组

这样,您就为类创建了一个不错的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()。


默认情况下,Java中的每个类都有toString()方法,如果将该类的某个对象传递给System.out.println(),则会调用该方法。默认情况下,该调用返回该对象的className@hashcode。

{
    SomeClass sc = new SomeClass();
    // Class @ followed by hashcode of object in Hexadecimal
    System.out.println(sc);
}

您可以重写类的toString方法以获得不同的输出。请看这个例子

class A {
    String s = "I am just a object";
    @Override
    public String toString()
    {
        return s;
    }
}

class B {
    public static void main(String args[])
    {
        A obj = new A();
        System.out.println(obj);
    }
}

我认为apache提供了一个更好的util类,它提供了一个函数来获取字符串

ReflectionToStringBuilder.toString(object)

在Eclipse中, 去上课吧, 右击->源->生成toString();

它将重写toString()方法并打印该类的对象。


如果你直接打印Person的任何对象,它将ClassName@HashCode到代码。

你的情况是com.foo。Person@2f92e0f4正在被打印。其中Person是对象所属的类,2f92e0f4是对象的hashCode。

public class Person {
  private String name;

  public Person(String name){
  this.name = name;
  }
  // getter/setter omitted

   @override
   public String toString(){
        return name;
   }
}

现在如果你尝试使用Person对象,那么它会打印名字

Class Test
 {
  public static void main(String... args){
    Person obj = new Person("YourName");
    System.out.println(obj.toString());
  }
}

在intellij中,您可以通过按alt+inset然后选择toString()自动生成toString方法,这里是一个测试类的输出:

public class test  {
int a;
char b;
String c;
Test2 test2;

@Override
public String toString() {
    return "test{" +
            "a=" + a +
            ", b=" + b +
            ", c='" + c + '\'' +
            ", test2=" + test2 +
            '}';
 }
}

正如您所看到的,它通过连接类的几个属性来生成一个String,对于原语,它将打印它们的值,对于引用类型,它将使用它们的类类型(在本例中是Test2的to String方法)。


如果你看一下Object类(Java中所有类的父类),toString()方法实现是

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

当你在Java中打印任何对象时,toString()将被调用。现在由你决定,如果你重写toString(),那么你的方法将调用其他Object类的方法调用。


默认情况下,Java中的每个对象都有toString()方法,该方法输出ObjectType@HashCode。

如果您想要更多有意义的信息,那么您需要重写类中的toString()方法。

public class Person {
  private String name;

  // constructor and getter/setter omitted

  // overridding toString() to print name
  public String toString(){
     return name;  
  }
}

现在当你打印person对象时使用System.out.prtinln(personObj);它将打印人名,而不是类名和hashcode。

在第二种情况下,当你试图打印数组时,它会打印数组类型[Lcom.foo.Person;


如果要打印人名,有很多方法。

您可以编写自己的函数,迭代每个人并输出

void printPersonArray(Person[] persons){
    for(Person person: persons){
        System.out.println(person);
    }
}

你可以使用Arrays.toString()来打印它。这对我来说似乎是最简单的。

 System.out.println(Arrays.toString(persons));
 System.out.println(Arrays.deepToString(persons));  // for nested arrays  

你可以用java 8的方式打印它(使用流和方法引用)。

 Arrays.stream(persons).forEach(System.out::println);

也许还有其他方法。希望这能有所帮助。:)


我更喜欢使用一个实用函数,它使用GSON将Java对象反序列化为JSON字符串。

/**
 * This class provides basic/common functionalities to be applied on Java Objects.
 */
public final class ObjectUtils {

    private static final Gson GSON = new GsonBuilder().setPrettyPrinting().create();

    private ObjectUtils() {
         throw new UnsupportedOperationException("Instantiation of this class is not permitted in case you are using reflection.");
    }

    /**
     * This method is responsible for de-serializing the Java Object into Json String.
     *
     * @param object Object to be de-serialized.
     * @return String
     */
    public static String deserializeObjectToString(final Object object) {
        return GSON.toJson(object);
    }
}

我在Spring 5中使用Jackson做到了这一点。根据对象的不同,它可能不是在所有情况下都有效。

import com.fasterxml.jackson.databind.ObjectMapper;
    
ObjectMapper mapper = new ObjectMapper();
System.out.println(mapper.writeValueAsString(yourObject));

输出是这样的

{
  "id" : 1,
  "fieldOne" : "string"
}

这里有更多使用Jackson的例子

如果你用GSON代替,它可能看起来像

Gson gson = new Gson();
System.out.println(gson.toJson(yourObject));

对于“deep”toString(),有一个基于JSON的答案(Jackson, GSON等)的替代方案:来自Apache Commons Lang 3库的ReflectionToStringBuilder,使用RecursiveToStringStyle或MultilineRecursiveToStringStyle。代码示例:

System.out.println("My object: " +
    ReflectionToStringBuilder.toString(theObject, new RecursiveToStringStyle()));

输出示例:

// RecursiveToStringStyle
Person@7f54[name=Stephen,age=29,smoker=false,job=Job@43cd2[title=Manager]]

// MultilineRecursiveToStringStyle
Person@7f54[
  name=Stephen,
  age=29,
  smoker=false,
  job=Job@43cd2[
    title=Manager
  ]
]

如果您正在使用项目Lombok,您可以使用@ToString注释并生成一个标准的toString()方法,而无需添加样板。

import lombok.ToString;

@ToString
public class LoginDto {
  private String user;
  private String pass;
}
...
System.out.println(loginDto.toString());
// LoginDto(user=x@xxx.x, pass=xxxxx)

在类上使用Lombok @Data注释将提供getter、setter、toString和hashcode。使用Lombok更好,因为它处理样板代码。