發(fā)現(xiàn)多功能的模板驅(qū)動(dòng)的代碼生成器

文檔選項(xiàng) 將此頁(yè)作為電子郵件發(fā)送 最新推薦 Java 應(yīng)用開(kāi)發(fā)源動(dòng)力 － 下載免費(fèi)軟件，快速啟動(dòng)開(kāi)發(fā)

級(jí)別: 初級(jí)

Sing Li , 作者, Wrox Press

2004 年 11 月 05 日

開(kāi)放源代碼的 XDoclet 代碼生成引擎，是許多領(lǐng)先的 Java 框架不可缺少的組成部分，常常被用作面向?qū)傩缘木幊毯统掷m(xù)集成的引擎。但是 XDoclet 還有一些不太惹人注目的地方：對(duì)初級(jí)開(kāi)發(fā)人員來(lái)說(shuō)，它太難掌握、太難精通。在這篇文章中，流行作者 Sing Li 以 XDoclet 為對(duì)象，揭示了其內(nèi)部簡(jiǎn)單卻優(yōu)雅的設(shè)計(jì)，使您能夠理解這項(xiàng)技術(shù)，并將它應(yīng)用在實(shí)踐當(dāng)中。

XDoclet 能夠很容易成為您的 Java 編程工具箱中的一個(gè)更加通用的跨技術(shù)代碼生成工具。不幸的是，開(kāi)發(fā)人員經(jīng)常忽視 XDoclet 的一般用途，只有將它捆綁在大型開(kāi)發(fā)框架或者 IDE 中，作為其中的一個(gè)隱藏元素時(shí)，才會(huì)用到它。人們常常認(rèn)為很難將 XDoclet 應(yīng)用在定制解決方案上。這篇文章的目的就是要消除這個(gè)迷惑，把 XDoclet 從常見(jiàn)的復(fù)雜陷阱中解脫出來(lái)，并向您展示了如何能夠利用這個(gè)代碼生成引擎。

我會(huì)用一個(gè)實(shí)際的例子演示 XDoclet 的用途，該例子將接收一個(gè) POJO（plain old Java object），并用 XDoclet 生成完整 Web 應(yīng)用程序的全部文件，這些文件是把數(shù)據(jù)輸入關(guān)系數(shù)據(jù)庫(kù)所必需的。該示例使用了 XDoclet 的 自定義模板代碼生成功能，以及它對(duì) Hibernate 對(duì)象關(guān)系映射工具、Struct Web 應(yīng)用程序框架和應(yīng)用程序服務(wù)器的內(nèi)部支持。（請(qǐng)參閱 參考資料）。

智能代碼生成器

XDoclet 的核心功能是根據(jù)以下組合來(lái)生成代碼的（或者生成其他配置/數(shù)據(jù)文件）：

• 進(jìn)行特殊標(biāo)記的 Java 源文件。
• 預(yù)先定義的模板。

與其他基于模板的代碼生成技術(shù)（例如 Velocity；請(qǐng)參閱 參考資料）相比，XDoclet 具有以下獨(dú)特優(yōu)勢(shì)：

• XDoclet 與 Apache Ant（請(qǐng)參閱 參考資料）緊密集成，從而提供了高度自動(dòng)化的操作。
  
  
• 把控制代碼生成和模板處理的 XDoclet 標(biāo)簽作為內(nèi)聯(lián)注釋嵌入到 Java 源代碼文件中。這消除了同步多個(gè)相關(guān)文件和控制文件的需要。
  
  
• XDoclet 的內(nèi)置 Java 解析器使用它對(duì) Java 代碼結(jié)構(gòu)的深入理解，為輸入的 Java 代碼建立內(nèi)部 結(jié)構(gòu)模型。該結(jié)構(gòu)模型又經(jīng)常被叫作 元數(shù)據(jù)（metadata），因?yàn)樗c關(guān)聯(lián)代碼有關(guān)的數(shù)據(jù)。
  
  
• XDoclet 的模板生成邏輯擁有對(duì)輸入 Java 代碼的內(nèi)部結(jié)構(gòu)模型的完全訪問(wèn)權(quán)。

接下來(lái)，我將進(jìn)一步研究 XDoclet 是如何工作的，以幫助您理解這些特性。

XDoclet 操作

圖 1 顯示了 XDoclet 要求的輸入和生成的輸出。

您可以看到，包含嵌入式 XDoclet 標(biāo)簽的 Java 源代碼是系統(tǒng)的輸入。在 Apache Ant 的驅(qū)動(dòng)下，XDoclet 處理輸入的代碼，生成的輸出文本文件可以是 Java 源代碼、HTML 頁(yè)面、XML 文件等。為了處理輸入，XDoclet 需要使用模板（保存在 .xdt 文件中）和標(biāo)簽處理器（用 Java 編碼）。XDoclet 把模板和標(biāo)簽處理器打包成“模塊”，不同的“模塊”處理不同的問(wèn)題域。

XDoclet 生成的結(jié)構(gòu)模型

XDoclet 對(duì)包含嵌入式 XDoclet 標(biāo)簽的輸入 Java 源代碼進(jìn)行解析，并為代碼建立非常詳細(xì)的結(jié)構(gòu)模型。結(jié)構(gòu)模型中的每個(gè)元素都代表源代碼中的一個(gè) Java 結(jié)構(gòu)。圖 2 顯示的結(jié)構(gòu)模型，揭示了 XDoclet 跟蹤的代碼構(gòu)造和關(guān)系。

圖 2 中的結(jié)構(gòu)模型跟蹤類、接口、方法之類的代碼構(gòu)造（模型元素）。該模型還跟蹤元素之間的關(guān)系，例如繼承和接口實(shí)現(xiàn)。以內(nèi)聯(lián)注釋的形式嵌入在源代碼中的 XDoclet 標(biāo)簽被解析為模型元素的屬性，并被跟蹤。

通用的 Javadoc 引擎 能夠理解 Java 代碼結(jié)構(gòu)模型的智能代碼生成引擎不是什么新概念。實(shí)際上，它是 JDK 自帶的 Javadoc 工具的運(yùn)作方式。通過(guò)解析帶有特殊 Javadoc 標(biāo)簽的 Java 源文件，Javadoc 工具可以為所有 Java 程序的內(nèi)置結(jié)構(gòu)元素（包括類、接口、字段和方法）生成 HTML 文檔。Javadoc 還具有特殊 Java 語(yǔ)言概念方面的知識(shí)，例如繼承、抽象類、存儲(chǔ)類和修飾符。 XDoclet 的誕生，來(lái)自這樣一個(gè)觀察：適用于任意代碼生成的 Javadoc 的通用版本，在許多編程場(chǎng)合下會(huì)極為有用。但是，實(shí)際的 Javadoc 源代碼不是為通用的代碼生成設(shè)計(jì)的，而只是為了生成 HTML 文檔。由于無(wú)法重用現(xiàn)有代碼，XDoclet 開(kāi)發(fā)小組從頭開(kāi)始重寫(xiě)了引擎，并顯著優(yōu)化了它的性能。

回頁(yè)首

深入 XDoclet

圖 3 顯示了 XDoclet 的內(nèi)部結(jié)構(gòu)，揭示了使其運(yùn)行的功能塊。

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 出版的許多其他圖書(shū)的作者。他是技術(shù)雜志的定期撰稿人，還是 P2P 發(fā)展的熱心傳播者。Sing 是一名咨詢顧問(wèn)和資深作者，您可以通過(guò)他的電子郵件 westmakaha@yahoo.com與他聯(lián)系。