【案例12-1】：重写toString()方法

【案例介绍】

1.案例描述

为了方便输出对象，Object类提供了toString()方法。但是该方法的默认值是由类名和哈希码组成的，实用性并不强。通常需要重写该方法以提供更多的对象信息。

本案例要求使用反射重写类的toString()方法，并通过反射输出类的包名、类名、类的公共构造方法、类的公共域和类的公共方法。

2.运行结果

 

运行结果

【案例分析】

（1）通过任务的描述可知，此程序需要利用反射重写toString()方法，因此，需要先创建一个类，并在该类中定义两个方法，一个是toString()方法，用于输出类的包、类的名字、类的公共构造方法、类的公共域和类的公共方法等信息；另一个是main()方法，用来进行测试。

（2）由于是重写Object类的toString()方法，因此需要给toString()方法传递一个Object对象。

（3）由于需要利用反射输出类的包、类的名字、类的公共构造方法、类的公共域和类的公共方法，故需要先通过Object对象.getClass()获得代表该类的Class对象，再通过类的Class对象. getPackage()获得类所在的包，通过类的Class对象.getSimpleName()获得类的简单名称，通过类的Class对象.getDeclaredConstructors()获得所有代表构造方法的Constructor数组，遍历数组，判断如果是访问控制符为“public”即为公共构造方法。通过类的Class对象.getDeclaredFields()获得代表所有域的Field数组，遍历数组，判断如果是访问控制符为“public”即为公共域。通过类的Class对象.getDeclaredMethods()获得代表所有方法的Method[]数组，遍历数组，判断如果是访问控制符为“public”即为公方法。

【案例实现】

StringUtils.java

1. package chapter1201;
2. import java.lang.reflect.Constructor;
3. import java.lang.reflect.Field;
4. import java.lang.reflect.Method;
5. import java.lang.reflect.Modifier;
6. public class StringUtils {
7.     @SuppressWarnings("unchecked")
8.     public String toString(Object object) {
9.         // 获得代表该类的Class对象
10.         Class clazz = object.getClass();
11.         // 利用StringBuilder来保存字符串
12.         StringBuilder sb = new StringBuilder();
13.         // 获得类所在的包
14.         Package packageName = clazz.getPackage(); 
15.         // 输出类所在的包
16.         sb.append("包名：" + packageName.getName() + "\t");
17.         String className = clazz.getSimpleName(); // 获得类的简单名称
18.         sb.append("类名：" + className + "\n"); // 输出类的简单名称
19.         sb.append("公共构造方法：\n");
20.         // 获得所有代表构造方法的Constructor数组
21.         Constructor[] constructors = clazz.getDeclaredConstructors();
22.         for (Constructor constructor : constructors) {
23.             String modifier =
24.         Modifier.toString(constructor.getModifiers());// 获得方法修饰符
25.             if (modifier.contains("public")) {// 查看修饰符是否含“public”
26.                 sb.append(constructor.toGenericString() + "\n");
27.             }
28.         }
29.         sb.append("公共域：\n");
30.         // 获得代表所有域的Field数组
31.         Field[] fields = clazz.getDeclaredFields();
32.         for (Field field : fields) {
33.             String modifier = Modifier.toString(field.getModifiers());
34.             if (modifier.contains("public")) {// 查看修饰符是否含“public”
35.                 sb.append(field.toGenericString() + "\n");
36.             }
37.         }
38.         sb.append("公共方法：\n");
39.         // 获得代表所有方法的Method[]数组
40.         Method[] methods = clazz.getDeclaredMethods();
41.         for (Method method : methods) {
42.             String modifier = Modifier.toString(method.getModifiers());
43.         // 查看修饰符是否含有“public”
44.         if (modifier.contains("public")) {
45.                 sb.append(method.toGenericString() + "\n");
46.             }
47.         }
48.         return sb.toString();
49.     }
50.    public static void main(String[] args) {
51.         System.out.println(new StringUtils().toString(new Object()));
52.     }
53. }

上述代码中，第51行代码的new StringUtils().toString(new Object())创建了一个StringUtils对象并调用了其toString()方法，并向toString()方法中传递了一个Object对象。第10行代码通过Object对象.getClass()获得代表该类的Class对象；第14行代码通过Object对象. getPackage()获得类所在的包；第21行代码通过Object对象. getDeclaredConstructors()获得所有代表构造方法的Constructor[]数组，第22-28行代码为遍历Constructor数组，判断如果是访问控制符为“public”即为公共构造方法。第31行代码通过类的Class对象.getDeclaredFields()获得代表所有域的Field[]数组，第32-37行代码为遍历Field数组，判断如果是访问控制符为“public”即为公共域。第40行代码通过类的Class对象.getDeclaredMethods()获得代表所有方法的Method[]数组，第41-49行代码为遍历Method[]数组，判断如果是访问控制符为“public”即为公方法。