用Ant 构建Java Web 项目

题图来自网络

目前Java 世界的构建工具主要有3个,按流行度分别是Gradle、Maven、Ant,其中Ant 的历史最悠久。Gradle 的流行得益于Android的普及,Android Studio 开发的Android 项目默认使用Gradle构建,并且Gradle 可以使用Maven 的仓库。

由于一些不可描述的原因,之前的一个Java Web项目只是依赖于手工IDE进行打包,没有使用构建工具。项目的目录结构也不太合适改造为Gradle 或者Maven 项目。经过调研,最后只好使用Ant进行打包构建。

使用Ant 构建,希望能达到的目的:自动编译、运行Junit 单元测试、打成war 包。

项目的目录结构如下:

1
2
3
4
5
6
7
8
9
10
src
com
resources
WebContent
WEB-INF
lib
html
...
tomcat-lib
build.xml

单元测试没有与源代码分开,都放到com下统一采用XXXTest.java 命名。
依赖的jar包都放在WebContent/WEB-INF/lib下,但是由于部分代码依赖tomcat的库,所以把tomcat-lib也放进来方便打包和Jenkins 集成测试。如果不是为了方便之后的Jenkins 集成测试,tomcat-lib 是可以不加进来的。

1
<property name="tomcat.lib.dir" value="${basedir}/tomcat-lib" description="tomcat jar包"/>

用下面的代码替换,系统必须有CATALINA_HOME 环境变量指向tomcat 的安装目录。

1
2
<property environment="SystemVariable" />
<property name="tomcat.lib.dir" value="${SystemVariable.CATALINA_HOME}/lib" description="tomcat jar包"/>

在javac 任务中指定编码有两种方式,一种是直接javac 后面加属性encoding="utf8",另一种是用compilerarg 标签,采用compilerarg 是因为方便后面添加其他javac 的编译参数。

1
<compilerarg line="-encoding utf-8"/>

在junt 任务中需要指定jvm 参数-Dfile.encoding=UTF-8 要不然测试生成的log文件内容会有乱码,虽然测试的log一般都不看🙈

1
2
<!-- 修改输出的格式为UTF-8,要不然log日志会乱码 -->
<jvmarg value="-Dfile.encoding=UTF-8"/>

编写好build.xml 文件之后就可以用IDE 或者命令行执行Ant 任务。在命令行中cd 到工程根目录,然后执行ant(前提是下载好Ant,解压并把ant 命令加到系统变量中),就会执行到dist任务,打好war包。若是执行ant test,则在执行test 任务前会先执行依赖的init 和compile 任务。

后续待完善的是通过Jenkins 集成远程部署到tomcat 或者直接打包到docker镜像。

完整的build.xml 文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
<?xml version="1.0" encoding="UTF-8"?>
<project name="不可描述" default="dist" basedir=".">
<property name="build.dir" value="build" description="输出目录"/>
<property name="build.web.dir" value="${build.dir}/WEB-INF" description="web配置输出目录"/>
<property name="build.web.class.dir" value="${build.web.dir}/classes" description="web类输出目录"/>
<property name="build.web.lib.dir" value="${build.web.dir}/lib" description="web引用jar输出目录"/>
<property name="src.dir" value="src" description="源代码目录"/>
<property name="webRoot.dir" value="${basedir}/WebContent" description="web根目录"/>
<property name="lib.dir" value="${webRoot.dir}/WEB-INF/lib" description="web根目录lib"/>
<!-- 不加入tomcat-lib 依赖系统tomcat,就采用这种方式
<property environment="SystemVariable" />
<property name="tomcat.lib.dir" value="${SystemVariable.CATALINA_HOME}/lib" description="tomcat jar包"/>
-->
<property name="tomcat.lib.dir" value="${basedir}/tomcat-lib" description="tomcat jar包"/>
<property name="report.dir" value="report" description="测试报告目录"/>
<property name="encoding" value="utf-8" description="文件编码"/>
<path id="project.classpath">
<fileset dir="${lib.dir}">
<include name="*.jar"/>
</fileset>
<fileset dir="${tomcat.lib.dir}">
<include name="*.jar"/>
</fileset>
</path>
<target name="init">
<delete dir="${build.dir}"/>
<mkdir dir="${build.dir}"/>
<mkdir dir="${build.web.dir}"/>
<mkdir dir="${build.web.class.dir}"/>
<mkdir dir="${build.web.lib.dir}"/>
<delete dir="${report.dir}"/>
<mkdir dir="${report.dir}"/>
</target>
<target name="compile" depends="init">
<javac destdir="${build.web.class.dir}" srcdir="${src.dir}" source="1.8" debug="on"
includeantruntime="false" deprecation="false" optimize="false" failonerror="true" >
<compilerarg line="-encoding utf-8"/>
<classpath refid="project.classpath"></classpath>
</javac>
<copy todir="${build.web.class.dir}">
<fileset dir="${src.dir}" excludes="**/*.java" />
</copy>
<copy todir="${build.dir}">
<fileset dir="${webRoot.dir}" excludes="**/*.class" />
</copy>
</target>
<target name="test" depends="init,compile">
<junit printsummary="true" haltonerror="true" haltonfailure="true" fork="yes" forkmode="perBatch" timeout="100000">
<classpath >
<fileset dir="${lib.dir}" includes="*.jar" />
<fileset dir="${tomcat.lib.dir}" includes="*.jar"/>
<!-- 必须使用pathelement,不能使用fileset -->
<pathelement path="${build.web.class.dir}"/>
</classpath>
<!-- 修改输出的格式为UTF-8,要不然log日志会乱码 -->
<jvmarg value="-Dfile.encoding=UTF-8"/>
<formatter type="xml"/>
<batchtest todir="${report.dir}">
<fileset dir="${build.web.class.dir}">
<!-- 只指向Test 结尾的文件-->
<include name="**/*Test.*"/>
</fileset>
</batchtest>
</junit>
<junitreport todir="${report.dir}">
<fileset dir="${report.dir}">
<include name="TEST-*.xml"/>
</fileset>
<report format="frames" todir="${report.dir}"/>
</junitreport>
</target>
<target name="dist" depends="init,compile,test" description="将工程打成war包">
<war destfile="${build.dir}/${ant.project.name}.war" basedir="${build.dir}" webxml="${build.web.dir}/web.xml" />
</target>
</project>