Apache Ant

V konfiguračním souboru build.xml jsou pomocí tagu target definovány cíle, kterých má být v rámci procesu sestavení dosaženo. Každý cíl má svůj název a kromě toho může mít definován v atributu depends také seznam závislostí na dalších cílech, které musí být vykonány před ním. V kořenovém tagu project se v atributu default udává výchozí cíl, jenž bude zpracován v případě, že Antu explicitně neurčíme jiný.

Na příkladu uvedeném výše jsou definovány cíle init, compile, archive a clean. Jako výchozí je určen cíl archive a proto bude vykonán, neurčíme-li Antu jinak. Z definovaných závislostí vyplývá, že před ním musí proběhnout cíl compile. Kompilace se ale nemůže spustit, dokud není vykonán cíl init. Proto bude sestavování ukázkového projektu probíhat přesně v opačném pořadí. Nejprve se vykoná cíl init, následně compile a nakonec archive.

Ant dokáže samostatně zpracovat libovolný z definovaných cílů, ale vždy předtím zpracuje i jeho závislosti. Zavoláme-li ho s parametrem compile, zpracuje nejprve závislost init a poté zkompiluje třídy ukázkového projektu. Dalšími cíli se již zabývat nebude.

Pomocí tagu property lze nastavit konstanty a tím usnadnit parametrizaci nebo potenciální úpravy souboru konfigurace v build.xml. Takto je možné načítat i proměnné prostředí či externí soubory s definicí konstant. Vždy se jedná o konstanty v pravém slova smyslu. Jakmile se jednou nastaví, další pokusy změnu hodnoty jsou ignorovány. Této vlastnosti lze využít a nastavit některé konstanty pomocí parametrů při spouštění Antu – jejich další přenastavení v build.xml bude ignorováno.[3]

Pomocí definovaných konstant je možné také podmínit vykonání některého cíle. Do tagu target se přidá atribut if a nebo unless s hodnotou odpovídající jménu konstanty. Takový cíl je poté vykonán pouze, pokud je a nebo není daná konstanta definovaná.

V rámci jednotlivých cílů je možné používat řadu úkolů, v terminologii Antu označených výrazem task. Úkoly jsou zodpovědné za vykonávání specifických činností sestavovacího procesu. Jsou vykonávány postupně podle jejich pořadí v rámci cíle. Je možné se setkat se třemi typy úkolů.[4]

Prvním z nich jsou úkoly vestavěné v Antu. Je jich celá řada a pokrývají všechny běžné funkce od vytvoření nebo smazání adresáře, kompilace, generování dokumentace, vytváření jar archivu, vytváření nebo validaci XML dokumentů, spouštění unit testů, spouštění programu, práce s FTP serverem, odesílání emailu, a tak dále.

Další skupinu tvoří úkoly třetích stran. Množství doplňujících úkolů do Antu vytvořili jeho uživatelé a dali veřejně k dispozici ostatním.[4]

Pokud není požadovaná funkcionalita k dispozici ani v jedné z předchozích skupin, lze si naprogramovat úkoly vlastní, jelikož Ant obsahuje otevřené a dokumentované API. Stačí vytvořit potomka třídy org.apache.tools.ant.Task, překrýt jeho metodu execute a pro všechny atributy definovat set metody. Níže uvedený příklad ukazuje, jak lze vytvořit jednoduchý úkol. Jedinou jeho funkcí je vypsání zadaného parametru message. Funguje obdobně jako vestavěný úkol echo.

package org.sampleproject;

import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Task;

public class SampleTask extends Task {

 private String message;
 
 public void setMessage(String message) {
 this.message = message;
 }

 @Override
 public void execute() throws BuildException {
 super.execute();
 log(message);
 }
}

V konfiguračním souboru build.xml je ještě nutné úkol definovat pomocí tagu taskdef. Následně již nic nebrání jeho používání.

<taskdef name="sampletask" classname="org.sampleproject.SampleTask"
 classpath="build/classes" />
<sampletask message="Hello, World!"/>