Ant之build.xml(二)

简介: Ant之build.xml(二)

以build_for_ejb_templet.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的讲解开始

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

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

<!--  
   Build file for 'componentName'  
   Creation date : $Date: yyyy-m-d $  
   Updated date : $Date: yyyy-m-d $  
   Author:   developerName
   Copyright 2002 CompanyName, Inc. All rights reserved.  
-->

讲解:此部分为文件内容的简介,包括文件名称、创建日期、最后修改日期、创建文件的作者、版权。

componentName 表示 文件名称

yyyy-m-dd 表示 创建日期、最后修改日期的格式,如2002-5-1

developerName 表示 创建文件的作者

CompanyName 表示 公司名称或URL

<project name="componentName" default="core" basedir=".">
</project>

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


初始化

<target name="init">
</target>

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

<property file="../../build.properties" />

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

<property name="jboss.lib" value="${jboss.home}/lib" />  
<property name="jboss.client" value="${jboss.home}/client" />  
<property name="jboss.deploy" value="${jboss.home}/server/${jboss.configuration}/deploy" />  
<property name="jboss.dir"       value="${jboss.home}" />  
<property name="deploy.ormi"     value=""/>  
<property name="deploy.username" value=""/>  
<property name="deploy.password" value=""/>

讲解:定义和Jboss Application Server有关的变量,包括lib目录、client目录、

deploy目录和J2EE Application部署要用到的一些变量。

<property name="name"   value="componentName"/>

讲解:定义组件的名称


<property name="src.dir" value="${basedir}/src"/>

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


<property name="etc.dir" value="${basedir}/etc"/>

讲解:定义资源目录路径


<property name="lib.dir" value="${basedir}/lib"/>

讲解:定义库目录路径


<property name="build.dir" value="${basedir}/build"/>

讲解:定义build目录路径


<property name="src.main.dir" value="${src.dir}/main"/>

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


<property name="src.ejb.dir" value="${src.main.dir}/ejb"/>

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


<property name="src.javabean.dir" value="${src.main.dir}/javabean"/>

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


<property name="src.servlet.dir" value="${src.main.dir}/servlet"/>

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


<property name="src.web.dir" value="${src.main.dir}/web"/>

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


<property name="javadoc.dir" value="${lib.dir}/docs/api"/>

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


<property name="ejb-classes.dest" value="${lib.dir}/ejb"/>

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


<property name="javabean-classes.dest" value="${lib.dir}/javabean"/>

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


<property name="web-classes.dest" value="${lib.dir}/web/WEB-INF/classes" />

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


<property name="web-lib.dest" value="${lib.dir}/web/WEB-INF/lib" />

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


<property name="pkg-dist.name" value="${name}-pkg"/>

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


<property name="ProjectName.components.home" value="../../components" />

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


<!-- Define componentName Component -->

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


<property name="ProjectName.componentName.name" value="componentName"/>

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


<property name="ProjectName.componentName.home" value="${ProjectName.components.home}/componentName"/>

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


<property name="ProjectName.componentName.classbindir" value="${ProjectName.componentName.home}/lib/ejb"/>

讲解:定义当前组件的EJB编译目录路径


<property name="ProjectName.componentName.ejbjar" value="${ProjectName.componentName.home}/build/componentName-ejb.jar"/>

讲解:定义当前组件内的EJB包的路径


<property name="ProjectName.componentName.ejbjar.client" value="${ProjectName.componentName.home}/build/componentName-ejb-client.jar"/>

讲解:定义当前组件内的EJB客户端包的路径


<!-- Define referencesComponentName Component -->

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


<property name="ProjectName.referencesComponentName.name" value="referencesComponentName"/>

讲解:定义指定组件的名称


<property name="ProjectName.referencesComponentName.home" value="${ProjectName.components.home}/referencesComponentName"/>

讲解:定义指定组件的目录路径


<property name="ProjectName.referencesComponentName.classbindir" value="${ProjectName.referencesComponentName.home}/lib/ejb"/>

讲解:定义指定组件的EJB编译目录路径


<property name="ProjectName.referencesComponentName.ejbjar" value="${ProjectName.referencesComponentName.home}/build/referencesComponentName-ejb.jar"/>

讲解:定义指定组件内的EJB包的路径


<property name="ProjectName.referencesComponentName.ejbjar.client" value="${ProjectName.referencesComponentName.home}/build/referencesComponentName-ejb-client.jar"/>

讲解:定义指定组件内的EJB客户端包的路径


<property name="build.classpath" 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

<!-- ================================================================== -->  
   <!-- Define the classpath for compile the component                     -->
   <!-- ================================================================== -->  
   <path id="base.path">  
       <pathelement location="${jboss.client}/jboss-j2ee.jar" />  
       <pathelement location="${jboss.client}/jnp-client.jar" />  
       <pathelement location="${jboss.client}/jbossmq-client.jar" />  
       <pathelement location="${jboss.client}/jbosssx-client.jar" />  
       <pathelement location="${jboss.client}/concurrent.jar" /> 
       <pathelement location="${jboss.client}/jaas.jar" />  
       <pathelement location="${jboss.lib}/jboss-jmx.jar" />  
       <pathelement 
location="${jboss.home}/server/${jboss.configuration}/lib/jbosssx.jar" />  
       <pathelement 
location="${jboss.home}/server/${jboss.configuration}/lib/mail.jar" />  
</path>

讲解:此段定义应用服务器中包文件,如支持ejb的jboss-j2ee.jar、支持客户端程序的jnp-client.jar、jbossmq-client.jar、jbosssx-client.jar、支持JavaMail的mail.jar等。


 

<path id="project.path">  
       <path refid="base.path"/>
       <pathelement location="${ProjectName.componentName.classbindir}"/>
       <pathelement location="${ProjectName.componentName.ejbjar.client}"/>
       <pathelement
location="${ProjectName.referencesComponentName.classbindir}"/>
       <pathelement location="${ProjectName.referencesComponentName.ejbjar.client}"/>
   </path>

讲解:此段定义项目中要用到的包文件。


 

<path id="web.path">
         <path refid="project.path"/>
         <pathelement location="${servlet-lib.path}"/>
         <pathelement location="${ejb-classes.dest}"/>
   </path>

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


为编译作准备工作

<!--=============================================================== -->  
   <!-- Removes all created files and directories                       -->  
   <!-- ============================================================== -->  
   <target name="clean" depends="init">  
       <delete dir="${lib.dir}" />  
       <delete dir="${build.dir}" />  
   </target>

讲解:清除build、lib目录下的所有文件和目录。


 

<!-- ================================================================ -->  
   <!-- Makes sure the needed directory structure is in place               -->  
   <!-- ================================================================ -->  
   <target name="prepare" depends="init,clean">  
       <mkdir dir="${lib.dir}" />  
       <mkdir dir="${lib.dir}/ejb" />  
       <mkdir dir="${lib.dir}/ejb/META-INF" />  
       <mkdir dir="${lib.dir}/web" />  
       <mkdir dir="${lib.dir}/web/WEB-INF" />  
       <mkdir dir="${lib.dir}/web/WEB-INF/classes" />  
       <mkdir dir="${lib.dir}/web/WEB-INF/lib" />  
       <mkdir dir="${lib.dir}/j2ee" />  
       <mkdir dir="${lib.dir}/META-INF" />  
       <mkdir dir="${lib.dir}/docs/api" />
       <mkdir dir="${build.dir}" />  
   </target>

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

      <mkdir dir="${lib.dir}/javabean/ " />


编译EJB部分

<!-- ================================================================ -->  
   <!-- Compilation of the EJB part of the application                     -->  
   <!-- ================================================================ -->  
   <target name="ejb-classes" depends="prepare">  
       <javac srcdir="${src.ejb.dir}"  
             destdir="${ejb-classes.dest}"  
             includes="com/**"  
             classpathref="base.path" />
   </target>

讲解:此小段用来完成编译ejb和其它help classes。根据需要可以加入一个非常有用的元素:

         

encoding="${javac.encoding}"
   <target name="ejb-meta-inf" depends="prepare">  
       <copy file="${etc.dir}/ejb-jar.xml"  
             tofile="${lib.dir}/ejb/META-INF/ejb-jar.xml" />  
       <copy file="${etc.dir}/jaws.xml"  
             tofile="${lib.dir}/ejb/META-INF/jaws.xml" />  
       <copy file="${etc.dir}/jboss.xml"  
             tofile="${lib.dir}/ejb/META-INF/jboss.xml" />  
       <copy file="${etc.dir}/jbosscmp-jdbc.xml"  
             tofile="${lib.dir}/ejb/META-INF/jbosscmp-jdbc.xml" />  
   </target>

讲解:此小段用来拷贝EJB部署文件,在JAS中EJB部署文件有jaws.xml、jboss.xml、jbosscmp-jdbc.xml。


 

<target name="ejb-jar" depends="ejb-classes,ejb-meta-inf">  
       <jar jarfile="${build.dir}/${name}-ejb.jar"  
           basedir="${lib.dir}/ejb" />  
   </target>  
讲解:此小段用来把class和部署文件压缩成包文件,这个包文件就是一个EJB组件。
   <target name="ejbclientjar" depends="ejb-jar,web-classes">
       <copy file="${ProjectName.referencesComponentName.home}/build/${ProjectName.referencesComponentName.name}-ejb-client.jar" tofile="${build.dir}/${ProjectName.referencesComponentName.name}
           -ejb-client.jar" />  
       <jar jarfile="${build.dir}/${name}-ejb-client.jar"  
           basedir="${lib.dir}/ejb"
           excludes="com/ProjectName/componentName/ejb/ComponentNameEJB.class" />  
   </target>

讲解:此小段用来把class和部署文件压缩成包文件,以支持客户端运行。


编译WEB部分

<!-- ================================================================== -->  
   <!-- Compilation of the web part of the application                     -->  
   <!-- ================================================================== -->  
   <target name="web-classes" depends="prepare,ejb-jar">  
       <javac srcdir="${src.servlet.dir}"  
             destdir="${lib.dir}/web/WEB-INF/classes"  
             includes="com/**"  
             classpath="${build.classpath}" />  
   </target>

讲解:此小段用来完成编译servlet。


 

<target name="web-web-inf" depends="prepare">
       <copy file="${etc.dir}/jboss-web.xml"  
             tofile="${lib.dir}/web/WEB-INF/jboss-web.xml" />  
       <copy file="${etc.dir}/web.xml"  
             tofile="${lib.dir}/web/WEB-INF/web.xml" />  
   </target>

讲解:此小段用来拷贝WEB部署文件,在JAS中WEB部署文件有jboss-web.xml。


<target name="war" depends="web-classes,web-web-inf">  
       <copy todir="${lib.dir}/web" >
       <fileset dir="${src.web.dir}"/>
       </copy>
       <copy
file="${build.dir}/${ProjectName.referencesComponentName.name}-ejb-client.jar"  
tofile="${lib.dir}/web/WEB-INF/lib/${ProjectName.referencesComponentName.name}
-ejb-client.jar" />    
     <jar jarfile="${build.dir}/${name}-web.war"  
           basedir="${lib.dir}/web" />  
   </target>

讲解:此小段用来把所有的JSP程序、Html、Css、图片和部署文件等压缩成WAR文件。


编译J2EE Application

<!-- ================================================================== -->  
   <!-- Compilation of the complete J2EE application (both web and EJB)     -->  
   <!-- ================================================================== -->  
   <target name="j2ee-meta-inf" depends="prepare">  
       <copy file="${etc.dir}/application.xml"  
             tofile="${lib.dir}/j2ee/META-INF/application.xml" />  
   </target>

讲解:此小段用来拷贝Application的部署文件。


 

<target name="ear" depends="ejb-jar,war,j2ee-meta-inf">  
       <copy file="${build.dir}/${name}-ejb.jar"  
             tofile="${lib.dir}/j2ee/${name}-ejb.jar" />  
       <copy file="${build.dir}/${name}-web.war"  
             tofile="${lib.dir}/j2ee/${name}-web.war" />  
       <jar jarfile="${build.dir}/${name}.ear"  
           basedir="${lib.dir}/j2ee" />  
   </target>

讲解:此小段用来把EJB组件、支持客户端运行的包和部署文件压缩成EAR文件,它就是一个J2EE Application。这里要说明,在进行build时,根据需要可以不生成EAR文件。


部署Application

<!-- ================================================================ -->
   <!-- Deploy EAR file                                                   -->
   <!-- ================================================================ -->
   <target name="deploy-server" depends="ear,war">  
       <copy todir="${jboss.deploy}">  
         <fileset dir="${build.dir}" includes="*.ear">  
         </fileset>  
       </copy>  
   </target>

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


创建组件的API

<!-- =================================================================== -->
   <!-- Create class and package usage pages                                 -->
   <!-- =================================================================== -->
   <target name="docs" depends="init">
     <javadoc locale="${javadoc.locale}" packagenames="${package.names}.${name}.*"  
             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.">  
<classpath >
         <pathelement path="${lib.dir}/ejb"/>  
       </classpath>
       <sourcepath>
         <pathelement path="${src.main.dir}/ejb"/>
       </sourcepath>
     </javadoc>
   </target>

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


确定build的目标

<target name="startbanner">
       <echo>+---------------------------------------+</echo>
       <echo>+     Building ${name} Component         +</echo>
       <echo>+---------------------------------------+</echo>
   </target>
   <target name="endbanner" depends="main" >
       <echo>+---------------------------------------+</echo>
       <echo>+     Finished ${name} Component         +</echo>
       <echo>+---------------------------------------+</echo>
   </target>
   <target name="main" depends="startbanner, ejb-jar, ejbclientjar" />
   <target name="main2" depends="startbanner, ejb-jar,
ejbclientjar,war" />
   <target name="main3" depends="startbanner, ejb-jar, 
ejbclientjar,war,ear,deploy-server" />
   <target name="core" depends="ejb-war" />
   <target name="ejb-war" depends="main2,endbanner" />
   <target name="deploy" depends="main3,endbanner" />
   <target name="all" depends="core, docs" />

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


 


相关文章
|
存储 安全 Java
Maven3.8.*系列 settings.xml详解
Maven3.8.*系列 settings.xml详解
731 0
|
7月前
|
安全 Java Linux
一文了解 Maven 的 settings.xml 配置文件
一文了解 Maven 的 settings.xml 配置文件
1386 0
|
7月前
cordova config.xml
cordova config.xml
45 1
|
Java Maven
Maven: settings.xml、pom.xml完整配置
Maven: settings.xml、pom.xml完整配置
1969 0
|
XML Java Linux
Ant之build.xml详解(一)
Ant之build.xml详解(一)
|
XML 开发框架 Java
Ant之build.xml(三)
Ant之build.xml(三)
|
XML 前端开发 Java
一个ant的build.xml文件记录
尽管现在公司maven,gradle占主流。 但ant还是有一些的。 对于不是java的项目打包的问题, ant就更有通用性了。
1320 0

相关课程

更多