发现多功能的模板驱动的代码生成器

文档选项 将此页作为电子邮件发送 最新推荐 Java 应用开发源动力 － 下载免费软件，快速启动开发

级别: 初级

Sing Li , 作者, Wrox Press

2004 年 11 月 05 日

开放源代码的 XDoclet 代码生成引擎，是许多领先的 Java 框架不可缺少的组成部分，常常被用作面向属性的编程和持续集成的引擎。但是 XDoclet 还有一些不太惹人注目的地方：对初级开发人员来说，它太难掌握、太难精通。在这篇文章中，流行作者 Sing Li 以 XDoclet 为对象，揭示了其内部简单却优雅的设计，使您能够理解这项技术，并将它应用在实践当中。

XDoclet 能够很容易成为您的 Java 编程工具箱中的一个更加通用的跨技术代码生成工具。不幸的是，开发人员经常忽视 XDoclet 的一般用途，只有将它捆绑在大型开发框架或者 IDE 中，作为其中的一个隐藏元素时，才会用到它。人们常常认为很难将 XDoclet 应用在定制解决方案上。这篇文章的目的就是要消除这个迷惑，把 XDoclet 从常见的复杂陷阱中解脱出来，并向您展示了如何能够利用这个代码生成引擎。

我会用一个实际的例子演示 XDoclet 的用途，该例子将接收一个 POJO（plain old Java object），并用 XDoclet 生成完整 Web 应用程序的全部文件，这些文件是把数据输入关系数据库所必需的。该示例使用了 XDoclet 的 自定义模板代码生成功能，以及它对 Hibernate 对象关系映射工具、Struct Web 应用程序框架和应用程序服务器的内部支持。（请参阅 参考资料）。

智能代码生成器

XDoclet 的核心功能是根据以下组合来生成代码的（或者生成其他配置/数据文件）：

• 进行特殊标记的 Java 源文件。
• 预先定义的模板。

与其他基于模板的代码生成技术（例如 Velocity；请参阅 参考资料）相比，XDoclet 具有以下独特优势：

• XDoclet 与 Apache Ant（请参阅 参考资料）紧密集成，从而提供了高度自动化的操作。
  
  
• 把控制代码生成和模板处理的 XDoclet 标签作为内联注释嵌入到 Java 源代码文件中。这消除了同步多个相关文件和控制文件的需要。
  
  
• XDoclet 的内置 Java 解析器使用它对 Java 代码结构的深入理解，为输入的 Java 代码建立内部 结构模型。该结构模型又经常被叫作 元数据（metadata），因为它包含与关联代码有关的数据。
  
  
• XDoclet 的模板生成逻辑拥有对输入 Java 代码的内部结构模型的完全访问权。

接下来，我将进一步研究 XDoclet 是如何工作的，以帮助您理解这些特性。

XDoclet 操作

图 1 显示了 XDoclet 要求的输入和生成的输出。

您可以看到，包含嵌入式 XDoclet 标签的 Java 源代码是系统的输入。在 Apache Ant 的驱动下，XDoclet 处理输入的代码，生成的输出文本文件可以是 Java 源代码、HTML 页面、XML 文件等。为了处理输入，XDoclet 需要使用模板（保存在 .xdt 文件中）和标签处理器（用 Java 编码）。XDoclet 把模板和标签处理器打包成“模块”，不同的“模块”处理不同的问题域。

XDoclet 生成的结构模型

XDoclet 对包含嵌入式 XDoclet 标签的输入 Java 源代码进行解析，并为代码建立非常详细的结构模型。结构模型中的每个元素都代表源代码中的一个 Java 结构。图 2 显示的结构模型，揭示了 XDoclet 跟踪的代码构造和关系。

图 2 中的结构模型跟踪类、接口、方法之类的代码构造（模型元素）。该模型还跟踪元素之间的关系，例如继承和接口实现。以内联注释的形式嵌入在源代码中的 XDoclet 标签被解析为模型元素的属性，并被跟踪。

通用的 Javadoc 引擎 能够理解 Java 代码结构模型的智能代码生成引擎不是什么新概念。实际上，它是 JDK 自带的 Javadoc 工具的运作方式。通过解析带有特殊 Javadoc 标签的 Java 源文件，Javadoc 工具可以为所有 Java 程序的内置结构元素（包括类、接口、字段和方法）生成 HTML 文档。Javadoc 还具有特殊 Java 语言概念方面的知识，例如继承、抽象类、存储类和修饰符。 XDoclet 的诞生，来自这样一个观察：适用于任意代码生成的 Javadoc 的通用版本，在许多编程场合下会极为有用。但是，实际的 Javadoc 源代码不是为通用的代码生成设计的，而只是为了生成 HTML 文档。由于无法重用现有代码，XDoclet 开发小组从头开始重写了引擎，并显著优化了它的性能。

回页首

深入 XDoclet

图 3 显示了 XDoclet 的内部结构，揭示了使其运行的功能块。

package com.ibm.dw.beans;import java.io.Serializable;/**        * @dw.genStrutsAction action="/addAddress.do"* @hibernate.class table="ADDRESS"*/public class AddressBean implements Serializable {private String streetNumber = "";private String street = "";private String city = "";private String country = "";private String postalCode = "";private long id = 0;public AddressBean() {}/**        * @dw.genStruts formlabel="Street Number"* @hibernate.property length="10"*/public String getStreetNumber() {   return streetNumber;}public void setStreetNumber(String inpStreetNumber) {   streetNumber = inpStreetNumber;}/**        * @dw.genStruts formlabel="Street"* @hibernate.property  length="40"*/public String getStreet() {    return street;}public void setStreet(String inpStreet) {   street = inpStreet;}        ...... more Address bean properties ....../**        * @hibernate.id generator-class="native"*/public long getId(  ){        return id;}public void setId(long inId) {   id = inId;}}      

package         {package name of source class};import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;import org.apache.struts.action.ActionForm;import org.apache.struts.action.ActionMapping;import org.apache.struts.upload.FormFile;/** * Form Bean class for         {name of source class};. * * @struts.form name="        {name of source class}Form" */public class         {name of source class}Form extends ActionForm {        {loop through all the methods in the source class}   {if the method is a JavaBean "getter" method}      {if the method has been marked with the @dw.genStruts tag }	private         {return type of method}{name of the JavaBean property}; 	public         {return type of method}{name of the getter method for this property}(){		return         {name of JavaBean property};	}	public void         {name of the setter method for this property}(	                                    {return type of method} value) {                    {name of the JavaBean property} = value;      			}               {end of if @dw.genStruts}    {end of if JavaBean getter}{end of loop}

package         <XDtPackage:packageName/>;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;import org.apache.struts.action.ActionForm;import org.apache.struts.action.ActionMapping;import org.apache.struts.upload.FormFile;/** * Form Bean class for         <XDtClass:className/>. * * @struts.form name="        <XDtClass:className/>Form" */public class         <XDtClass:className/>Form extends ActionForm {        <XDtMethod:forAllMethods>   <XDtMethod:ifIsGetter>      <XDtMethod:ifHasMethodTag tagName="dw.genStruts">	private         <XDtMethod:methodType/> <XDtMethod:propertyName/>; 	public         <XDtMethod:methodType/> <XDtMethod:getterMethod/>(){		return         <XDtMethod:propertyName/>;	}	public void         <XDtMethod:setterMethod/>(        <XDtMethod:methodType/> value) {                    <XDtMethod:propertyName/> = value;      			}             </XDtMethod:ifHasMethodTag>   </XDtMethod:ifIsGetter></XDtMethod:forAllMethods>

ant -Dbase.class.java=Address genstruts

package         com.ibm.dw.beans;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;import org.apache.struts.action.ActionForm;import org.apache.struts.action.ActionMapping;import org.apache.struts.upload.FormFile;/** * Form Bean class for         AddressBean. * * @struts.form name="        AddressBeanForm" */public class         AddressBeanForm extends ActionForm {	private         java.lang.String streetNumber; 	public         java.lang.String getStreetNumber(){		return         streetNumber;	}	public void         setStreetNumber(        java.lang.String value) {                    streetNumber = value;      			}	private         java.lang.Stringstreet; 	public         java.lang.String getStreet(){		return         street;	}	public void         setStreet(        java.lang.String value) {                    street = value;      			}           ...... more bean properties .....}      

<%@ page language="java" %><%@ taglib  uri="/WEB-INF/struts-html.tld" prefix="html" %><html:html><head></head><body bgcolor="white"><html:errors/><html:form action="        <XDtClass:classTagValue tagName='dw.genStrutsAction'  paramName='action' /> >"<table border="0" width="100%">        <XDtMethod:forAllMethods>   <XDtMethod:ifIsGetter>      <XDtMethod:ifHasMethodTag tagName="dw.genStruts" >    <tr>        <th align="right">                   <XDtMethod:methodTagValue                    tagName="dw.genStruts" paramName="formlabel"/>        </th>        <td align="left">            <html:text  property="        <XDtMethod:propertyName/>"              size="        <XDtMethod:ifHasMethodTag tagName="hibernate.property" >              <XDtMethod:methodTagValue tagName="hibernate.property" paramName="length"/>              </XDtMethod:ifHasMethodTag>"/>        </td>    </tr>             </XDtMethod:ifHasMethodTag>   </XDtMethod:ifIsGetter></XDtMethod:forAllMethods>    <tr>        <td align="right">            <html:submit>                Submit            </html:submit>        </td>        <td align="left">            <html:reset>              Reset            </html:reset>        </td>    </tr></table></html:form></body></html:html>      

Sing Li 是 Professional Apache Tomcat 5、 Pro JSP, Third Edition、 Early Adopter JXTA、 Professional Jini，以及 Wrox Press 出版的许多其他图书的作者。他是技术杂志的定期撰稿人，还是 P2P 发展的热心传播者。Sing 是一名咨询顾问和资深作者，您可以通过他的电子邮件 westmakaha@yahoo.com与他联系。