Classworking工具箱: 注释（Annotation）与ASM - 编程入门网

构建 toString() 方法

Java 平台提供了一个方便的挂钩，以生成 toString() 方法形式的对象的文本描述。最终基类 java.lang.Object 提供了该方法的一个默认实现，但是仍鼓励重写默认实现以提供更有用的描述。许多开发人员习惯提供自己的实现，至少对于那些基本上是数据表示的类是这样。我要先承认我不是其中之一 —— 我常常认为 toString() 非常有用，一般不会费心去重写默认实现。为了更有用些，当从类中添加或删除字段时，toString() 实现需要保持最新。而我发现总的来说这一步太麻烦而不值得实现。

把注释与类文件修改组合起来可以提供一种走出这一困境的方法。我所遇到的维护 toString() 方法的问题是由于代码与类中的字段声明分离了，这意味着每次添加或删除字段时还有一个需要记得更改的东西。通过在字段声明时使用注释，可以很容易地表明想要在 toString() 方法中包含哪些字段，而把该方法的实际实现留给 classworking 工具。这样，所有的东西都在一个地方（字段声明中），而且获得了 toString() 的有用的描述而无需维护代码。

源代码示例

在实现 toString() 方法结构的注释之前，我将给出要实现的代码示例。清单 2 展示了源代码中包含 toString() 方法的示例数据保持类：

清单 2. 带有 toString() 方法的数据类

public　class　Address { 　　 private　String　m_street; 　　 private　String　m_city; 　　 private　String　m_state; 　　 private　String　m_zip; 　　 public　Address()　{} 　　 public　Address(String　street,　String　city,　String　state,　String　zip)　{ 　　　　 m_street　=　street; 　　　　 m_city　=　city; 　　　　 m_state　=　state; 　　　　 m_zip　=　zip; 　　 } 　　 public　String　getCity()　{ 　　　　 return　m_city; 　　 } 　　 public　void　setCity(String　city)　{ 　　　　 m_city　=　city; 　　 } 　　 ... 　　 public　String　toString()　{ 　　　　 StringBuffer　buff　=　new　StringBuffer(); 　　　　 buff.append("Address:　street="); 　　　　 buff.append(m_street); 　　　　 buff.append(",　city="); 　　　　 buff.append(m_city); 　　　　 buff.append(",　state="); 　　　　 buff.append(m_state); 　　　　 buff.append(",　zip="); 　　　　 buff.append(m_zip); 　　　　 return　buff.toString(); 　　 } }

对于清单 2 的示例，我选择在 toString() 输出中包含所有的字段，字段顺序与其在类中声明的顺序相同，并以“name=”文本来开始每个字段值，以在输出中标识它们。对于本例，文本是通过剥去用来标识成员字段的“m_”前缀，来直接从字段名生成的。在其他情况下，我可能想要在输出中仅包含某些字段、更改顺序、更改用于值的标识符文本，或者甚至完全跳过标识符文本。注释格式灵活得足以表示所有的可能。

Classworking工具箱: 注释（Annotation）与ASM(3)

定义注释

可以以多种方式为 toString() 的生成定义注释。为使它真正有用，我情愿最小化所需的注释数目，可能通过使用类注释来标志我想要在其中生成方法的类，并使用单个的字段注释来重写字段的默认处理。这并不太难做到，但是实现代码将变得相当复杂。对于本文来说，我想使它保持简单，因此只使用包含在实例的描述中的单个字段的注释。

我想要控制的因素有：要包含哪些字段，字段值是否有前导文本，该文本是否基于字段名，以及字段在输出中的顺序。清单

凌众科技专业提供服务器租用、服务器托管、企业邮局、虚拟主机等服务，公司网站：http://www.lingzhong.cn 为了给广大客户了解更多的技术信息，本技术文章收集来源于网络,凌众科技尊重文章作者的版权，如果有涉及你的版权有必要删除你的文章，请和我们联系。以上信息与文章正文是不可分割的一部分,如果您要转载本文章,请保留以上信息，谢谢!