Ant PDF

JAVA Means DURGASOFT
An Introduction to Ant
DURGA SOFTWARE SOLUTIONS ,202 HUDA Maitrivanam, Ameerpet , Hyd. Ph: 040-64512786
1
Index
Installing Ant
Ant Setup
Project Organization
Anatomy of a Build File
Projects
Build File
Properties
Build File with Properties
Targets
Build File with Targets
Tasks
Initialization Target & Tasks
Compilation Target & Tasks
Javadoc Target & Tasks
Cleanup Target & Tasks
Completed Build File (1 of 2)
Running Ant Command Line
Running Ant Eclipse
2
What is Ant?
Ant is a Java based tool for automating the buildprocess

Similar to make but implemented using Java
Platform independent commands (works on Windows,Mac &Unix)
XML based format
Avoids the dreaded tab issue in make files
Easily extendable using Java classes
Ant is an open source (free) Apache project
Automating the Build (C & make)
The goal is to automate the build process
3
Installing Ant
Ant can be downloaded from http://ant.apache.org/
Ant comes bundled as a zip file or a tarball
Simply unwrap the file to some directorywhere you want to store the executables
I typically unwrap the zip file into C:\ProgramFiles, and rename to C:\Program Files\ant\
This directory is known as ANT_HOME
Ant Setup
Set the ANT_HOME environment variable towhere you installed Ant

Add the ANT_HOME/bin directory to your path
Set the JAVA_HOME environment variable tothe location where you installed Java
Setting environment variables
Windows: right click My Computer Properties Advanced Environment Variables
UNIX: shell specific settings
Project Organization
The following example assumes that yourworkspace will be organized like so
4
Anatomy of a Build File
Ants build files are written in XML

Convention is to call file build.xml
Each build file contains
A project
At least 1 target
Targets are composed of some number of tasks
Build files may also contain properties
Like macros in a make file
Comments are within  blocks
Projects
The project tag is used to define theproject you wish to work with
Projects tags typically contain 3 attributes
name a logical name for the project
default the default target to execute
basedir the base directory for which alloperations are done relative to
Additionally, a description for the projectcan be specified from within the project tag
Build File
<project name="Sample Project" default="compile" basedir=".">

<description>
A sample build file for this project
</description>
</project>
5
Properties
Build files may contain constants (knownas properties) to assign a value to avariable which
can then be usedthroughout the project
Makes maintaining large build files moremanageable
Projects can have a set of properties
Property tags consist of a name/value pair
Analogous to macros from make
Build File with Properties

<description>
</description>

<property name="source.dir" location="src"/>
<property name="build.dir" location="bin"/>
<property name="doc.dir" location="doc"/>
</project>
Targets
The target tag has the following required attribute

name the logical name for a target
Targets may also have optional attributes such as
depends a list of other target names for which this task is
dependant upon, the specified task(s) get executed first
description a description of what a target does
Like make files, targets in Ant can depend on some
number of other targets
For example, we might have a target to create a jarfile, which
first depends upon another target to compile the code
A build file may additionally specify a default target
6
Build File with Targets

...

<target name="init" description="setup project directories">
</target>

<target name="compile" depends="init" description="compile java sources">
</target>

<target name="doc" depends="init" description="generate documentation">
</target>

<target name="clean" description="tidy up the workspace">
</target>
</project>
Tasks
A task represents an action that needs execution

Tasks have a variable number of attributes which aretask dependant
There are a number of build-in tasks, most of which arethings which you would typically do
as part of a buildprocess
Create a directory
Compile java source code
Run the javadoc tool over some files
Create a jar file from a set of files
Remove files/directories
And many, many others
For a full list see: http://ant.apache.org/manual/coretasklist.html
Initialization Target & Tasks
Our initialization target creates the buildand documentation directories

The mkdir task creates a directory
...
<mkdirdir="${build.dir}"/>
<mkdirdir="${doc.dir}"/>
</target>
...
</project>
7
Compilation Target & Tasks
Our compilation target will compile all javafiles in the source directory
The javac task compiles sources into classes
Note the dependence on the init task
...

<javacsrcdir="${source.dir}" destdir="${build.dir}"/>
</target>
...
</project>
Javadoc Target & Tasks
Our documentation target will create theHTML documentation

The javadoc task generates HTMLdocumentation for all sources
...

<javadocsourcepath="${source.dir}" destdir="${doc.dir}"/>
</target>
...
</project>
8
Cleanup Target & Tasks
We can also use ant to tidy up ourworkspace

The delete task removes files/directories fromthe file system
...
<delete dir="${build.dir}"/>
<delete dir="${doc.dir}"/>
<delete>
<filesetdefaultexcludes="no" dir="${source.dir}" includes="**/*~"/>
</delete>
</target>
...
</project>

<description>
</description>

<property name="source.dir" location="src"/>
<property name="build.dir" location="bin"/>
<property name="doc.dir" location="doc"/>
<mkdirdir="${build.dir}"/>
<mkdirdir="${doc.dir}"/>
</target>

9

<javacsrcdir="${source.dir}" destdir="${build.dir}"/>
</target>


<javadocsourcepath="${source.dir}" destdir="${doc.dir}"/>
</target>
<delete dir="${build.dir}"/>
<delete dir="${doc.dir}"/>
<delete>
<filesetdefaultexcludes="no" dir="${source.dir}" includes="**/*~"/>
</delete>
</target>
</project>
Running Ant Command Line
Simply cd into the directory with the build.xml file

and type ant to run the project default target
Or, type ant followed by the name of a target
10
Running Ant Eclipse
Eclipse comes with out of thebox support for Ant

No need to separatelydownload and configure Ant
Eclipse provides an Ant view
Window Show View Ant
Simply drag and drop a buildfile into the Ant view, thendouble click the target to run
11
12
13

Ant PDF

Uploaded by

Copyright:

Available Formats

Ant PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Ant PDF

Uploaded by

Copyright:

Available Formats

JAVA Means DURGASOFT

Ant is a Java based tool for automating the buildprocess

Automating the Build (C & make)

The goal is to automate the build process

Set the ANT_HOME environment variable towhere you installed Ant

The following example assumes that yourworkspace will be organized like so

Anatomy of a Build File

Ants build files are written in XML

<project name="Sample Project" default="compile" basedir=".">

Build File with Properties

<project name="Sample Project" default="compile" basedir=".">

The target tag has the following required attribute

Build File with Targets

<project name="Sample Project" default="compile" basedir=".">

A task represents an action that needs execution

Initialization Target & Tasks

Our initialization target creates the buildand documentation directories

Compilation Target & Tasks

Javadoc Target & Tasks

Our documentation target will create theHTML documentation

Cleanup Target & Tasks

We can also use ant to tidy up ourworkspace

Completed Build File (1 of 2)

<project name="Sample Project" default="compile" basedir=".">

<target name="compile" depends="init" description="compile java sources">

Completed Build File (2 of 2)

Running Ant Command Line

Simply cd into the directory with the build.xml file

Running Ant Eclipse

Eclipse comes with out of thebox support for Ant

You might also like