*******************************************************
作者:陈刚,普通程序员,曾有幸以Eclipse插件方式开发过一个中型软件。现将所学
付诸于纸,暂取书名<Eclipse插件开发指南>,将于2005年初由清华大学出版社出版。
blog:http://blog.csdn.net/glchengang/
*******************************************************
21.3 用Ant来打包
Eclipse内置了Ant。Ant是一种类似于批处理程序的软件包,它主要繁琐的工作是编写和调试自动处理脚本(一个XML文件),但只要有了这个脚本,我们就可以一键完成所有的设定工作。
本节还是以myswt这个应用程序项目的打包为例,用Ant来完成“编译->打成JAR包->复制项目引用库->复制本地化文件swt-win32-3063.dll->输出API文档”这五步。
1、在myswt项目根目录下,创建最主要的build.xml文件
<?xml version="1.0"?>
<project name="myswt project" default="api_doc">
<!-- 定义目录变量 -->
<property name="src.dir" value="src" />
<property name="bin.dir" value="bin" />
<property name="eclipse_plugins.dir" value="c:/eclipse/plugins" />
<property name="dist.dir" value="d:/dist" />
<property name="doc.dir" value="${dist.dir}/api" />
<property name="swt.dll" value="swt-win32-3063.dll" />
<!-- 定义编译文件时所引用的库 -->
<path id="master-classpath">
<fileset dir="${eclipse_plugins.dir}" id="project_lib">
<include name="org.eclipse.ui.workbench_3.0.1/workbench.jar"/>
<include name="org.eclipse.swt.win32_3.0.1/ws/win32/swt.jar"/>
<include name="org.eclipse.jface_3.0.0/jface.jar"/>
<include name="org.eclipse.osgi_3.0.1/osgi.jar"/>
<include name="org.eclipse.osgi_3.0.1/core.jar"/>
<include name="org.eclipse.osgi_3.0.1/resolver.jar"/>
<include name="org.eclipse.osgi_3.0.1/defaultAdaptor.jar"/>
<include name="org.eclipse.osgi_3.0.1/eclipseAdaptor.jar"/>
<include name="org.eclipse.osgi_3.0.1/console.jar"/>
<include name="org.eclipse.core.runtime_3.0.1/runtime.jar"/>
<include name="org.eclipse.jface.text_3.0.1/jfacetext.jar"/>
<include name="org.eclipse.ui.workbench.compatibility_3.0.0/compatibility.jar"/>
</fileset>
</path>
<!-- 首任务(空)-->
<target name="init"/>
<!-- 编译 -->
<target name="compile" depends="init">
<delete dir="${bin.dir}"/>
<mkdir dir="${bin.dir}"/>
<!--编译源程序-->
<javac srcdir="${src.dir}" destdir="${bin.dir}" target="1.4">
<classpath refid="master-classpath"/>
</javac>
<!--复制图标目录-->
<mkdir dir="${bin.dir}/icons"/>
<copy todir="${bin.dir}/icons">
<fileset dir="icons"/>
</copy>
</target>
<!-- 打包 -->
<target name="pack" depends="compile">
<!-- bin目录压缩成JAR包 -->
<delete dir="${dist.dir}"/>
<mkdir dir="${dist.dir}" />
<jar basedir="${bin.dir}" destfile="${dist.dir}/myswt.jar" manifest="ant_manifes.txt">
<exclude name="**/*Test.*" />
<exclude name="**/Test*.*" />
</jar>
<!-- 复制用到的库 -->
<mkdir dir="${dist.dir}/lib" />
<copy todir="${dist.dir}/lib">
<fileset refid="project_lib"/>
</copy>
<!-- 复制本地化文件 -->
<copy todir="${dist.dir}" file="${swt.dll}"/>
</target>
<!-- 输出api文档 -->
<target name="api_doc" depends="pack">
<delete dir="${doc.dir}"/>
<mkdir dir="${doc.dir}" />
<javadoc destdir="${doc.dir}" author="true" version="true" use="true" windowtitle="MySWT API">
<packageset dir="${src.dir}" defaultexcludes="yes"/>
<doctitle><![CDATA[<h1>MySWT Project</h1>]]></doctitle>
<bottom><![CDATA[<i>Document by ChenGang 2005.</i>]]></bottom>
</javadoc>
</target>
</project>
代码说明:
(1)property项是定义变量,比如<property name="swt.dll" value="swt-win32-3063.dll" />,就是定义一个变量:swt.dll=swt-win32-3063.dll。以后用这个变量则是这样:${swt.dll}。
一般尽量将今后可能会变动的目录、文件等定义成变量,以方便维护。不象Java变量有类型的区分,Ant变量是不区别目录、文件等的,所以为了见名知意,在取变量名时,目录都加“dir”后缀,这个后缀是可以任取名的。
下面给出本例用到的变量的含义:
l src.dir - Java源文件路径。value="src"的src是一个相对路径,它相对的是build.xml的所在目录位置(即项目根目录)。
l bin.dir - Java编译文件的输出路径
l eclipse_plugins.dir - eclipse的plugins目录
l dist.dir - 打包文件的存放目录
l doc.dir - API文档的存放目录,这里用到了dist.dir变量,直接写value="d:/dist/api"也未尝不可。
l swt.dll - SWT本地化文件。
(2)<path id="master-classpath">,定义编译文件时所引用的库,相当于classpath。<fileset>项表示一个文件集,再深入一层的<include>项,则表示此文件集下的文件,它们的路径定位相对于<fileset>的dir属性。<fileset>还有一个id属性,在后面复制引用库时会用到。
也许有读者会问:“你是怎么知道要引用这些文件的?”回答:看项目根目录下的“.classpath”文件,就可以知道本项目要引用那些库了。实际上笔者是把.classpath复制一份后,然后用Editplus编辑而得。
(3)接下来开始定义一些任务。首任务一般都让它为空(没有具体任务内容):<target name="init"/>。
(4)Ant中的任务有着相互的依赖(depends)关系,这些依赖关系是通过depends属性来定义的。当要执行一个任务时,Ant先去执行这个任务的depends任务,……,Ant就这样一直往回找下去。比如:在本例的第二行default="api_doc",它定义了缺省任务是api_doc(输出api文档)->此任务的depends = pack(打包)->pack的depends = compile(编译)->compile的depends=init(首任务),init没有depends。于是,Ant就从init开始依次往回执行任务:init->compile->pack->api_doc。
如果你不想“输出api文档”,则将第二行的缺省任务定义成default="pack"即可,这时整个任务链就抛开了api_doc。
(5)<delete dir="${bin.dir}"/>删除目录。<mkdir dir="${bin.dir}"/>新建目录
(6)编译源程序,如下
<javac srcdir="${src.dir}" destdir="${bin.dir}" target="1.4">
<classpath refid="master-classpath"/>
</javac>
l srcdir - 源文件目录,其子目录中的源文件也会被javac.exe编译。
l destdir - 编译文件输出目录。
l target - 以JDK1.4为编译目标。
l classpath - 编译的classpath设置,refid是指引用前面设定的master-classpath。
(7)将icons(即myswt/icons)目录的文件,复制到myswt/bin/icons目录中,如下:
<copy todir="${bin.dir}/icons">
<fileset dir="icons"/>
</copy>
(8)将文件打成JAR包
<jar basedir="${bin.dir}" destfile="${dist.dir}/myswt.jar" manifest="ant_manifes.txt">
<exclude name="**/*Test.*" />
<exclude name="**/Test*.*" />
</jar>
l basedir - 源目录。
l destfile - 目标目录和打成JAR包名。
l manifest - 打包清单文件(后面给出其内容)。
l exclude - 使用了通配符将某一些文件排除不打包(主要是一些测试文件)。
(9)如下,将project_lib的文件复制到d:/dist/lib目录中。project_lib是前面“定义编译文件时所引用的库”中的文件集的id。结果参数下图21.25
<copy todir="${dist.dir}/lib">
<fileset refid="project_lib"/>
</copy>
(10)将本地化文件复制到d:/dist目录中,如下:
<copy todir="${dist.dir}" file="${swt.dll}"/>
(11)输出API文档(结果参数下图21.26)
<javadoc destdir="${doc.dir}" author="true" version="true" use="true" windowtitle="MySWT API">
<packageset dir="${src.dir}" defaultexcludes="yes"/>
<doctitle><![CDATA[<h1>MySWT Project</h1>]]></doctitle>
<bottom><![CDATA[<i>Document by ChenGang 2005.</i>]]></bottom>
</javadoc>
l destdir - 目标路径d:/dist/api
l packageset - 源文件目录
l doctitle - 标题
l bottom - 标尾。
2、创建打包清单
为了避免和原来的manifes.txt同名,在项目根目录建立一个名为ant_manifes.txt的文件。这个文件内容中最长的是Class-Path项,没有必要一个个字符的敲入,它可以由项目根目录下的“.classpath”编辑而得。
ant_manifes.txt内容如下:
Manifest-Version: 1.0
Main-Class: jface.dialog.wizard.WizardDialog1
Class-Path: ./lib/org.eclipse.ui.workbench_3.0.1/workbench.jar ./lib/org.eclipse.swt.win32_3.0.1/ws/win32/swt.jar
./lib/org.eclipse.jface_3.0.0/jface.jar ./lib/org.eclipse.osgi_3.0.1/osgi.jar ./lib/org.eclipse.osgi_
3.0.1/core.jar ./lib/org.eclipse.osgi_3.0.1/resolver.jar ./lib/org.eclipse.osgi_3.0.1/defaultAdaptor.ja
r ./lib/org.eclipse.osgi_3.0.1/eclipseAdaptor.jar ./lib/org.eclipse.osgi_3.0.1/console.jar ./lib/org.ecl
ipse.core.runtime_3.0.1/runtime.jar ./lib/org.eclipse.jface.text_3.0.1/jfacetext.jar ./lib/org.eclipse.u
i.workbench.compatibility_3.0.0/compatibility.jar
3、如下图21.23所示,选择“Ant构建”来运行Ant。
图21.23 运行“Ant构建”
运行“Ant构建”后的结果如下图21.23-26所示。
图21.24 控制台的输出
图21.25 输出文件的目录结构图
图21.26 输出的API文档效果图
4、运行打包结果
除了清单文件MANIFEST.MF之外,myswt.jar文件和21.1节所得的myswt.jar一样。本节没有创建run.bat批处理文件,而是用下图21.27所示的“右击myswt.jar->打开方式->javaw”的方式来运行myswt.jar。
图21.27 运行myswt.jar