深入理解 Java 中的 `toString()` 方法重写

简介

在 Java 编程中，toString() 方法是一个非常重要且常用的方法。它属于 java.lang.Object 类，这意味着 Java 中的每个类都继承了这个方法。默认情况下，toString() 方法返回的信息对于开发者理解对象的状态帮助有限。因此，我们常常需要重写 toString() 方法，以便更清晰地展示对象的属性值，这对于调试、日志记录以及对象信息的展示都有极大的帮助。本文将详细介绍 overriding toString() 在 Java 中的基础概念、使用方法、常见实践以及最佳实践。

基础概念

toString() 方法定义在 Object 类中，其方法签名如下：

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

默认实现返回的字符串包含对象的类名和一个表示对象内存地址的十六进制哈希码。例如，对于一个自定义类 Person 的对象 person，调用 person.toString() 可能返回类似 com.example.Person@123abc 的字符串。这样的信息对于理解对象内部状态几乎没有帮助，所以需要重写 toString() 方法来提供更有意义的输出。

使用方法

简单示例

假设我们有一个 Person 类，包含 name 和 age 两个属性。要重写 toString() 方法来展示这两个属性，可以如下实现：

public 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 +
                '}';
    }
}

在上述代码中，我们使用了 @Override 注解来表明我们正在重写父类的 toString() 方法。重写后的 toString() 方法返回一个包含 name 和 age 属性值的字符串，这样可以更直观地了解 Person 对象的状态。

使用 `StringBuilder` 提高性能

当对象的属性较多时，使用 + 运算符拼接字符串会产生多个临时字符串对象，影响性能。此时可以使用 StringBuilder 来提高性能，如下所示：

public class Person {
    private String name;
    private int age;

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

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("Person{");
        sb.append("name='").append(name).append('\'');
        sb.append(", age=").append(age);
        sb.append('}');
        return sb.toString();
    }
}

StringBuilder 是可变对象，在拼接过程中不会产生大量临时对象，从而提高了性能。

常见实践

在调试中使用

在开发过程中，调试是非常重要的环节。重写 toString() 方法可以让我们在打印对象时获得更有价值的信息。例如：

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

上述代码中，System.out.println(person) 会调用 person.toString() 方法，输出 Person{name='Alice', age=30}，方便我们查看 Person 对象的属性值，快速定位问题。

在日志记录中使用

在日志记录中，重写 toString() 方法可以记录对象的详细信息，有助于分析系统运行情况。例如使用 log4j 进行日志记录：

import org.apache.log4j.Logger;

public class Main {
    private static final Logger logger = Logger.getLogger(Main.class);

    public static void main(String[] args) {
        Person person = new Person("Bob", 25);
        logger.info(person);
    }
}

日志文件中会记录 Person{name='Bob', age=25}，方便我们追踪对象在系统中的状态变化。

最佳实践

遵循一定的格式规范

为了使输出的字符串具有可读性和一致性，应该遵循一定的格式规范。例如，属性之间可以使用逗号分隔，属性名和值之间使用等号连接。

public 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 + " }";
    }
}

包含必要的属性

重写 toString() 方法时，应确保包含对象的关键属性。对于复杂对象，可能只需要包含标识对象唯一性的属性以及重要的业务属性。例如，对于一个 Order 类，可能只需要包含 orderId 和 totalAmount 等关键属性。

避免循环引用

如果对象之间存在循环引用，重写 toString() 方法时需要特别小心，避免陷入无限循环。例如，A 类包含一个 B 类的引用，而 B 类又包含一个 A 类的引用。可以通过限制输出层次或者使用某种标识来避免循环引用问题。

小结

重写 toString() 方法在 Java 编程中是一项非常实用的技能。通过合理重写 toString() 方法，我们可以更方便地调试代码、记录日志以及展示对象信息。在实际应用中，要遵循一定的格式规范，包含必要的属性，并注意避免循环引用等问题。掌握这些技巧，可以提高我们开发和维护 Java 程序的效率。

参考资料

Oracle Java 官方文档 - Object 类
《Effective Java》第 12 条：覆盖 toString 方法时遵循通用约定。

深入理解 Java 中的 toString() 方法重写

简介

目录