ant的build.xml文件详解备忘

讲解Ant中常用的元素和任务

约定： "…"表示这里有很多代码，未列出

build_for_ejb_templet.xml任务的分为以下几大部分
i. 开始
ii. 初始化
iii. 定义classpath
iv. 为编译作准备
v. 编译EJB部分
vi. 编译WEB部分
vii. 编译J2EE Application
viii. 部署Application
ix. 创建组件的API
x. 确定build的目标

build_for_ejb_templet.xml的讲解

开始

讲解：encoding="UTF-8"表示XML文件采用UTF-8编码格式，如果要使用GBK编码，需定义为encodeing="GBK"。

  
讲解：此部分为文件内容的简介，包括文件名称、创建日期、最后修改日期、创建文件的作者、版权。
componentName 表示 文件名称
yyyy-m-dd 表示 创建日期、最后修改日期的格式，如2002-5-1
developerName 表示 创建文件的作者
CompanyName 表示 公司名称或URL


…

讲解：此部分定义了一个名称为componentName的项目元素，缺省的任务为"core"任务，根目录为当前目录。componentName表示组件的名称，这里指EJB的名称。



初始化

…

讲解：此部分用于初始化所有的变量


讲解：导入项目根目录下build.properties中的全局变量，开发人员也可以在此文件中重新定义全局变量。

  
  
  
…
  
…
  
  

讲解：定义和Jboss Application Server有关的变量，包括lib目录、client目录、
deploy目录和J2EE Application部署要用到的一些变量。

  
讲解：定义组件的名称

  
讲解：定义源代码目录路径

  
讲解：定义资源目录路径

  
讲解：定义库目录路径

  
讲解：定义build目录路径


讲解：定义源代码的主目录路径

  
讲解：定义存放EJB的源代码目录路径


讲解：定义存放JavaBean的源代码目录路径


讲解：定义存放Servlet的源代码目录路径

  
讲解：定义存放WEB部分文件（包括JSP程序、HTML文件、图片、CSS文件、JS脚本等）的目录路径


讲解：定义存放组件API的开发文件目录路径

  
讲解：定义存放EJB的编译代码目录路径

  
讲解：定义存放JavaBean的编译代码目录路径


讲解：定义WEB目录的类目录路径

  
讲解：定义WEB目录的库目录名称

  
讲解：定义压缩文档的名称

  
讲解：定义项目的组件目录路径


讲解：这段为注释，说明以下是定义当前组件的变量


讲解：定义当前组件的名称


讲解：定义当前组件的目录路径

value="${ProjectName.componentName.home}/lib/ejb"/>
讲解：定义当前组件的EJB编译目录路径
value="${ProjectName.componentName.home}/build/componentName-ejb.jar"/>
讲解：定义当前组件内的EJB包的路径

value="${ProjectName.componentName.home}/build/componentName-ejb-client.jar"/>
讲解：定义当前组件内的EJB客户端包的路径


讲解：这段为注释，说明以下是定义引入其它组件的变量

value="referencesComponentName"/>
讲解：定义指定组件的名称

value="${ProjectName.components.home}/referencesComponentName"/>
讲解：定义指定组件的目录路径

value="${ProjectName.referencesComponentName.home}/lib/ejb"/>
讲解：定义指定组件的EJB编译目录路径

value="${ProjectName.referencesComponentName.home}
/build/referencesComponentName-ejb.jar"/>
讲解：定义指定组件内的EJB包的路径

value="${ProjectName.referencesComponentName.home}
/build/referencesComponentName-ejb-client.jar"/>
讲解：定义指定组件内的EJB客户端包的路径

value="${jboss.client}/jboss-j2ee.jar:${jboss.client}
/jnp-client.jar:${jboss.client}/jnp-client.jar:${jboss.client}
/jbossmq-client.jar:${jboss.client}/jbosssx-client.jar:${jboss.client}
/concurrent.jar:${jboss.client}/jaas.jar:${jboss.lib}
/jboss-jmx.jar:${jboss.home}/server/${jboss.configuration}
/lib/jbosssx.jar:${jboss.home}/server/${jboss.configuration}
/lib/mail.jar:${servlet-lib.path}:${ejb-classes.dest}:
${web-classes.dest}:${ProjectName.componentName.classbindir}:
${ProjectName.componentName.ejbjar.client}:
${ProjectName.referencesComponentName.classbindir}:
${ProjectName.referencesComponentName.ejbjar.client}" />
讲解：定义classpath，编译bean时要用到。这是定义classpath的一种方法，下面还有另一种方法。

定义classpath
  
  
     
     
         
         
         
         
      
         
         
       location="${jboss.home}/server/${jboss.configuration}/lib/jbosssx.jar" />  
       location="${jboss.home}/server/${jboss.configuration}/lib/mail.jar" />  
  
讲解：此段定义应用服务器中包文件，如支持ejb的jboss-j2ee.jar、支持客户端程序的jnp-client.jar、jbossmq-client.jar、jbosssx-client.jar、支持JavaMail的mail.jar等。

     
      
      
      
       location="${ProjectName.referencesComponentName.classbindir}"/>
      
     
讲解：此段定义项目中要用到的包文件。

  
        
        
        
  
讲解：此段定义在编译servlet时的classpath，${ servlet-lib.path }是系统指定的Servlet引擎包。

为编译作准备工作
  
     
     
     
         
         
  
讲解：清除build、lib目录下的所有文件和目录。

     
     
     
     
         
         
         
         
         
         
         
         
         
      
         
     
讲解：创建build中要用到的所有目录，根据需要可以加入自定义的目录如：
      

编译EJB部分
  
     
     
     
                    destdir="${ejb-classes.dest}"  
             includes="com/**"  
             classpathref="base.path" />
     
讲解：此小段用来完成编译ejb和其它help classes。根据需要可以加入一个非常有用的元素：
             encoding="${javac.encoding}"

     
                    tofile="${lib.dir}/ejb/META-INF/ejb-jar.xml" />  
                    tofile="${lib.dir}/ejb/META-INF/jaws.xml" />  
                    tofile="${lib.dir}/ejb/META-INF/jboss.xml" />  
                    tofile="${lib.dir}/ejb/META-INF/jbosscmp-jdbc.xml" />  
  
讲解：此小段用来拷贝EJB部署文件，在JAS中EJB部署文件有jaws.xml、jboss.xml、jbosscmp-jdbc.xml。

     
                  basedir="${lib.dir}/ejb" />  
     
讲解：此小段用来把class和部署文件压缩成包文件，这个包文件就是一个EJB组件。

  
       file="${ProjectName.referencesComponentName.home}/build/
${ProjectName.referencesComponentName.name}-ejb-client.jar"  
           tofile="${build.dir}/${ProjectName.referencesComponentName.name}
           -ejb-client.jar" />  
                  basedir="${lib.dir}/ejb"
           excludes="com/ProjectName/componentName/ejb/ComponentNameEJB.class" />  
  
讲解：此小段用来把class和部署文件压缩成包文件，以支持客户端运行。

编译WEB部分
  
     
     
     
                    destdir="${lib.dir}/web/WEB-INF/classes"  
             includes="com/**"  
             classpath="${build.classpath}" />  
     
讲解：此小段用来完成编译servlet。

  
                    tofile="${lib.dir}/web/WEB-INF/jboss-web.xml" />  
                    tofile="${lib.dir}/web/WEB-INF/web.xml" />  
  
讲解：此小段用来拷贝WEB部署文件，在JAS中WEB部署文件有jboss-web.xml。

     
      
      
      
       file="${build.dir}/${ProjectName.referencesComponentName.name}-ejb-client.jar"  
tofile="${lib.dir}/web/WEB-INF/lib/${ProjectName.referencesComponentName.name}
-ejb-client.jar" />    
                basedir="${lib.dir}/web" />  
  
讲解：此小段用来把所有的JSP程序、Html、Css、图片和部署文件等压缩成WAR文件。

编译J2EE Application
  
     
     
     
                    tofile="${lib.dir}/j2ee/META-INF/application.xml" />  
     
讲解：此小段用来拷贝Application的部署文件。

     
                    tofile="${lib.dir}/j2ee/${name}-ejb.jar" />  
                    tofile="${lib.dir}/j2ee/${name}-web.war" />  
                  basedir="${lib.dir}/j2ee" />  
     
讲解：此小段用来把EJB组件、支持客户端运行的包和部署文件压缩成EAR文件，它就是一个J2EE Application。这里要说明，在进行build时，根据需要可以不生成EAR文件。

部署Application

  
  
     
         
           
           
         
     
讲解：此小段用来部署Application，在JAS3.0中${jboss.deploy}是JAS的热部署目录。

创建组件的API

  
  
  
                  destdir="${javadoc.dir}"  
             classpath="${build.classpath}"
             encoding="${javadoc.encoding}"
             author="${javadoc.author}"
version="${javadoc.version}"
use="${javadoc.usage}"  
             windowtitle="${project.name} ${name} Component API"
             doctitle="${project.name} ${name} Component"  
             bottom="Copyright ${sign.copyright} ${project.date}
${company.signature}. All Rights Reserved.">  

           
      
      
        
      
    
  
讲解：此小段用来创建组件的API。这里强烈要求类设计人员和编码人员按照Javadoc定义的标签对源代码进行注释。



确定build的目标

       +---------------------------------------+
       +     Building ${name} Component         +
       +---------------------------------------+
  
  
       +---------------------------------------+
       +     Finished ${name} Component         +
       +---------------------------------------+
  
  
  
  
  
  
  
  
讲解：此小段用来确定build的目标。缺省目录为core，所以在build不加参数时，系统将只生成jar文件和war文件。如果 build时加上参数，系统将根据需要来生成文件，例如：在命令行输入ant deploy，系统将生成jar文件、war文件、ear文件，同时将ear文件进行部署。