以toString为中心的Java工程师

每个Java工程师都知道toString方法的存在，它是Object类提供的方法，并且所有的Java类都继承自该类。toString方法的作用是返回该对象的字符串表示。这个方法在debug过程中是非常有用的，开发人员可以直接通过输出对象的toString方法来看到它的值。本文将探讨以toString为中心的Java工程师。

一、toString方法的重写

所有的Java类都有自己的toString方法，但是默认的实现可能并不是很适合我们的需求。开发人员可以通过重写toString方法来改变打印出对象的字符串表示。一般而言，我们使用toString打印出的字符串应该是对象属性的一个简洁的总结。一些注意事项包括：

• toString方法必须是public访问级别
• toString方法不能修改对象状态
• toString方法中应该打印出所有的非-transient属性
• toString方法中应该使用String.format代替字符串连接符

例如，我们有一个Person类，定义如下：

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

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

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

默认情况下，使用System.out.println(person)打印出的结果是：Person@106d69c。但是，如果我们在Person类中重写toString方法如下：

    @Override
    public String toString() {
        return String.format("%s (age %d)", name, age);
    }

将会输出更有意义的字符串：John Doe (age 30)。

二、利用toString做Java对象的打印输出

我们在debug过程中经常需要查看Java对象的状态，这个时候我们就可以用到toString方法。但是，如果我们要打印出多个对象的信息，每次都手动来调用toString方法输出会很繁琐。Java提供了一种更加简便的方式来实现对象的打印输出，就是使用Arrays类的toString方法。

假设我们有一个Student类，定义如下：

public class Student {
    private int id;
    private String name;
    private String major;

    public Student(int id, String name, String major) {
        this.id = id;
        this.name = name;
        this.major = major;
    }

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getMajor() {
        return major;
    }

    public void setMajor(String major) {
        this.major = major;
    }

    @Override
    public String toString() {
        return String.format("Student [id=%d, name=%s, major=%s]", id, name, major);
    }
}

如果我们有一个存储多个学生对象的数组，我们可以使用Arrays类的toString方法直接输出这个数组的信息，如下所示：

Student[] students = new Student[3];
students[0] = new Student(1001, "Mary", "Computer Science");
students[1] = new Student(1002, "John", "Mathematics");
students[2] = new Student(1003, "Simon", "Physics");
System.out.println(Arrays.toString(students));

输出结果如下：

[Student [id=1001, name=Mary, major=Computer Science], Student [id=1002, name=John, major=Mathematics], Student [id=1003, name=Simon, major=Physics]]

三、利用toString进行日志记录

在Web开发领域中，指南针的Java工程师需要写日志记录器是常见的需求。使用日志记录器会让代码更具可操作性，而且能够提供额外的信息。通过toString可以让日志的记录变得更加简洁和易读。还是以Student类为例，我们可以使用以下代码记录学生信息的日志：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Student {
    private static final Logger LOGGER = LoggerFactory.getLogger(Student.class);
    private int id;
    private String name;
    private String major;

    public Student(int id, String name, String major) {
        this.id = id;
        this.name = name;
        this.major = major;
        LOGGER.info("Creating new Student: {}", this);
    }

    @Override
    public String toString() {
        return String.format("Student [id=%d, name=%s, major=%s]", id, name, major);
    }
}

在构造器中，我们可以通过使用{}来引用对象本身，这样就能够输出对象的信息。日志记录器会自动调用toString方法。通过这样的方式，我们可以获得更好的日志信息，同时，也可以更好地跟踪问题。

四、结语

本文探讨了以toString为中心的Java工程师。我们可以利用toString重写，用Arrays类的toString方法进行Java对象的打印输出，使用toString进行日志记录等等。这些技巧可以让日常开发变得更加轻松和高效。