使用XDoclet生成代码

   转EasyJF团队stef_wu的一篇文章!
在最近的一个项目中,使用了hibernate+struts,由于中间没有使用spring来管理bean,所以我使用了DAO+Service来做持久层和业务层。受spring对hibernate的template的封装的影响,我自己实现了一个简单的hibernateTemplate——MHibernateTemplate和调用接口MHibernateCallback。在其中包装了错误拦截等动作。所以我的DAO就不能直接从Myecipse生成了。但由于Domain bean太多,而且DAO中又是简单的代码重复,所以想到了使用代码生成。刚开始想直接在Myeclipse中生成DAO的时候使用自己的模版就可以了,但是在网上找了半天都没有相关的信息。后来模仿easyjtools使用velocity自己做代码生成,但感觉时间不够,所以,就选择了XDoclet。
       网上相关的内容不是很多,所以就只有啃En版的XDoclet in Action。由于我的需求很简单,所以只使用了简单的template(就是.xdt)来生成代码,搞了两天,效果还不错。
       比如一个model:(这个项目的需求比较奇怪,由于要同步,所以每个对象都必须有一个pkid(包括中间表),2就是每个对象有个dr标志,表示删除(而不是真正的删除))。
       package com.my.xdoclet;
/**
  * PubCompproper generated by MyEclipse - Hibernate Tools
  * @hasRef
  * 公司性质
  */
 
public class PubCompproper extends BaseDomain implements java.io.Serializable {
 
    // Fields
    /**
      * @pkid
      */
    private String cproPkid ;
    // 系统类型信息
    /**
      * @ref .model name="sytp"
      */
    private PubSystype sytp ;
    // 公司性质编码
    private String cproCode ;
    // 公司性质名称
    private String cproName ;
    // 删除表示
    /**
      * @del
      */
    private String cproDr ;
    // Constructors
 
    /** default constructor */
    public PubCompproper() {
       this .setCproDr( "0" );
    }
 
    // Property accessors
 
    public String getCproPkid() {
       return this . cproPkid ;
    }
 
    public void setCproPkid(String cproPkid ) {
       this . cproPkid = cproPkid ;
    }
 
    public String getCproCode() {
       return this . cproCode ;
    }
 
    public void setCproCode(String cproCode ) {
       this . cproCode = cproCode ;
    }
 
    public String getCproName() {
       return this . cproName ;
    }
 
    public void setCproName(String cproName ) {
       this . cproName = cproName ;
    }
 
    /**
      * @return the sytp
      */
    public PubSystype getSytp() {
       return sytp ;
    }
 
    /**
      * @param sytp the sytp to set
      */
    public void setSytp(PubSystype sytp ) {
       this . sytp = sytp ;
    }
 
    /**
      * @return the cproDr
      */
    public String getCproDr() {
       return cproDr ;
    }
 
    /**
      * @param cproDr the cproDr to set
      */
    public void setCproDr(String cproDr ) {
       this . cproDr = cproDr ;
    }
}
 
其中有一些相关的对象,在 DAO 中要使用到。
看看模版文件
package com.hycs.bs.client.itf;
 
import java.util.List;
 
import <XDtPackage:packageName />.<XDtClass:className />;
 
public interface <XDtClass:className />DAO {
    // 添加
    boolean add(<XDtClass:className /> instance);
   
    <XDtClass:ifHasClassTag tagName="hasRef">
    // 添加
    boolean add(<XDtClass:className /> instance,<XDtField:forAllFields><XDtField:ifHasFieldTag tagName="ref.model" paramName="name"> String <XDtField:fieldTagValue tagName="ref.model" paramName="name" />pkid</XDtField:ifHasFieldTag></XDtField:forAllFields>);  
    </XDtClass:ifHasClassTag>
   
    // 删除
    boolean del(String pkid);
   
    // 更新
    boolean update(<XDtClass:className /> instance);
   
    // 列出所有
    List list();
   
    List list(boolean withDr);
   
    // 得到一个对象
    <XDtClass:className /> get(String pkid);
}
这个是 interface 的模版,其中的模版标签都很简单易懂;
<XDtTagDef:tagDef namespace="Primitive" handler="com.my.xdoclet.customTags.UpperName" />
 
package com.hycs.bs.client.call;
 
import com.hycs.bs.sys.MHibernateTemplate;
import com.hycs.util.Constant;
import com.hycs.util.OidHelper;
import com.hycs.bs.sys.HibernateCodeUtil;
import com.hycs.bs.sys.HibernateUtil;
 
public class <XDtClass:className/>DAOImpl implements <XDtClass:className/>DAO{
    private MHibernateTemplate template;
    <XDtField:forAllFields>
       <XDtField:ifHasFieldTag tagName="ref.model" paramName="name">
           private final <XDtField:fieldType/>DAO <XDtField:fieldTagValue tagName="ref.model" paramName="name"/>dao = new <XDtField:fieldType/>DAOImpl();
       </XDtField:ifHasFieldTag>
    </XDtField:forAllFields>
   
    public <XDtClass:className/>DAOImpl(){
       this.template=new MHibernateTemplate(HibernateUtil.getSessionFactory());
    }
   
    public boolean add(<XDtClass:className/> instance) {
       // TODO Auto-generated method stub
       // add your code and pkid generhere;
       //instance.setCproCode(HibernateCodeUtil.getLastCode("PubCompproper", "cproCode", "cproPkid"));
       //instance.setCproPkid(OidHelper.oidSingle());
      
       return this.template.save(instance);
    }
   
    <XDtClass:ifHasClassTag tagName="hasRef">
    public boolean add(<XDtClass:className/> instance, <XDtField:forAllFields><XDtField:ifHasFieldTag tagName="ref.model" paramName="name"> String <XDtField:fieldTagValue tagName="ref.model" paramName="name" />pkid</XDtField:ifHasFieldTag></XDtField:forAllFields>) {
       // TODO Auto-generated method stub
       <XDtField:forAllFields>
           <XDtField:ifHasFieldTag tagName="ref.model" paramName="name">
              <XDtField:fieldType/> <XDtField:fieldTagValue tagName="ref.model" paramName="name" />=this.<XDtField:fieldTagValue tagName="ref.model" paramName="name"/>dao.get(<XDtField:fieldTagValue tagName="ref.model" paramName="name" />pkid);
              if(<XDtField:fieldTagValue tagName="ref.model" paramName="name" />==null){
                  return false;
              }
              instance.set<XDtPrimitive:upperName value='<XDtField:fieldTagValue tagName="ref.model" paramName="name" />' />(<XDtField:fieldTagValue tagName="ref.model" paramName="name" />);
           </XDtField:ifHasFieldTag>
       </XDtField:forAllFields>
       return this.add(instance);
    }
    </XDtClass:ifHasClassTag>
   
    public boolean del(String pkid) {
       // TODO Auto-generated method stub
       <XDtClass:className /> instance =this.get(pkid);
       if(instance==null||instance.get<XDtField:forAllFields><XDtField:ifHasFieldTag tagName="pkid" ><XDtPrimitive:upperName value="<XDtField:fieldName />" /></XDtField:ifHasFieldTag></XDtField:forAllFields>==null){
           return false;
       }
       instance.set<XDtField:forAllFields><XDtField:ifHasFieldTag tagName="del" ><XDtPrimitive:upperName value="<XDtField:fieldName />" /></XDtField:ifHasFieldTag></XDtField:forAllFields>(Constant.MODEL_DEL);
       return this.template.update(instance);
    }
   
    public <XDtClass:className /> get(String pkid) {
       // TODO Auto-generated method stub
       return (<XDtClass:className />)this.template.get(<XDtClass:className />.class, pkid);
    }
   
    public List list() {
       // TODO Auto-generated method stub
       return this.list(true);
    }
   
    public List list(boolean withDr) {
       // TODO Auto-generated method stub
       if(withDr){
           return HibernateCodeUtil.listWithDr("<XDtClass:className />","<XDtField:forAllFields><XDtField:ifHasFieldTag tagName="del"><XDtField:fieldName /></XDtField:ifHasFieldTag></XDtField:forAllFields>" );
       }else{
           return this.template.getAll(<XDtClass:className />.class);
       }
    }
   
    public boolean update(<XDtClass:className /> instance) {
       // TODO Auto-generated method stub
       <XDtClass:ifHasClassTag tagName="hasRef">
       <XDtClass:className /> temp=this.get(instance.get<XDtField:forAllFields><XDtField:ifHasFieldTag tagName="pkid" ><XDtPrimitive:upperName value="<XDtField:fieldName />" /></XDtField:ifHasFieldTag></XDtField:forAllFields>());
       <XDtField:forAllFields>
           <XDtField:ifHasFieldTag tagName="ref.model" paramName="name">        
              if(instance.get<XDtPrimitive:upperName value='<XDtField:fieldTagValue tagName="ref.model" paramName="name" />' />()==null){                
                  instance.set<XDtPrimitive:upperName value='<XDtField:fieldTagValue tagName="ref.model" paramName="name" />' />(temp.get<XDtPrimitive:upperName value='<XDtField:fieldTagValue tagName="ref.model" paramName="name" />' />());
              }
           </XDtField:ifHasFieldTag>
       </XDtField:forAllFields>
      
       </XDtClass:ifHasClassTag>
       return this.template.update(instance);
    }
}
这是个比较复杂的模版了,是 DAO 的具体实现,
在写这个模版的时候,我遇到了几个问题,
1 就是标签的嵌套,比如 <XDtPrimitive:upperName value='<XDtField:fieldTagValue tagName="ref.model" paramName="name" />' /> ,开始内部标签都使用转义符,结果搞不定,网上找没有任何相关的内容,后来直接在外层使用 (就象 js ),搞定。
2 就是对于标签的内容的首字符大写,没有提供这个功能的标签,使用了自定义的:
package com.my.xdoclet.customTags;
 
import java.util.Properties;
 
import xdoclet.XDocletTagSupport;
 
public class UpperName extends XDocletTagSupport {
    public String upperName(Properties attribute){
       String value=attribute.getProperty("value");
       String upper= upper(value);
       return upper;
    }
   
    private static String upper(String value){
       return value.toUpperCase().substring(0,1)+value.substring(1);
    }
}
并在模版文件中使用 <XDtTagDef:tagDef namespace="Primitive" handler="com.my.xdoclet.customTags.UpperName" /> 来应用就直接能在模版文件中使用 <XDtPrimitive:upperName > 来使用了,
下面是 bulid.xml 文件:
<?xml version="1.0" encoding="UTF-8"?>
 
<project name= "xdocletExample" default= "doall" basedir= "." >
    <property name= "xdoclet.lib.dir" location= "${basedir}/lib" />
    <property name= "gen.src.dir" location= "${basedir}/target" />
    <property name= "src.dir" location= "${basedir}/src" />
    <property name= "template.dir" location= "${basedir}/template" />
    <property name= "customtag.dir" location= "${basedir}/bin" />
 
    <path id= "xdoclet.lib.path" >
       <fileset dir= "${xdoclet.lib.dir}" includes= "*.jar" />
    </path>
 
    <taskdef name= "xdoclet" classname= "xdoclet.DocletTask" classpathref= "xdoclet.lib.path" />    
   
    <target name= "init" />
 
    <target name= "daogener" depends= "init" >
       <xdoclet destdir= "${gen.src.dir}" >
           <fileset dir= "${src.dir}" includes= "**/*.java" />
           <template templateFile= "${template.dir}/daointerface.xdt" acceptInterfaces= "false" acceptAbstractClasses= "false" destinationfile= "{0}DAO.java" />
       </xdoclet>
    </target>
 
    <target name= "daoimplgener" depends= "init" >
       <xdoclet destdir= "${gen.src.dir}" >
           <fileset dir= "${src.dir}" includes= "**/*.java" />
           <template templateFile= "${template.dir}/daoimpl.xdt" acceptInterfaces= "false" acceptAbstractClasses= "false" destinationfile= "{0}DAOImpl.java" />
       </xdoclet>
    </target>
 
    <target name= "doall" depends= "daogener,daoimplgener" />
</project>
 
build 一下:
生成的代码如下:
package com.hycs.bs.client.itf;
 
import java.util.List;
 
import com.my.xdoclet.PubCompproper;
 
public interface PubCompproperDAO {
    // 添加
    boolean add(PubCompproper instance);
    // 添加
    boolean add(PubCompproper instance, String sytppkid);  
    // 删除
    boolean del(String pkid);
    // 更新
    boolean update(PubCompproper instance);
    // 列出所有
    List list();
    List list(boolean withDr);
    // 得到一个对象
    PubCompproper get(String pkid);
}
这个是接口
 
package com.hycs.bs.client.call;
 
import com.hycs.bs.sys.MHibernateTemplate;
import com.hycs.util.Constant;
import com.hycs.util.OidHelper;
import com.hycs.bs.sys.HibernateCodeUtil;
import com.hycs.bs.sys.HibernateUtil;
 
public class PubCompproperDAOImpl implements PubCompproperDAO{
    private MHibernateTemplate template;
           private final com.my.xdoclet.PubSystypeDAO sytpdao = new com.my.xdoclet.PubSystypeDAOImpl();
    public PubCompproperDAOImpl(){
       this.template=new MHibernateTemplate(HibernateUtil.getSessionFactory());
    }
    public boolean add(PubCompproper instance) {
       // TODO Auto-generated method stub
       // add your code and pkid generhere;
       //instance.setCproCode(HibernateCodeUtil.getLastCode("PubCompproper", "cproCode", "cproPkid"));
       //instance.setCproPkid(OidHelper.oidSingle());
       return this.template.save(instance);
    }
    public boolean add(PubCompproper instance, String sytppkid) {
       // TODO Auto-generated method stub
              com.my.xdoclet.PubSystype sytp=this.sytpdao.get(sytppkid);
              if(sytp==null){
                  return false;
              }
              instance.setSytp(sytp);
       return this.add(instance);
    }
    public boolean del(String pkid) {
       // TODO Auto-generated method stub
       PubCompproper instance =this.get(pkid);
       if(instance==null||instance.getCproPkid==null){
           return false;
       }
       instance.setCproDr(Constant.MODEL_DEL);
       return this.template.update(instance);
    }
    public PubCompproper get(String pkid) {
       // TODO Auto-generated method stub
       return (PubCompproper)this.template.get(PubCompproper.class, pkid);
    }
    public List list() {
       // TODO Auto-generated method stub
       return this.list(true);
    }
    public List list(boolean withDr) {
       // TODO Auto-generated method stub
       if(withDr){
           return HibernateCodeUtil.listWithDr("PubCompproper","cproDr" );
       }else{
           return this.template.getAll(PubCompproper.class);
       }
    }
    public boolean update(PubCompproper instance) {
       // TODO Auto-generated method stub
       PubCompproper temp=this.get(instance.getCproPkid());
              if(instance.getSytp()==null){                
                  instance.setSytp(temp.getSytp());
              }
       return this.template.update(instance);
    }
}
这个是代码。
于是我的工作就很简单了,适用 Myeclipse 直接从 DataExplor 中生成 Domain bean 和映射文件,改一下关联,在 domain 中添加必要的 XDoclet 标记, build ,就可以专著于具体的业务了。
但这个代码还有点问题就是当遇到一个类有多个关联对象的时候,在生成的一些方法上,要自己手动增加或者删除一个 ”,” 。这个还要继续学习。
同时 XDoclet 提供了很好的扩展机制,这个也要继续研究。
再次就是我在想 XDoclet 中有没有直接使用标签来定义标签的功能,或者在模版内定义变量??
easyjweb 使用 XDoclet 来生成代码也会是很简单而且稳定的。

 (注:本文作者,EasyJF开源团队 stef_wu,转载请保留作者声明!)

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为我们生成相关的配置文件了。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值