所有类都应该有一个toString方法,这也是Object的约定。很明显在实际使用中,同样也是,每个类的实例对象,都该有个方法将人们感兴趣的内容以String类型返回,在没有跟踪工具的年代,我们就是靠着Debug这些toString来调试程序的。
这一条其实没有什么太多可写的,只要记住一点即可“将你所关心的、感兴趣的部分toString了就可以了”。现今而言,由于有了Eclipse、NetBeans这样的工具,在调试过程中依靠Debug toString的时候就不见了。剩下的就是那些可能要求被输出的类的toString方法了,一定要写好。例如:
- /**
- * Return the string representation of this phone number.
- * The string whose format is "(XXXX)YYYYZZZZ", where XXXX is area code,
- * YYYY is depart code, and ZZZZ is terminal code.
- * For exemple: "(0532)86780106"
- */
- public class PhoneNumber {
- private String areaCode;
- private String departCode;
- private String terminalCode;
- public PhoneNumber (String areaCode, String departCode, String terminalCode) {
- .......
- }
- public String toString() {
- StringBuffer sb = new StringBuffer (20);
- sb.append ("(");
- sb.append (this.areaCode);
- sb.append (")");
- sb.append (this.departCode);
- sb.append (this.terminalCode);
- return sb.toString();
- }
- }
/** * Return the string representation of this phone number. * The string whose format is "(XXXX)YYYYZZZZ", where XXXX is area code, * YYYY is depart code, and ZZZZ is terminal code. * For exemple: "(0532)86780106" */ public class PhoneNumber { private String areaCode; private String departCode; private String terminalCode; public PhoneNumber (String areaCode, String departCode, String terminalCode) { ....... } public String toString() { StringBuffer sb = new StringBuffer (20); sb.append ("("); sb.append (this.areaCode); sb.append (")"); sb.append (this.departCode); sb.append (this.terminalCode); return sb.toString(); } }
- PhoneNumber pn = new PhoneNumber ("010", "8776", "0568");
- logger.debug(pn.toString());
PhoneNumber pn = new PhoneNumber ("010", "8776", "0568"); logger.debug(pn.toString());
输出结果:(010)87760568
最后,还有一点,就是在toString的注视中写明输入格式,这些注释将被用在文档当中。