用ANT構(gòu)造Application

2019-11-18 15:21:16

字體：大中小

供稿：網(wǎng)友

　　Ant是Apache提供給java開(kāi)發(fā)人員的構(gòu)建工具，它可以在Windows OS和Unix OS下運(yùn)行，它不僅開(kāi)放源碼并且還是一個(gè)非常好用的工具。我強(qiáng)烈建議在進(jìn)行JavaBean、EJB等開(kāi)發(fā)時(shí)安裝，不建議安裝make、makefile等建立在shell思想上的構(gòu)建工具。

下載Ant

官方網(wǎng)址: http://jakarta.apache.org/ant/

下載URL: http://jakarta.apache.org/builds/jakarta-ant/release/

安裝Ant

設(shè)置ANT_HOME系統(tǒng)變量和PATH系統(tǒng)變量

? Windows

假如ant安裝目錄為c:ant，按下面方法設(shè)置

set ANT_HOME=c:ant

set JAVA_HOME=c:jdk1.3

set PATH=%PATH%;%ANT_HOME%in

? Unix

假如ant安裝目錄為/usr/local/ant，按下面方法設(shè)置


eXPort ANT_HOME=/usr/local/ant
export JAVA_HOME=/usr/local/jdk1.3
export PATH=${PATH}:${ANT_HOME}/bin

運(yùn)行Ant

前面說(shuō)Ant"是一個(gè)非常好用的工具"，就是因?yàn)檫\(yùn)行它很簡(jiǎn)單，只要在命令行輸入"ant"，ant就運(yùn)行了。我以構(gòu)建序列發(fā)生器SequenceGenerator進(jìn)行示例，

在控制臺(tái)顯示的構(gòu)建信息：查看具體內(nèi)容。

控制臺(tái)快照，見(jiàn)下圖：

構(gòu)建序列發(fā)生器的第一屏

構(gòu)建序列發(fā)生器的第二屏

Ant的命令行參數(shù)

Ant也可以通過(guò)命令行參數(shù) -buildfile 來(lái)指定其他目標(biāo)文件，其中，是你要采用的目標(biāo)文件名。Ant還有很多命令行可選參數(shù)，如下所示：

命令行可選參數(shù)摘要：


ant [options] [target [target2 [target3] ...]]
Options:
-help                  PRint this message
-projecthelp           print project help information
-version               print the version information and exit
-quiet                 be extra quiet
-verbose               be extra verbose
-debug                 print debugging information
-emacs                 prodUCe logging information without adornments
-logfile file          use given file for log output
-logger classname      the class that is to perform logging
-listener classname    add an instance of class as a project listener
-buildfile file        use specified buildfile
-find file             search for buildfile towards the root of the filesystem and 
use the first one found
-Dproperty=value       set property to value

編寫(xiě)build.xml

Ant的buildfile是用XML寫(xiě)的。每個(gè)buildfile含有一個(gè)project。

buildfile中每個(gè)任務(wù)元素可以有一個(gè)id屬性，可以用這個(gè)id值引用指定的任務(wù)。這個(gè)值必須是唯一的。

下面是Ant中常用的元素和任務(wù)：

常用的元素有"project"、"target"、"path"、"property"等。

常用的任務(wù)有"ant"、"mkdir"、"delete"、"copy"、"javac"、"jar"、"javadoc"、"echo"等。

（注：它們的具體用法，我不再詳述，請(qǐng)參閱下載ant時(shí)ant中自帶的用戶手冊(cè)。）

我以下面的build_for_ejb_templet.xml為示例，講解Ant中常用的元素和任務(wù)。

約定：

1. 每行代碼的前部分為"數(shù)字"+"."，數(shù)字表示在XML文件中的行號(hào)

2. "…"表示這里有很多代碼，未列出

build_for_ejb_templet.xml任務(wù)的分為以下幾大部分

i. 開(kāi)始

ii. 初始化

iii. 定義classpath

iv. 為編譯作預(yù)備

v. 編譯EJB部分

vi. 編譯WEB部分

vii. 編譯J2EE application

viii. 部署Application

ix. 創(chuàng)建組件的API

x. 確定build的目標(biāo)

build_for_ejb_templet.xml的講解

開(kāi)始


<?xml version="1.0" encoding="UTF-8"?>  
講解：encoding="UTF-8"表示XML文件采用UTF-8編碼格式，假如要使用GBK編碼，
需定義為encodeing="GBK"。
3. <!--  
4.   Build file for 'componentName'  
5.   Creation date : $Date: yyyy-m-d $  
6.   Updated date : $Date: yyyy-m-d $  
7.   Author:  developerName
8.   Copyright 2002 CompanyName, Inc. All rights reserved.  
9. -->  
講解：此部分為文件內(nèi)容的簡(jiǎn)介，包括文件名稱、創(chuàng)建日期、最后修改日期、創(chuàng)建文件的作者、版權(quán)。
componentName 表示 文件名稱
yyyy-m-dd 表示 創(chuàng)建日期、最后修改日期的格式，如2002-5-1
developerName 表示 創(chuàng)建文件的作者
CompanyName 表示 公司名稱或URL
11. <project name="componentName" default="core" basedir=".">
…
254. </project>
講解：此部分定義了一個(gè)名稱為componentName的項(xiàng)目元素，缺省的任務(wù)為"core"任務(wù)，
根目錄為當(dāng)前目錄。componentName表示組件的名稱，這里指EJB的名稱。

初始化


17.  <target name="init">
…
63.  </target>
講解：此部分用于初始化所有的變量
18.      <property file="../../build.properties" />
講解：導(dǎo)入項(xiàng)目根目錄下build.properties中的全局變量，開(kāi)發(fā)人員也可以在此文件中重新定義全局變量。
19.      <property name="jboss.lib" value="${jboss.home}/lib" />  
20.      <property name="jboss.client" value="${jboss.home}/client" />  
21.      <property name="jboss.deploy" 
value="${jboss.home}/server/${jboss.configuration}/deploy" />  
…
27.      <property name="jboss.dir"      value="${jboss.home}" />  
…
41.      <property name="deploy.ormi"     value=""/>  
42.      <property name="deploy.username" value=""/>  
43.      <property name="deploy.passWord" value=""/>
講解：定義和Jboss Application Server有關(guān)的變量，包括lib目錄、client目錄、
deploy目錄和J2EE Application部署要用到的一些變量。
22.      <property name="name"           value="componentName"     />  
講解：定義組件的名稱
23.      <property name="src.dir"        value="${basedir}/src"        />  
講解：定義源代碼目錄路徑
24.      <property name="etc.dir"        value="${basedir}/etc"        />  
講解：定義資源目錄路徑
25.      <property name="lib.dir"        value="${basedir}/lib"        />  
講解：定義庫(kù)目錄路徑
26.     <property name="build.dir"      value="${basedir}/build"       />  
講解：定義build目錄路徑
28.	<property name="src.main.dir" value="${src.dir}/main"/>
講解：定義源代碼的主目錄路徑
29.	<property name="src.ejb.dir" value="${src.main.dir}/ejb"/>  
講解：定義存放EJB的源代碼目錄路徑
30.	<property name="src.javabean.dir" value="${src.main.dir}/javabean"/>
講解：定義存放JavaBean的源代碼目錄路徑
31.	<property name="src.servlet.dir" value="${src.main.dir}/servlet"/>
講解：定義存放Servlet的源代碼目錄路徑
32.	<property name="src.web.dir" value="${src.main.dir}/web"/>  
講解：定義存放WEB部分文件（包括jsp程序、Html文件、圖片、CSS文件、JS腳本等）的目錄路徑
33.      <property name="javadoc.dir" value="${lib.dir}/docs/api"       /> 
講解：定義存放組件API的開(kāi)發(fā)文件目錄路徑
34.      <property name="ejb-classes.dest" value="${lib.dir}/ejb"  />  
講解：定義存放EJB的編譯代碼目錄路徑
35.	<property name="javabean-classes.dest" value="${lib.dir}/javabean"    />  
講解：定義存放JavaBean的編譯代碼目錄路徑
36.	<property name="web-classes.dest" value="${lib.dir}/web/WEB-INF/classes" />
講解：定義WEB目錄的類目錄路徑
37.      <property name="web-lib.dest" value="${lib.dir}/web/WEB-INF/lib" />  
講解：定義WEB目錄的庫(kù)目錄名稱
38.      <property name="pkg-dist.name"     value="${name}-pkg" />  
講解：定義壓縮文檔的名稱
45. <property name="ProjectName.components.home"      value="../../components" />  
講解：定義項(xiàng)目的組件目錄路徑
47. <!-- Define componentName Component -->
講解：這段為注釋，說(shuō)明以下是定義當(dāng)前組件的變量
48. <property name="ProjectName.componentName.name" value="componentName"/>
講解：定義當(dāng)前組件的名稱
49.<property name="ProjectName.componentName.home" 
value="${ProjectName.components.home}/componentName"/>
講解：定義當(dāng)前組件的目錄路徑
50.<property name="ProjectName.componentName.classbindir" 
value="${ProjectName.componentName.home}/lib/ejb"/>
講解：定義當(dāng)前組件的EJB編譯目錄路徑
51.<property name="ProjectName.componentName.ejbjar" 
value="${ProjectName.componentName.home}/build/componentName-ejb.jar"/>
講解：定義當(dāng)前組件內(nèi)的EJB包的路徑
52.      <property name="ProjectName.componentName.ejbjar.client" 
value="${ProjectName.componentName.home}/build/componentName-ejb-client.jar"/>
講解：定義當(dāng)前組件內(nèi)的EJB客戶端包的路徑
54. <!-- Define referencesComponentName Component -->
講解：這段為注釋，說(shuō)明以下是定義引入其它組件的變量
55. <property name="ProjectName.referencesComponentName.name" 
value="referencesComponentName"/>
講解：定義指定組件的名稱
56. <property name="ProjectName.referencesComponentName.home" 
value="${ProjectName.components.home}/referencesComponentName"/>
講解：定義指定組件的目錄路徑
57. <property name="ProjectName.referencesComponentName.classbindir" 
value="${ProjectName.referencesComponentName.home}/lib/ejb"/>
講解：定義指定組件的EJB編譯目錄路徑
58. <property name="ProjectName.referencesComponentName.ejbjar" 
value="${ProjectName.referencesComponentName.home}
/build/referencesComponentName-ejb.jar"/>
講解：定義指定組件內(nèi)的EJB包的路徑
59. <property name="ProjectName.referencesComponentName.ejbjar.client" 
value="${ProjectName.referencesComponentName.home}
/build/referencesComponentName-ejb-client.jar"/>
講解：定義指定組件內(nèi)的EJB客戶端包的路徑
61. <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時(shí)要用到。這是定義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>  
講解：此段定義應(yīng)用服務(wù)器中包文件，如支持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>  
講解：此段定義項(xiàng)目中要用到的包文件。
   <path id="web.path">
         <path refid="project.path"/>
         <pathelement location="${servlet-lib.path}"/>
         <pathelement location="${ejb-classes.dest}"/>
   </path>
講解：此段定義在編譯servlet時(shí)的classpath，${ servlet-lib.path }是系統(tǒng)指定的Servlet引擎包。

為編譯作預(yù)備工作


<!-- ================================================================== -->  
   <!-- 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>  
講解：創(chuàng)建build中要用到的所有目錄，根據(jù)需要可以加入自定義的目錄如：
      <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>  
講解：此小段用來(lái)完成編譯ejb和其它help classes。根據(jù)需要可以加入一個(gè)非常有用的元素：
	     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>
講解：此小段用來(lái)拷貝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>  
講解：此小段用來(lái)把class和部署文件壓縮成包文件，這個(gè)包文件就是一個(gè)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>
講解：此小段用來(lái)把class和部署文件壓縮成包文件，以支持客戶端運(yùn)行。

編譯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>  
講解：此小段用來(lái)完成編譯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>
講解：此小段用來(lái)拷貝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>
講解：此小段用來(lái)把所有的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>  
講解：此小段用來(lái)拷貝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>  
講解：此小段用來(lái)把EJB組件、支持客戶端運(yùn)行的包和部署文件壓縮成EAR文件，它就是一個(gè)J2EE 
Application。這里要說(shuō)明，在進(jìn)行build時(shí)，根據(jù)需要可以不生成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>  
講解：此小段用來(lái)部署Application，在JAS3.0中${jboss.deploy}是JAS的熱部署目錄。

創(chuàng)建組件的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>

講解：此小段用來(lái)創(chuàng)建組件的API。這里強(qiáng)烈要求類設(shè)計(jì)人員和編碼人員按照J(rèn)avadoc定義的標(biāo)簽對(duì)源代碼進(jìn)行注釋。

確定build的目標(biāo)


<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" />

講解：此小段用來(lái)確定build的目標(biāo)。缺省目錄為core，所以在build不加參數(shù)時(shí)，系統(tǒng)將只生成jar文件和war文件。假如build時(shí)加上參數(shù)，系統(tǒng)將根據(jù)需要來(lái)生成文件，例如：在命令行輸入ant deploy，系統(tǒng)將生成jar文件、war文件、ear文件，同時(shí)將ear文件進(jìn)行部署。

開(kāi)發(fā)Java項(xiàng)目的Build規(guī)范

在項(xiàng)目的根目錄下定義文件build.properties，文件中定義了項(xiàng)目的共用變量，提供給所有開(kāi)發(fā)人員使用。

在開(kāi)發(fā)一個(gè)Java項(xiàng)目時(shí)，所有的項(xiàng)目build.properties必須以下面的build.properties為模板。
build.properties
開(kāi)發(fā)JavaBean的build.xml規(guī)范

在開(kāi)發(fā)JavaBean時(shí)，所有的JavaBean必須以下面的build.xml為模板。

JavaBean build.xml模板

?開(kāi)發(fā)EJB的build.xml規(guī)范

在開(kāi)發(fā)EJB時(shí)，所有的EJB必須以下面的build.xml為模板。

開(kāi)發(fā)EJB的build.xml模板

? 開(kāi)發(fā)Components的build.xml規(guī)范

在開(kāi)發(fā)Components時(shí)，所有的Components必須以下面的build.xml為模板。

Components的build.xml模板

? 開(kāi)發(fā)Application的build.xml規(guī)范

a) 在Application的根目錄下定義文件build.properties，文件中定義了Application的共用變量，提供給所有開(kāi)發(fā)人員使用。

在開(kāi)發(fā)一個(gè)Application時(shí)，Application下的build.properties必須以下面的build.properties為模板。

Application下的build.properties模板

b)在開(kāi)發(fā)Application時(shí)，所有的Application必須以下面的build.xml為模板。

Application下的build.xml模板

上一篇：String類使用的例子(3)

下一篇：在GUI控件上放置圖片，并在圖片上輸出半透明文字