Java 中的 toString 方法详解

简介

在 Java 编程中，toString 方法是一个基础且重要的方法，它属于 java.lang.Object 类。由于 Java 中所有类都直接或间接继承自 Object 类，因此每个类都拥有 toString 方法。toString 方法的主要作用是返回对象的字符串表示形式，这在调试、日志记录以及将对象信息输出到控制台等场景中非常有用。本文将详细介绍 toString 方法的基础概念、使用方法、常见实践以及最佳实践。

基础概念

toString 方法定义在 java.lang.Object 类中，其默认实现如下：

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

这个默认实现返回的字符串包含了对象所属类的全限定名和对象的哈希码的十六进制表示。例如：

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

输出结果可能类似于：

Example@1b6d3586

这种默认的字符串表示形式对于大多数实际应用来说并没有太大的意义，因此通常需要在自定义类中重写 toString 方法。

使用方法

要重写 toString 方法，只需要在自定义类中定义一个与 Object 类中 toString 方法签名相同的方法，即返回类型为 String，方法名为 toString，且没有参数。以下是一个简单的示例：

class Person {
    private String name;
    private int age;

    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }

    @Override
    public String toString() {
        return "Person{name='" + name + "', age=" + age + "}";
    }

    public static void main(String[] args) {
        Person person = new Person("Alice", 25);
        System.out.println(person.toString());
    }
}

输出结果为：

Person{name='Alice', age=25}

在这个示例中，我们重写了 Person 类的 toString 方法，返回了一个包含对象属性信息的字符串。

常见实践

日志记录

在日志记录中，toString 方法可以方便地将对象的状态信息记录下来，便于调试和问题排查。例如：

import java.util.logging.Level;
import java.util.logging.Logger;

class Employee {
    private String name;
    private int employeeId;

    public Employee(String name, int employeeId) {
        this.name = name;
        this.employeeId = employeeId;
    }

    @Override
    public String toString() {
        return "Employee{name='" + name + "', employeeId=" + employeeId + "}";
    }

    public static void main(String[] args) {
        Logger logger = Logger.getLogger(Employee.class.getName());
        Employee employee = new Employee("Bob", 123);
        logger.log(Level.INFO, "New employee added: {0}", employee);
    }
}

集合打印

当打印包含对象的集合时，toString 方法可以让集合中的对象以更易读的形式显示。例如：

import java.util.ArrayList;
import java.util.List;

class Book {
    private String title;
    private String author;

    public Book(String title, String author) {
        this.title = title;
        this.author = author;
    }

    @Override
    public String toString() {
        return "Book{title='" + title + "', author='" + author + "'}";
    }

    public static void main(String[] args) {
        List<Book> bookList = new ArrayList<>();
        bookList.add(new Book("Java Programming", "John Doe"));
        bookList.add(new Book("Data Structures", "Jane Smith"));
        System.out.println(bookList);
    }
}

最佳实践

提供有意义的信息

重写 toString 方法时，应该提供对象的关键属性信息，以便于理解对象的状态。避免只返回默认的类名和哈希码。

避免递归调用

如果对象包含对其他对象的引用，要注意避免在 toString 方法中出现递归调用，导致栈溢出错误。例如：

class A {
    private B b;

    public A(B b) {
        this.b = b;
    }

    @Override
    public String toString() {
        return "A{b=" + b + "}";
    }
}

class B {
    private A a;

    public B(A a) {
        this.a = a;
    }

    @Override
    public String toString() {
        return "B{a=" + a + "}";
    }

    public static void main(String[] args) {
        A a = new A(null);
        B b = new B(a);
        a = new A(b);
        // 以下代码会导致栈溢出错误
        // System.out.println(a); 
    }
}

为了避免这种情况，可以只打印引用对象的关键信息，而不是直接调用其 toString 方法。

使用 `@Override` 注解

在重写 toString 方法时，使用 @Override 注解可以让编译器检查是否正确重写了方法，避免因方法签名错误而导致的问题。

小结

toString 方法是 Java 中一个非常实用的方法，它允许我们将对象的状态以字符串的形式表示出来。通过重写 toString 方法，我们可以提供有意义的对象信息，方便调试、日志记录和输出显示。在重写时，要注意提供关键信息、避免递归调用，并使用 @Override 注解。

参考资料

The Java Tutorials: Object Class
Effective Java by Joshua Bloch