Apache Ant
De Wikipedia, la enciclopedia libre
 |
Este artículo o sección debería estar en Wikilibros ya que es una guía o manual en vez de un verdadero artículo enciclopédico. [ver página en Wikilibros] Si modificas este artículo dándole una orientación enciclopédica, elimina por favor esta plantilla. |
Apache Ant es una herramienta usada en programación para la realización de tareas mecánicas y repetitivas, normalmente durante la fase de compilador|compilación y construcción (build). Es similar a Make pero sin las engorrosas dependencias del sistema operativo.
Esta herramienta, hecha en Lenguaje de programación Java, tiene la ventaja de no depender de las órdenes de Intérprete de comandos|shell de cada sistema operativo, sino que se basa en archivos de configuración XML y clases Java para la realización de las distintas tareas, siendo idónea como solución multi-plataforma.
Contenido |
[editar] Historia
ANT fue creado por James Duncan Davidson mientras realizaba la transformación de un proyecto de Sun Microsystems en Open Source (concretamente la implementación de Servlets y JSP de Sun que luego se llamaría Jakarta Tomcat). En un entorno cerrado Make funcionaba correctamente bajo plataforma Solaris, pero para el entorno de open source, donde no era posible determinar la plataforma bajo la que se iba a compilar, era necesaria otra forma de trabajar. Así nació Ant como un simple intérprete que cogía un archivo XML para compilar Tomcat independientemente de la plataforma sobre la que operaba. A partir de este punto la herramienta fue adoptando nuevas funcionalidades y actualmente es un estándar en el mundo Java.
[editar] ¿Qué se necesita para ejecutar ANT?
Para utilizar ANT basta con disponer de una distribución binaria de ANT y tener instalado la versión 1.4 o superior del JDK. La distribución binaria consiste en la siguiente estructura de directorios:
ant
+--- bin // contains launcher scripts
|
+--- lib // contains Ant jars plus necessary dependencies
|
+--- docs // contains documentation
| +--- ant2 // a brief description of ant2 requirements
| |
| +--- images // various logos for html documentation
| |
| +--- manual // Ant documentation (a must read ;-)
|
+--- etc // contains xsl goodies to:
// - create an enhanced report from xml output of various tasks.
// - migrate your build files and get rid of 'deprecated' warning
// - ... and more ;-)
solo se necesitan los directorio bin y lib para ejecutar ANT.
[editar] Configuración
Una vez obtenida la anterior distribución de ANT, se deben seguir los siguientes pasos:
- Añadir el directorio bin al path. - Asignar a la variable de entorno ANT_HOME la ruta donde se ha instalado ANT. - Opcionalmente, asignar a la variable de entorno JAVA_HOME la ruta donde se ha instalado el JDK.
Dependiendo del sistema operativo en el que nos encontremos tendremos los siguientes ejemplos de configuración:
Windows and OS/2
(Suponiendo que se ha instalado ANT en c:\ant\)
set ANT_HOME=c:\ant
set JAVA_HOME=c:\jdk1.2.2
set PATH=%PATH%;%ANT_HOME%\bin
Unix (bash)
(Suponiendo que se ha instalado ANT en /usr/local/ant)
export ANT_HOME=/usr/local/ant
export JAVA_HOME=/usr/local/jdk-1.2.2
export PATH=${PATH}:${ANT_HOME}/bin
[editar] Limitaciones
- Al ser una herramienta basada en XML, los archivos Ant deben ser escritos en XML. Esto es no sólo una barrera para los nuevos usuarios, sino también un problema en los proyectos muy grandes, cuando se construyen archivos muy grandes y complejos. Esto quizá sea un problema común a todos los lenguajes XML, pero la granularidad de las tareas de Ant (comparado con Maven, por decir alguno), significa que los problemas de escalabilidad llegan pronto.
- La mayoría de las antiguas herramientas — las que se usan todos los días, como <javac>, <exec> y <java> — tienen malas configuraciones por defecto, valores para opciones que no son coherentes con las tareas más recientes. Ésta es la maldición de la compatibilidad hacia atrás: cambiar estos valores supone estropear las herramientas existentes.
- Cuando se expanden las propiedades en una cadena o un elemento de texto, las propiedades no definidas no son planteadas como error, sino que se dejan como una referencia sin expandir (ej.: ${unassigned.property}). De nuevo, ésta es una cuestión de la compatibilidad hacia atrás, incluso se reconoce que tener la herramienta desactivada es normalmente la mejor opción, al menos hasta el punto que el mítico producto "Ant2.0" falle en propiedades no asignadas.
- No es un lenguaje para un flujo de trabajo general, y no debería ser usado como tal. En particular, tiene reglas de manejo de errores limitadas, y no tiene persistencia de estado, así que no puede ser usado con confianza para manejar una construcción de varios días.
Unix (csh)
setenv ANT_HOME /usr/local/ant
setenv JAVA_HOME /usr/local/jdk-1.2.2
set path=( $path $ANT_HOME/bin )
[editar] Estructura de un fichero build.xml
Los ficheros buildfiles de ANT están escritos en XML. Cada buildfile contiene un proyecto (project) y al menos un objetivo (target). Cada objetivo puede contener varias tareas (task) que son fragmentos de código a ejecutar. Un proyecto, además, puede constar de diversas propiedades. Cada propiedad consta de nombre y valor y son usadas para asignar valores a los atributos de los task.
La estructura de un fichero buildfile podría ser la siguiente:
buildfile
+--- project // proyecto del buildfile
+
+--- property_1
+--- property_2
+--- target_1 // objetivo_1
| |
| +--- task_1 // tarea 1 de target_1
|
+--- target_2 // objetivo_2
| |
| +--- task_1 // tarea 1 de target_2
| +--- task_2 // tarea 2 de target_2
|
+--- target_3 // objetivo_3
|
+--- task_1 // tarea 1 de target_3
[editar] Ejemplo de buildfile
A continuación se muestra un ejemplo de un archivo build.xml:
<project name="MyProject" default="dist" basedir=".">
<description>
simple example build file
</description>
<property name="src" location="src"/>
<property name="build" location="build"/>
<property name="dist" location="dist"/>
<target name="init">
<tstamp/>
<mkdir dir="${build}"/>
</target>
<target name="compile" depends="init" description="compile the source " >
<javac srcdir="${src}" destdir="${build}"/>
</target>
<target name="dist" depends="compile" description="generate the distribution" >
<mkdir dir="${dist}/lib"/>
<jar jarfile="${dist}/lib/MyProject-${DSTAMP}.jar" basedir="${build}"/>
</target>
<target name="clean" description="clean up" >
<delete dir="${build}"/>
<delete dir="${dist}"/>
</target>
</project>
La primera línea se corresponde con el proyecto que compone el buildfile, en ella pueden aparecer los siguientes atributos:
- name = "MyProject": identifica el nombre del proyecto - default = "dist": identifica el objetivo que se ejecuta por defecto, en caso de no especificarle uno en concreto. - basedir = ".": directorio base sobre el que vamos a trabajar. En este ejemplo se trabajaría sobre el directorio actual.
A continuación aparecen un listado de propiedades, su declaración se compone del literal property y los atributos name para especificar el nombre y location para asignarles un valor.
<property name="src" location="src"/>
Lo siguiente que aparece en el ejemplo son los objetivos. El primero de ellos es init:
<target name="init">
<tstamp/>
<mkdir dir="${build}"/>
</target>
Como se mencionó anteriormente, un objetivo esta compuesto por una o varias tareas, en este caso tenemos las tareas tstamp y mkdir, las cuales muestran la fecha y crean el directorio descrito por la propiedad build respectivamente.
El siguiente objetivo que aparece es compile
<target name="compile" depends="init" description="compile the source " >
<javac srcdir="${src}" destdir="${build}"/>
</target>
En la declaración del objetivo podemos ver los siguiente atributos:
- name = "compile": identifica el nombre del objetivo - depends = "init": identifica el objetivo que se debe ejecutar antes de lanzarse el actual. En este caso se debe ejecutar previamente el objetivo init (mostrar la fecha del sistema y crear un directorio) antes de ejecutar este objetivo. - description = "compile the sou": breve descripción de lo que hace el objetivo.
El cuerpo del objetivo está formado por la tarea javac, que toma los ficheros fuente ubicados en la ruta indicada por el atributo srcdir y los compila en destdir.
El siguiente objetivo que compone el buildfile es dist.
<target name="dist" depends="compile" description="generate the distribution" >
<mkdir dir="${dist}/lib"/>
<jar jarfile="${dist}/lib/MyProject-${DSTAMP}.jar" basedir="${build}"/>
</target>
En este caso, dist depende del objetivo compile para ejecutarse, luego, antes de lanzar sus tareas se debe haber ejecutado compile. En este objetivo aparece la tarea mkdir descrita anteriormente y jar, esta tarea construye un jar con el nombre MyProject concatenado con la fecha del sistema (DSTAMP) a partir de los compilados en el directorio indicado por la propiedad build.
Por ultimo tenemos el objetivo clean
<target name="clean" description="clean up" >
<delete dir="${build}"/>
<delete dir="${dist}"/>
</target>
Compuesto por 2 tareas delete. Simplemente borra los directorios temporales necesarios para la creación del jar.
Si repasamos la cabecera del proyecto, vemos que por defecto llama al objetivo dist, el cual depende de compile y este a su vez de init, por lo que el orden lógico de ejecución de este build.xml es:
Ejecutar objetivo init - mostrar fecha de sistema - crear directorio build
Ejecutar objetivo compile - compilar fuentes de src y guardarlos en build
Ejecutar objetivo dist - crear directorio lib - crear jar a partir de los compilados
El objetivo clean no depende del resto y tampoco se especifica en la cabecera del proyecto, por lo que se debe referenciar de forma explicita en la línea de comandos para que se ejecute.
[editar] Ejemplo de Hola Mundo
[editar] Fichero de ejemplo build.xml
Debajo se muestra un archivo de ejemplo (build.xml) para una aplicación "Hola mundo" en Java. El archivo define tres objetivos - clean, compile y jar, cada uno de los cuales tiene una descripción asociada. El objetivo jar lista el objetivo compile como dependencia. Esto le dice a ANT que, antes de empezar el objetivo jar, debe completar el objetivo compile.
Dentro de cada objetivo están las acciones que debe tomar ANT para construir el objetivo. Por ejemplo, para construir el objetivo compile ANT debe primero crear un directorio llamado classes (ANT sólo lo hará si éste no existe previamente) y luego llamar al compilador de Java.
<?xml version="1.0"?>
<project name="Hello" default="compile">
<target name="clean" description="borrar archivos temporales">
<delete dir="classes" />
</target>
<target name="compile"
description="compilar el código java a un archivo class">
<mkdir dir="classes" />
<javac srcdir="." destdir="classes" />
</target>
<target name="jar" depends="compile"
description="crear un archivo Jar para la aplicación">
<jar destfile="hello.jar">
<fileset dir="classes" includes="**/*.class" />
<manifest>
<attribute name="Main-Class" value="HelloProgram" />
</manifest>
</jar>
</target>
</project>
[editar] Ejecución de ANT
Para ejecutar ANT basta con escribir ant en la línea de comandos. Si se ha especificado la ejecución de un objetivo por defecto en la cabecera del proyecto del fichero build.xml no es necesario el uso de ningún parámetro ya que, como acabamos de ver en el ejemplo anterior, se ejecutara este por defecto. Para utilizar un buildfile diferente de build.xml hay que añadir el parámetro -buildfile nombre_fichero, donde nombre_fichero es el buildfile que se quiere utilizar:
ant -buildfile buildfile_alt.xml
Si se desea ejecutar uno o varios objetivos concretos, se debe añadir el nombre de este o estos objetivos en la línea de comandos vv:
ant clean
En este caso se ignorara el objetivo indicado en la cabecera del proyecto.
[editar] Portabilidad
Una de las primeras ayudas de Ant fue solucionar los problemas de portabilidad de Make. En un Makefile las acciones necesarias para crear un objetivo se especifican como órdenes de Intérprete de comandos que son específicos de la plataforma, normalmente un shell de Unix. Ant resuelve este problema proveyendo una gran cantidad de funcionalidades por él mismo, que pueden garantizar que permanecerán (casi) idénticas en todas las plataformas.
Por ejemplo, en el ejemplo build.xml debajo del objetivo clean borra el directorio classes y todo su contenido. En un Makefile esto normalmente se haría con la orden:
rm -rf classes/
rm es una orden específica de Unix que probablemente no estará disponible si el Makefile se usa en un entorno no Unix como Microsoft Windows. En un archivo de construcción Ant se puede conseguir lo mismo usando una orden propia:
<delete dir="classes" />
Una discrepancia común entre diferentes plataformas es la manera en que las rutas de directorios se especifican. Unix usa la barra (/) para delimitar los componentes de una ruta, mientras que Windows usa la barra invertida (\). Los archivos de Ant permiten al autor elegir su convención favorita, barras o barras invertidas para directorios, comas o punto y coma para separar rutas. Ant lo convierte todo al formato apropiado para la plataforma actual.
[editar] Referencias
Para ampliar conocimientos en el uso de ANT, podéis consultar el siguiente enlace:
[editar] Enlaces externos
- Página oficial del proyecto Apache Ant
- Manual de usuario de Apache Ant (en inglés)
- Manual de usuario de Ant-Contrib, con extensiones para compilar C++ (en inglés)
- Primeros pasos con Apache Ant (español)
- Tutorial completo sobre Ant (español)
