天天看點

ant 的配置講解

以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="_blank" rel="external nofollow" />

   </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檔案進行部署。

轉自:http://hi.baidu.com/zjcyou/blog/item/42f0a8164ec0b21e962b43e4.html

繼續閱讀