xDoclet介绍

1、http://baike.baidu.com/view/1623553.htm

2、http://blog.163.com/yangjuqi@126/blog/static/28452285200791192152923/

XDoclet是什么?

2007-10-11 09:21:52| 分类： IT技术 | 标签： |字号大中小订阅

 

 

XDoclet 是一个通用的代码生成实用程序,是一个扩展的Javadoc Doclet引擎，它允许您使用象 JavaDoc 标记之类的东西来向诸如类、方法和字段之类的语言特征添加元数据。随后，它利用这些额外的元数据来生成诸如部署描述符和源代码之类的相关文件。可以让你创建自己的javadoc @tags进而利用XDoclet中的Templet enging基于这些@tags生成源代码或其他文件（例如xml的deployment descriptors）。

XDoclet 继承了 JavaDoc 引擎的思想，允许根据定制 JavaDoc 标记生成代码和其他文件。当然，XDoclet 也可以访问整个解析树。这样，它就可以访问类、类的包结构和类的方法。

Xdoclet由三个主要组件组成、Xjavadoc引擎，Xdoclet引擎和模块。模块又由任务、子任务、标记处理程序和模板。

XJavaDoc 引擎：XJavaDoc 解析 Java 源文件，然后构建有关类和语言特征（包、方法和字段）以及元数据的信息树。XJavaDoc 引擎通过一个易于使用的 API 提供访问。该 API 提供了与带有一些额外特征的 JavaDoc API 相同的类信息，这些额外特征与存储及读取元数据以及其他结构相关联。XJavaDoc 增加了在运行时修改 JavaDoc 标记的能力。这样就可以推断元数据，并可以将其缺省值设为比较合理的值。

XDoclet 引擎：XJavaDoc 引擎读取标记，这些标记组成了类的元数据和结构。XDoclet 引擎使用来自 XJavaDoc 引擎的信息，来生成支持文件（源代码和部署描述符）。XDoclet 提供了一个优秀的模板生成引擎，该引擎将模板转换成一个或多个支持文件。XDoclet 有一个模块装入程序，它动态地装入用 xdoclet.xml 文件（包含在模块的 jar 文件中）指定的 XDoclet 模块。

您无需创建模块就可创建模板。每个顶级 XDoclet Ant 任务都有执行任意模板的能力，以此替换随模块一起提供的模板。

模块引擎：模块由任务、子任务、标记处理程序和模板组成。

 

目前的版本可以为web(web.xml)、ejb、struts(struts-config.xml)、webwork、hibernate

(mapping file)、jdo、jmx等等生成描述文件、源码等，XDoclet提供了ant的任务target支持，完全通过ant来完成任务。

我们只须在项目中引入xjavadoc-1.1.jar、xdoclet-hibernate-module-1.2.3.jar等等所需要的jar包就可以了。以下是我在项目中写的一些类。

例如 action 类

……

import org.apache.struts.action.ActionForward;

/**

*

* @author yangjuqi 2007-06-13

* @struts.action name="biddingForm" path="/carriageBidQuery" validate="false"

* @struts.action-forward name="success" path="ship.bid.carriage.search"

*/

public class CarriageBidQueryAction extends BaseAction {

 

protected ActionForward execute(BActionContext context) throws Exception {

 

System.out.println("------- CarriageBidQueryAction execute -----");

 

String markey=context.getRequest().getParameter("markey");

if(markey==null || markey.equals("0")){

return this.queryBiddingAll(context);

}

return null;

}

……

在struts-config.xml中生成如下代码：

<action path="/carriageBidQuery" type="com.baosight.baosteel.bli.lgs.bid.struts.action.CarriageBidQueryAction" name="biddingForm" scope="request" unknown="false"

validate="false" >

<forward name="success" path="ship.bid.carriage.search"

redirect="false"

/>

</action>

例如 model(与数据库中的表对应)类

……

/**

* @author yangjuqi 2007-07-18

*

* @hibernate.class table="LGS_INVITED_CARRIER"

*/

public class InvitedCarrierModel implements java.io.Serializable {

private Long id;

private String carrierCompanyCode;

private Long biddingId;

/**

* @hibernate.property column="BIDDING_ID" type="long"

*/

public Long getBiddingId() {

return biddingId;

}

public void setBiddingId(Long biddingId) {

this.biddingId = biddingId;

}

……

在指定的目录中生成文件InvitedCarrierModel.hbm.xml，代码如下：

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE hibernate-mapping PUBLIC

"-//Hibernate/Hibernate Mapping DTD 3.0//EN"

"http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">

<hibernate-mapping>

<class

name="com.baosight.baosteel.bli.lgs.model.InvitedCarrierModel"

table="LGS_INVITED_CARRIER"

>

……

<property

name="biddingId"

type="long"

update="true"

insert="true"

column="BIDDING_ID"

/>

……

</class>

</hibernate-mapping>

在Build.xml中的关于Xdoclet的配置如下：

<target name="generateHibernateConf" depends="init">

<taskdef name="hibernatedoclet" classname="xdoclet.modules.hibernate.HibernateDocletTask">

<classpath refid="classpath" />

</taskdef>

<hibernatedoclet destdir="${conf.hibernate}">

<fileset dir="${src}">

<include name="**/*.java" />

</fileset>

<hibernate version="3.0" />

</hibernatedoclet>

</target>

 

<target name="generateStrutsConf" depends="init">

<taskdef name="webdoclet" classname="xdoclet.modules.web.WebDocletTask">

<classpath refid="classpath" />

</taskdef>

<webdoclet destdir="${conf.struts}">

<fileset dir="${src}" includes="**/*.java" />

<strutsconfigxml version="1.2" destdir="${conf.struts}" mergeDir="${conf-merge.struts}" />

</webdoclet>

</target>

像@hibernate.clas、@hibernate.property、@struts.action-forward等等这些特定的注释标签需要去查XDoclet的相关文档了，Xdoclet对目前流行的多种框架、技术都提供了相关的支持。

这样，我们就能在使用ant编译工程的同时，使Xdoclet为我们生成相关的配置文件了。

转载于:https://www.cnblogs.com/ki-tom/p/3158048.html