
本文旨在解决Java开发中,当使用`Arrays.toString()`打印包含自定义对象的数组时,默认输出对象哈希码而非其实际内容的问题。我们将详细讲解该现象发生的原因,并提供通过重写自定义类的`toString()`方法来优化对象打印输出,使其显示有意义的属性信息,从而提升代码可读性和调试效率的实践方法。
1. 问题现象:Arrays.toString()打印哈希码而非内容
在java编程中,当我们定义了一个自定义类(例如Student),并创建该类的对象数组后,如果尝试使用Arrays.toString()方法直接打印这个数组,通常会观察到输出的是一串类似[com.example.Student@1b6d3586, com.example.Student@4554617c]的字符串,其中@符号后面跟着的是对象的哈希码(十六进制表示)。这并非我们期望看到的对象属性值,如学生姓名、ID或分数。
例如,以下代码在Student类未重写toString()方法时,会打印出对象的哈希码:
import java.util.Arrays; public class Main { private static class Student { String fName; String lName; int id; int score; public Student(String fName, String lName, int id, int score) { this.fName = fName; this.lName = lName; this.id = id; this.score = score; } // ... 其他方法(如getScore()) } public static void main(String[] args) { Student s1 = new Student("Mo", "Nee", 1, 900); Student s2 = new Student("Lee", "Jen", 2, 600); Student[] students = {s1, s2}; System.out.println(Arrays.toString(students)); // 预期输出可能类似:[Main$Student@hashcode1, Main$Student@hashcode2] } }
2. 根本原因:Object类的默认toString()实现
所有Java类都直接或间接继承自java.lang.Object类。Object类提供了一个默认的toString()方法实现,其源代码大致如下:
立即学习“Java免费学习笔记(深入)”;
public String toString() { return getClass().getName() + "@" + Integer.toHexString(hashCode()); }
这个默认实现返回的是“类名@对象的哈希码的十六进制表示”。当Arrays.toString()方法被调用时,它会遍历数组中的每一个元素,并对每个元素调用其自身的toString()方法来获取字符串表示。因此,如果自定义类没有重写toString()方法,就会沿用Object类的默认实现,导致打印出哈希码。
3. 解决方案:重写toString()方法
要解决这个问题,我们需要在自定义类中重写toString()方法。通过重写,我们可以定义对象被转换为字符串时应该如何表示,通常是返回包含对象关键属性值的字符串。
3.1 Student类示例
以Student类为例,我们可以重写其toString()方法,使其返回包含学生ID、姓名和分数的有意义字符串:
import java.util.Arrays; import java.util.Comparator; import java.util.Scanner; public class Main { private static class Student { String fName; // First Name String lName; // Last Name int id; // Student ID int score; // Score public Student(String fName, String lName, int id, int score) { this.fName = fName; this.lName = lName; this.id = id; this.score = score; } public int getScore() { return score; } /** * 重写toString方法,提供Student对象的有意义字符串表示 */ @Override public String toString() { return "id: " + this.id + ", fName: " + this.fName + ", lName: " + this.lName + ", score: " + this.score; } } // 辅助方法:检查字符串是否只包含字母 public static boolean alphabetic(String str) { char[] charArray = str.toCharArray(); for (char c : charArray) { if (!Character.isLetter(c)) return false; } return true; } public static void main(String[] args) { Scanner input = new Scanner(System.in); System.out.println("请输入学生数量:"); int k = input.nextInt(); // 学生数量 Student[] students = new Student[k]; for (int i = 0; i < k; ) { System.out.println("请输入学生ID:"); int id = input.nextInt(); System.out.println("请输入学生姓氏:"); String fName = input.next(); while (!alphabetic(fName)) { System.out.println("输入错误!姓氏必须只包含字母,请重新输入:"); fName = input.next(); } System.out.println("请输入学生名字:"); String lName = input.next(); while (!alphabetic(lName)) { System.out.println("输入错误!名字必须只包含字母,请重新输入:"); lName = input.next(); } System.out.println("请输入学生分数:"); int score = input.nextInt(); students[i++] = new Student(fName, lName, id, score); } // 使用Comparator按分数降序排序 class ByScoreComparator implements Comparator<Student> { @Override public int compare(Student s1, Student s2) { // 对于降序排序,比较s2和s1的分数 return Integer.compare(s2.getScore(), s1.getScore()); } } Arrays.sort(students, new ByScoreComparator()); System.out.println("n排序后的学生信息:"); System.out.println(Arrays.toString(students)); // 现在会打印有意义的内容 input.close(); } }
3.2 运行效果
经过上述修改后,当再次运行代码并打印students数组时,Arrays.toString()将调用我们重写的toString()方法,输出将变为可读性更强的学生信息(此处展示按分数降序排列的示例):
请输入学生数量: 2 请输入学生ID: 1 请输入学生姓氏: Mo 请输入学生名字: Nee 请输入学生分数: 900 请输入学生ID: 2 请输入学生姓氏: Lee 请输入学生名字: Jen 请输入学生分数: 600 排序后的学生信息: [id: 1, fName: Mo, lName: Nee, score: 900, id: 2, fName: Lee, lName: Jen, score: 600]
(注:上述示例中,学生Mo Nee的分数900高于Lee Jen的600,因此Mo Nee排在前面,体现了降序排序的效果。)
4. 注意事项与最佳实践
- @Override注解: 强烈建议在重写toString()方法时使用@Override注解。这有助于编译器检查方法签名是否正确,避免因拼写错误、参数不匹配或其他原因导致方法未被正确重写,从而引发难以发现的bug。
- 信息完整性: 重写toString()方法时,应包含所有重要的、能唯一标识或描述对象状态的属性。这对于理解对象在特定时刻的状态至关重要。
- 可读性: 保持输出格式简洁明了,易于阅读和理解。避免输出过多冗余信息,但也要确保足够的信息量。
- 调试与日志: 一个良好的toString()实现对于调试和日志记录至关重要。当程序出错或需要追踪对象状态时,toString()的输出能帮助开发者快速定位问题。
- IDE自动生成: 现代集成开发环境(IDE),如IntelliJ idea、eclipse等,通常提供自动生成toString()方法的功能。这可以大大提高开发效率,并确保生成的代码符合常见的最佳实践。
- 处理NULL属性: 在toString()方法中拼接字符串时,如果对象属性可能为null,直接拼接可能会导致”null”字符串的出现。在Java 7及更高版本中,可以使用java.util.Objects.toString(Object o, String nullDefault)方法来优雅地处理可能为null的属性,避免NullPointerException,并提供默认值。
总结
当Java中的Arrays.toString()或直接打印自定义对象时显示哈希码而非有意义内容时,其根本原因是自定义类未重写java.lang.Object类的默认toString()方法。通过在自定义类中重写toString()方法,我们可以提供一个定制化的字符串表示,使其包含对象的核心属性信息,从而极大地提升代码的可读性、调试效率和日志记录的有效性。这是一个java开发中非常基础且重要的实践,有助于编写更健壮、更易于维护的代码。


