Java 中重写 toString 方法

简介

在 Java 编程中，toString 方法是一个非常重要的方法，它用于返回对象的字符串表示形式。默认情况下，Object 类中的 toString 方法返回的字符串包含类名以及对象的哈希码，对于我们理解对象的实际内容帮助不大。因此，在很多情况下，我们需要重写 toString 方法，以便更清晰、直观地展示对象的属性值。本文将详细介绍在 Java 中重写 toString 方法的相关知识，包括基础概念、使用方法、常见实践以及最佳实践。

基础概念

toString 方法是 java.lang.Object 类的一个实例方法，其定义如下：

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

当我们直接打印一个对象时，实际上调用的就是该对象的 toString 方法。例如：

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

上述代码的输出可能类似于 MyClass@15db9742，其中 MyClass 是类名，15db9742 是对象的哈希码的十六进制表示。这种默认的字符串表示形式对于调试和理解对象状态并不是很有帮助。

使用方法

要重写 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 方法返回一个包含对象属性值的字符串，格式为 Person{name='张三', age=30}，这样的表示形式更加清晰易懂。

现在，我们可以测试这个 Person 类：

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

运行上述代码，输出结果为 Person{name='张三', age=30}。

常见实践

格式化输出

在重写 toString 方法时，可以使用格式化字符串来使输出更加美观。例如，使用 String.format 方法：

public class Rectangle {
    private int width;
    private int height;

    public Rectangle(int width, int height) {
        this.width = width;
        this.height = height;
    }

    @Override
    public String toString() {
        return String.format("Rectangle[width=%d, height=%d]", width, height);
    }
}

包含对象层次结构

如果对象包含其他对象作为属性，重写 toString 方法时需要考虑如何展示这些嵌套对象。例如，有一个 Address 类和一个包含 Address 的 Employee 类：

public class Address {
    private String street;
    private String city;

    public Address(String street, String city) {
        this.street = street;
        this.city = city;
    }

    @Override
    public String toString() {
        return "Address{" +
                "street='" + street + '\'' +
                ", city='" + city + '\'' +
                '}';
    }
}

public class Employee {
    private String name;
    private Address address;

    public Employee(String name, Address address) {
        this.name = name;
        this.address = address;
    }

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

在上述代码中，Employee 类的 toString 方法包含了 Address 对象的 toString 结果。

最佳实践

使用 StringBuilder

当构建复杂的字符串时，使用 StringBuilder 可以提高性能，因为 String 对象是不可变的，每次拼接字符串都会创建一个新的对象。例如：

public class Book {
    private String title;
    private String author;

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

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("Book{");
        sb.append("title='").append(title).append('\'');
        sb.append(", author='").append(author).append('\'');
        sb.append('}');
        return sb.toString();
    }
}

一致性和可读性

保持 toString 方法的输出格式一致，并且确保其易于阅读。可以遵循某种约定，例如使用 JSON 风格的格式或者键值对格式。

避免循环引用

如果对象之间存在循环引用，在重写 toString 方法时需要特别小心，以避免无限递归。一种解决方法是使用某种标识来跟踪已经处理过的对象。

小结

重写 toString 方法在 Java 编程中是一个非常实用的技巧，它可以大大提高代码的可读性和可调试性。通过合理地重写 toString 方法，我们能够清晰地展示对象的属性值，方便我们在开发过程中进行调试和理解对象的状态。在实践中，我们要注意使用 StringBuilder 提高性能，保持输出格式的一致性和可读性，同时避免循环引用等问题。