Ant - tutorial
Language/JAVA 2013. 8. 26. 14:29Apache Ant - tutorial
Version 2.5
Copyright © 2008, 2009, 2010, 2011, 2012, 2013 Lars Vogel
09.04.2013
| Revision History | |||
|---|---|---|---|
| Revision 0.1 | 30.11.2008 | Lars Vogel | Created |
| Revision 0.2 - 2.5 | 12.01.2009 - 09.04.2013 | Lars Vogel | bugfixes and enhancements |
Table of Contents
A build tool is used to automate repetitive tasks. This can be for example compiling source code, running software tests and creating files and documentation for the software deployment.
Build tools typically run without a graphical user interface (headless) directly from the command line.
Popular build tools in the Java space are Apache Ant, Maven and Gradle.
Apache Ant (Ant) is a general purpose build tool. Ant is an abbreviation for Another Neat Tool.
Ant is primarily used for building and deploying Java projects but can be used for every possible repetitive tasks, e.g. generating documentation.
A Java build process typically includes:
- the compilation of the Java source code into Java bytecode
- creation of the .jar file for the distribution of the code
- creation of the Javadoc documentation
Ant uses an xml file for its configuration. The default file name is build.xml. Ant builds are based on three blocks: tasks,targets and extension points .
A task is a unit of work which should be performed and are small, atomic steps, for example compile source code or create Javadoc. Tasks can be grouped into targets.
A target can be directly invoked via Ant. Targets can specify their dependencies. Ant will automatically execute dependent targets.
For example if target A depends on B, than Ant will first perform B and then A.
In your build.xml file you can specify the default target. Ant will execute this target, if no explicit target is specified.
Java might already be installed on your machine. You can test this by opening a console (if you are using Windows: Win+R, enter cmd and press Enter) and by typing in the following command:
java -version
If Java is correctly installed, you should see some information about your Java installation. If the command line returns the information that the program could not be found, you have to install Java. The central website for installing Java is the following URL:
http://java.com
If you have problems installing Java on your system, search via Google for How to install JDK on YOUR_OS . This should result in helpful links. Replace YOUR_OS with your operating system, e.g. Windows, Ubuntu, Mac OS X, etc.
On Ubuntu or Debian use the apt-get install ant command to install Apache Ant. For other distributions please check the documentation of your vendor.
Download Apache Ant from http://ant.apache.org/.
Extract the zip file into a directory structure of your choice. Set the ANT_HOME environment variable to this location and include the ANT_HOME/bin directory in your path.
Make sure that also the JAVA_HOME environment variable is set to the JDK. This is required for running Ant.
Check your installation by opening a command line and typing ant -version into the commend line. The system should find the command ant and show the version number of your installed Ant version.
The following describes how you compile Java classes, create an executable JAR file and create Javadoc for your project with Apache Ant. The following example assumes that your are using the Eclipse IDE to manage your Java project and your Ant build.
Create a Java project called de.vogella.build.ant.first in Eclipses. Create a package called math and the following class.
package math; public class MyMath { public int multi(int number1, int number2) { return number1 * number2; } }
Create the test package and the following class.
package test; import math.MyMath; public class Main { public static void main(String[] args) { MyMath math = new MyMath(); System.out.println("Result is: " + math.multi(5, 10)); } }
Create a new File through the → → menu and create the build.xml file. Implement the following code to this file.
<?xml version="1.0"?> <project name="Ant-Test" default="main" basedir="."> <!-- Sets variables which can later be used. --> <!-- The value of a property is accessed via ${} --> <property name="src.dir" location="src" /> <property name="build.dir" location="bin" /> <property name="dist.dir" location="dist" /> <property name="docs.dir" location="docs" /> <!-- Deletes the existing build, docs and dist directory--> <target name="clean"> <delete dir="${build.dir}" /> <delete dir="${docs.dir}" /> <delete dir="${dist.dir}" /> </target> <!-- Creates the build, docs and dist directory--> <target name="makedir"> <mkdir dir="${build.dir}" /> <mkdir dir="${docs.dir}" /> <mkdir dir="${dist.dir}" /> </target> <!-- Compiles the java code (including the usage of library for JUnit --> <target name="compile" depends="clean, makedir"> <javac srcdir="${src.dir}" destdir="${build.dir}"> </javac> </target> <!-- Creates Javadoc --> <target name="docs" depends="compile"> <javadoc packagenames="src" sourcepath="${src.dir}" destdir="${docs.dir}"> <!-- Define which files / directory should get included, we include all --> <fileset dir="${src.dir}"> <include name="**" /> </fileset> </javadoc> </target> <!--Creates the deployable jar file --> <target name="jar" depends="compile"> <jar destfile="${dist.dir}\de.vogella.build.test.ant.jar" basedir="${build.dir}"> <manifest> <attribute name="Main-Class" value="test.Main" /> </manifest> </jar> </target> <target name="main" depends="compile, jar, docs"> <description>Main target</description> </target> </project>
The code is documented, you should be able to determine the purpose of the different ant tasks via the documentation in the coding.
Run the build.xml file as an Ant Build in Eclipse.
After this process your data structure should look like this:
Ant allows to create classpath containers and use them in tasks. The following build.xml from a project calledde.vogella.build.ant.classpath demonstrates this.
<?xml version="1.0"?> <project name="Ant-Test" default="Main" basedir="."> <!-- Sets variables which can later be used. --> <!-- The value of a property is accessed via ${} --> <property name="src.dir" location="src" /> <property name="lib.dir" location="lib" /> <property name="build.dir" location="bin" /> <!-- Create a classpath container which can be later used in the ant task --> <path id="build.classpath"> <fileset dir="${lib.dir}"> <include name="**/*.jar" /> </fileset> </path> <!-- Deletes the existing build directory--> <target name="clean"> <delete dir="${build.dir}" /> </target> <!-- Creates the build directory--> <target name="makedir"> <mkdir dir="${build.dir}" /> </target> <!-- Compiles the java code --> <target name="compile" depends="clean, makedir"> <javac srcdir="${src.dir}" destdir="${build.dir}" classpathref="build.classpath" /> </target> <target name="Main" depends="compile"> <description>Main target</description> </target> </project>
You can use the following statements to write the full classpath to the console. You can use this to easily verify if the classpath is correct.
<!-- Write the classpath to the console. Helpful for debugging --> <!-- Create one line per classpath element--> <pathconvert pathsep="${line.separator}" property="echo.classpath" refid="junit.class.path"> </pathconvert> <!-- Write the result to the console --> <echo message="The following classpath is associated with junit.class.path " /> <echo message="${echo.classpath}" />
Ant allows to run JUnit tests. Ant defines junit task. You only need to include the junit.jar and the compiled classes into the classpath for Ant and then you can run JUnit tests. See JUnit Tutorial for an introduction into JUnit.
The following is a JUnit test for the previous example.
package test; import math.MyMath; import org.junit.Test; import static org.junit.Assert.assertEquals; public class MyMathTest { @Test public void testMulti() { MyMath math = new MyMath(); assertEquals(50, math.multi(5, 10)); } }
You can run this JUnit unit test via the following build.xml. This example assumes that the JUnit jar "junit.jar" is in folder "lib".
<?xml version="1.0"?> <project name="Ant-Test" default="main" basedir="."> <!-- Sets variables which can later be used. --> <!-- The value of a property is accessed via ${} --> <property name="src.dir" location="src" /> <property name="build.dir" location="bin" /> <!-- Variables used for JUnit testin --> <property name="test.dir" location="src" /> <property name="test.report.dir" location="testreport" /> <!-- Define the classpath which includes the junit.jar and the classes after compiling--> <path id="junit.class.path"> <pathelement location="lib/junit.jar" /> <pathelement location="${build.dir}" /> </path> <!-- Deletes the existing build, docs and dist directory--> <target name="clean"> <delete dir="${build.dir}" /> <delete dir="${test.report.dir}" /> </target> <!-- Creates the build, docs and dist directory--> <target name="makedir"> <mkdir dir="${build.dir}" /> <mkdir dir="${test.report.dir}" /> </target> <!-- Compiles the java code (including the usage of library for JUnit --> <target name="compile" depends="clean, makedir"> <javac srcdir="${src.dir}" destdir="${build.dir}"> <classpath refid="junit.class.path" /> </javac> </target> <!-- Run the JUnit Tests --> <!-- Output is XML, could also be plain--> <target name="junit" depends="compile"> <junit printsummary="on" fork="true" haltonfailure="yes"> <classpath refid="junit.class.path" /> <formatter type="xml" /> <batchtest todir="${test.report.dir}"> <fileset dir="${src.dir}"> <include name="**/*Test*.java" /> </fileset> </batchtest> </junit> </target> <target name="main" depends="compile, junit"> <description>Main target</description> </target> </project>
Ant provides the fail task which allows to fail the build if a condition is not met. For example the following task would check for the existing of a file and if this file is present the build would fail.
<fail message="PDF file was not created."> <condition> <not> <available file="${pdf.dir}/path/book.pdf" /> </not> </condition> </fail>
Or you can check for the number of files generated.
<fail message="Files are missing."> <condition> <not> <resourcecount count="2"> <fileset id="fs" dir="." includes="one.txt,two.txt"/> </resourcecount> </not> </condition> </fail>
Eclipse has an ant editor which make the editing of ant file very easy by providing syntax checking of the build file. Eclipse has also a ant view. In this view you execute ant files via double-clicking on the target.
Apache Ant allows to convert relative paths to absolute paths. The following example demonstrates that.
<!-- Location of a configuration --> <property name="my.config" value="../my-config.xml"/> <makeurl file="${my.config}" property="my.config.url"/>
This property can later be used for example as a parameter.
<param name="highlight.xslthl.config" expression="${my.config.url}"/>
Ant can be used to replace text based on regular expressions. The following Ant Target replaces tabs with double spaces.
<target name="regular-expressions"> <!-- Replace tabs with two spaces --> <replaceregexp flags="gs"> <regexp pattern="(\t)" /> <substitution expression=" " /> <fileset dir="${outputtmp.dir}/"> <include name="**/*" /> </fileset> </replaceregexp> </target>
If you find errors in this tutorial please notify me (see the top of the page). Please note that due to the high volume of feedback I receive, I cannot answer questions to your implementation. Ensure you have read the vogella FAQ, I also don't answer questions answered in the FAQ.
http://www.vogella.com/code/codejava.html Source Code of Examples
'Language > JAVA' 카테고리의 다른 글
| log4j (0) | 2013.08.29 |
|---|---|
| jUnit 으로 Private Method 테스트 만들기 (0) | 2013.08.28 |
| ANT Build (0) | 2013.08.26 |
| 정규식 날짜, 시간 (0) | 2013.08.21 |
| Java 인자 전달 방식: Call-by-{Value | Reference}? (0) | 2013.08.09 |