Slashdot Mirror


Ant - The Definitive Guide

pankaj_kumar writes "Apache Ant, the Java replacement for make , belongs to the rare breed of category killer software for automating Java software development tasks. It is an Apache open source project, has won numerous awards, boasts comprehensive online documentation and is used by most Java developers. So, what could a book say that is already not available online?" Read on for Kumar's review of Ant: The Definitive Guide. Ant The Definitive Guide author Steve Holzner pages 316 publisher O'Reilly rating 8 reviewer Pankaj Kumar ISBN 0596006098 summary Complete Build Management for Java with Ant

As a long time Ant user, I have written many Ant build scripts, automating my builds and speeding up the overall development cycle, mostly relying on its excellent online documentation. As a Java developer, I have admired its simple and intuitive interface and the modular design. So on getting Ant: The Definitive Guide in my hands I wasn't expecting a whole lot new to learn, and thought of using it only as a reference book.

After having the book on my desk for more than a month, though, and occasionally flipping through its pages whenever I would otherwise have consulted the online documentation, I must say that I had been missing out on some very important things: tasks like ftp and war deployment that I was simply not aware of and had never felt the need to look up, but could very well use. The other interesting thing I noticed was that my build scripts became smaller, more modular and easier to read.

Like most books in the The Definitive Guide series, Ant The Definitive Guide assumes a certain level of familiarity with underlying technologies such as Java and XML and focuses on providing complete, reference like details of Ant features and tasks. These description are generously supplemented with examples and code fragments.

But so is the the online documentation for Ant! Will someone gain additional insight in using Ant, or be able to work faster, or make better use of Ant capabilities, by consulting this book, instead of the online documentation for a particular Ant task? To find the answer, I randomly picked two topics -- filesets, an important and oft-used Ant datatype, and javac, a core Ant task -- and compared their online description with the one in the book. Here is what I found.

Besides the datatype definition, explanation of various attributes, sub-elements, and the examples, the book also covers how to specify conditional inclusion or exclusion of certain filename patterns when a property is set (or unset). Though this can be inferred from online documentation by a determined user, this particular use is far from obvious. The coverage in the book also talks about the relationship of the fileset datatype with the javac task, pointing out that the fileset attribute dir is equivalent of javac attribute srcdir, as attribute dir will be confusing in javac: is it referring to source directory or destination directory. This is the kind of insight that really helps a user.

The treatment of the javac task in the book is not much different from the one in the online documentation. Both have almost the same material, though the information in the book is better organized for new users. On the other hand, I found the online documentation to be more complete, especially with respect to the compiler specific options and behavior idiosyncrasies.

Here is a rundown on what the book covers: Chapter 1, Getting Started is a quick primer on Ant, with sufficient details for a new user to start using Ant for very simple build tasks. Chapter 2, Using Properties and Types introduces the building block tasks and datatypes, such as property, condition, fileset, path like structures, selectors and so on, used in other Ant tasks. Chapter 3, Building Java Code covers the tasks and activities around compiling Java source files (ie; javac), organizing the build steps in various targets within a single build scripts and/or across multiple scripts, generating documentation using javadoc and creating distribution jars and zip files. The rest of the chapters are devoted to tasks for specific purposes, such as launching external programs (Chapter 7, Executing External Programs), copying files and manipulating directories either on the same machine or over the network (Chapter 4, Deploying Builds), running JUnit tests (Chapter 5, Testing Builds with JUnit) and so on. There are also separate chapters covering interaction of Ant with XML and XDoclet (Chapter 9, XML and XDoclet) and with Eclipse (Chapter 11, Integrating Ant with Eclipse). The last chapter, Chapter 12, Extending Ant, talks about extending Ant by doing things like adding your own tasks, creating custom filters, writing your own build listeners and loggers etc. This chapter also has a small section on how to embed a script written in one of the supported scripting languages within an Ant script.

As you can see from this outline, the book covers almost everything that is to know about Ant and other related software.

So, what is not so good about this book? Well, I didn't find anything wrong with the topics which are actually covered by the book. Of course, there are additional things that I would have liked to see in the book: (a) A good sample Ant script which could be used as the starting point for most small to medium-sized projects; (b) A more thorough explanation of how dependencies among targets determine the execution sequence and how this fits in with explicit invocation of targets; and (c) pictures to illustrate some of the concepts such as life cycle of an Ant task, selection of files in a fileset and the dependency tree of targets.

Overall, I found the book to be comprehensive, well organized, easy to read and good value for money.

You can purchase Ant: The Definitive Guide from bn.com. Slashdot welcomes readers' book reviews -- to see your own review here, read the book review guidelines, then visit the submission page.

37 of 205 comments (clear)

  1. Make file by alex323 · · Score: 2, Informative

    I like how the make file are XML based. With other makefiles, you get stuck if your tab has a space in it :/ Good review though!

    1. Re:Make file by Cryptnotic · · Score: 2, Informative

      I hated that about it. You can't make a file using just a text editor unless you want to break your fingers on the shift, < and > keys.

      --
      My other first post is car post.
    2. Re:Make file by truckaxle · · Score: 2, Insightful

      Whoever decided to use a tab as a delimiter should not be allowed to die a natural death. This "feature" has cause countless hours of loss productivity. At one time the make processor gave some obscure warning on the missing tab and left you scratching your head for hours.

    3. Re:Make file by Baki · · Score: 2, Insightful

      people should use a decent editor such as emacs. its make mode highlights the tabs so you can readily see what's up.

    4. Re:Make file by jarich · · Score: 2, Insightful
      Yeah, but I can ~see~ the missing angle brackets! And with proper indentation, matching in XML elements is trivial...

      Of course, most people I know who hate XML write their XML on a VERY long lines, with lots of elements jammed in together, and then they complain that it's hard to read.

    5. Re:Make file by codegen · · Score: 4, Informative

      Just like JCL(IBM's job control lanaguage). Read the New Hackers Dictionary description of JCL. An excerpt:

      "Most programmers confronted with JCL simply copy a working file (or card deck), changing the file names. Someone who actually understands and generates unique JCL is regarded with the mixed respect one gives to someone who memorizes the phone book"

      About sums up my opinion of ANT.

      --
      Atlas stands on the earth and carries the celestial sphere on his shoulders.
    6. Re:Make file by jarich · · Score: 2, Insightful

      Then I respectfully submit that you have very little experience JCL or Ant (or both).

  2. mwuhahahaha by sargosis · · Score: 3, Funny

    So, what could a book say that is already not available online?"

    Nothing, you have to read it.


    Sorry, i just had to...

    --
    for free wallpapers, visit Sargosis.com
  3. Ant life cycle... by op12 · · Score: 4, Funny

    So, what is not so good about this book?...Of course, there are additional things that I would have liked to see in the book: (c) pictures to illustrate some of the concepts such as life cycle of an Ant

    Here ya go:
    Life Cycle

  4. Re:Only two words necessary by puppetman · · Score: 2, Interesting

    I have a web service application that resides as a seperate module in CVS. I needed the ability to build a JAR, and move it either to local qa application servers, or a remote server.

    I thought I'd try Maven. After spending 4 hours looking for and reading what passes for documentation on the Apache site, I gave up, and wrote a batch script to do it in 15 minutes.

    The Apache docs suck for many of their projects (Tomcat, Maven, Axis). Do the developers do it on purpose so that they can make money writing books explaining the tools? I have no idea.

    To be fair, some Apache documentation is good (in the commons projects, like CLI and HttpClient).

  5. Bookpool has it cheaper than bn.com by COBOL/MVS · · Score: 3, Informative

    This book is cheaper at bookpool.com ($22.50) than at bn.com ($27.96 bn price/$25.16 member price). Get it there and save a few $$.

    --
    GOBACK.
  6. Necissity if you use Ant by Anonymous Coward · · Score: 2, Insightful

    I have worked on a couple products which have used ant as the build system. These were released a few years ago and I think the version was ant 1.3. The online doc at the time ~2002 was mediocre. I think it has gotten better now, but the book still covers all the basic features you will ever need and decreased our old make full build time from 30-40 minutes to about 10 with ant on the same hardware, as well as making it much easier to make changes and add new steps. When making minor changes ant will recompile and determine dependencies in just a few seconds where our make system would still take 5-10 minutes just for incremental change. Granted our make system could have been optimized, ant was a good excuse to start over. I have a paper copy, but do also use safari to search through the text. This gives you the best of being online and having the book.

  7. Frankly, I don't care about building Java. by david.given · · Score: 4, Interesting
    I want to build generic programs. Java, C, Pascal, Occam, COBOL, shell scripts. This is because the applications I need to build tend to be a mixture of various different paradigms: little tools that are built to produce data massagers that convert offline data into compilable data; metacompilers like yacc and bison; XML preprocessors like xslt; traditional C or C++; documentation builders like Javadoc or WEB... I can't find anything that will handle all this cleanly.

    Is there anything out there that is (a) easily deployable (nothing turns off a prospective user than being told to download and install a complicated build system that depends on $LANGUAGE_OF_THE_MOMENT), (b) suitably flexible that I can customise it to work with all my little build tools, and (c) sufficiently elegant that I won't want to vomit looking at my build scripts six months later?

    So far, the only thing I've found that works at all is traditional make. Which, I'm afraid, sucks. Makefiles scale very badly (recursive make. Eeeaah), don't handle disparate rulesets well (I want to build these C files with this rule and these with this other rule... oh, wait, I can't), and the dependency handling is practically nonexistent (you can fake to a certain extent with .d files, but that all falls apart as soon as you need to depend on dynamically made files).

    A case in point: I maintain the ACK, a portable compiler toolchain that's about 20 years old. The build system is an intricate network is shell scripts and recursive makefiles. It works, but it's largely incomprehensible, very slow, doesn't handle incremental rebuilds, and is going to be a maintenance nightmare should we ever need to do any major revamps. I'd love to replace it; I've gone out actively looking for something better --- and I've failed.

    Any suggestions?

    This has been a public service rant by a stressed build technician.

  8. Re:I know the moderators will tag me, but... by Decaff · · Score: 3, Insightful

    I know the moderators will hit me for this, but from the sys admins point of view - ant is evil!

    Ant isn't for sys admins.

    It is simply another build program to learn. The C and C++ stuff for the kernel is "make" - now I have to learn "ant" for Java programs.

    As Java isn't used (yet!) for kernel stuff, what is the problem?

    I am not against learning new things, but where some people see XML as a good thing - I think it sucks! I despise any time I see a config file that is XML. XML is for the "parsing impaired" - use a plain text file like everything in /etc !!!

    Sorry, wrong way around. XML was designed specifically from the start to be parser-friendly. There are very simple APIs which handle any XML file such as SAX. /etc is a very good example of what is wrong with plain text files - no single program or API could ever handle the range of formats of files there! Incidentally - XML IS plain text.

  9. SCons by Chmarr · · Score: 5, Informative

    If folk want something better than make, but don't want something so Java-centric. Have a look at SCons.

    The software, as well as the confuguration files, are actually Python. But, you won't notice until your build requirements get quite complex.

    Scons keeps track of dependencies using MD5sums on the tail nodes. This takes up a bit more processing time, but more than makes up for it with highly-parallelizable builds (SCons + distcc totally rocks), guaranteed correct builds (never do 'make clean' again!).

    We've just converted a project from Make to SCons, and it's cut our build time by about 40%. I might even be able to convince our java guys to try it out, too :) (Yes, SCons handles Java as well as C or C++).

    1. Re:SCons by Chmarr · · Score: 4, Insightful

      At this time, pretty damn solid. Yes, it's 'officially' beta, but they're just polishing the edges now.

      The only problems I've run into so far relate to SCons being a little too clever for it's own good, and not 'neatly' letting me do things that make could do. I worked around them, once I understood SCons better

      For example, SCons lets you generate static and shareable objects using 'StaticObject' and 'SharedObject', and will 'do what's necessary' to make that work on your platform. Eg, under *nix, it will add '-fpic' to SharedObject. It will also refuse to let you add a StaticObject into a SharedLibrary. Which in most cases is just what you'd want to stop happening, but... if you KNOW that in a particular case it will work, then SCons is getting in the way. Eg, we wanted a .a full of .so files that were compiled with -fpic, and then add that whole .a into a .so. Perfectly valid, but odd, and SCon's structure didn't let us do that easily.

      But... there's workarounds and they all 'make sense', but require a little more SCons knowledge. The mailing list is quite active and helpful, though.

      If your project is straightforward (even if it's HUGE), then there's no problems at all.

    2. Re:SCons by Chmarr · · Score: 3, Informative

      I glossed over some of the features, and reasons for them, so let me explain.

      The 'md5sum' thing ensures that you're not relying on timestamps. Especially important if you're dealing with several machines that might not have their clocks synchronised perfectly. Furthermore, the 'signature' of any of the build nodes is the concatenation of the MD5s of all it's dependencies, PLUS the command lines to generate that node. Change ANY one of those, including changing any compiler flag, and the signature doesn't match, and the node gets rebuilt.

      SCons does its own inherent dependency checking, and caches that, too, plus recording the signatures of all the files needed to generate that information. If any of THAT changes, it will re-get dependencies, and then use the result to determine if a node needs to be rebuilt. This, plus the previous part, makes 'make depend' unnecessary. SCons always gets it right, which cannot be said for Make, or (I think) even Ant... (We currently DO have problems with Ant after a 'cvs update'.). I'm pretty sure that you can make your '.depend' files depend on the files that were used to generate it, but the solution for that for Make (unsure for Ant), is UGLY. SCons handles it all automatically.

      SCons also handles cross-platform builds. It's actively tested under *nix and Windows.

      Really, if any product deserves to be called a 'category killer' for this category, it isn't Ant, it's SCons.

  10. Re:Ant does the job... by Decaff · · Score: 4, Informative

    Oh... And I can use make and a Makefile to compile C code and the Java code of the same project.

    If you understood Ant, you would know that it can do this as well.

  11. Re:GUI by madth3 · · Score: 4, Informative

    A graphical aproach I've seen to handle ant scripts is done by NetBeans. Starting with version 4 all the project management is ant-based and you can add targets and parameters from the IDE.
    Last time I used it the paths were added as absolute paths so I continued editing my scripts by hand, though.

  12. Re:GUI by Reverend528 · · Score: 2, Insightful
    Well, contrary to popular belief, XML wasn't really meant to be directly edited by humans. Large nested structures become exceptionally difficult to read and there's not really a clear way to break them down into smaller abstract parts. Not to mention, it's a rather verbose language (compared to something like lisp which has a nearly identical structure with half as much syntax).

    If there isn't a GUI for editing ant files, there really should be.

  13. Re:Ant does the job... by Lothsahn · · Score: 3, Informative

    The best thing about using make and a Makefile instead of Ant is that I don't need to read books like this.

    You don't need to learn make from books because you already know it, and if you knew ant, you wouldn't need to read books like this either.
    Even if you didn't know ant, the online documentation is sufficient. That is how I learned ant.

    --
    -=Lothsahn=-
  14. JUnit? by FranTaylor · · Score: 2, Interesting
    One of the nicer features of ant, one that doesn't seem to be mentioned, is its JUnit integration. There is a very JUnit reporting mechanism built into ant. It wasn't exactly what I wanted, but with a fairly small modification (superclassing, no actual code mods) I was able to get it to work just as I wanted it to.


    Hey, make fiends, try this: add new functionality to make, extending its syntax. PITA, you say. It's very simple with ant.

  15. Additional Ant Goodies by Robotron2084 · · Score: 3, Informative

    This book is also available online at O'Reilly's Safari site.

    Also, although Ant is used mainly to build Java, it is NOT java-centric. It can be used to compile any language.

  16. Forgive my ignorance... by Kr3m3Puff · · Score: 3, Interesting

    Can someone explain to me the difference between Ant and Maven? I have noticed almost everyone supports Ant, but there are people who also do Maven. Are there any advantages, disadvantages, are the different but overlap greatly, and why does Apache support what appears to me to be two competitive technologies...

    Very confusing to someone who just has a high-level understanding of Apache world.

    --
    D.O.U.O.S.V.A.V.V.M.
    1. Re:Forgive my ignorance... by Bj�rn · · Score: 2, Informative
      Here are two URLs that explain Maven better than I can:

      Basically Maven is an extra layer on top of Ant. Or another way of putting it is that Maven is way to program Ant in an XML based language called Jelly. Maven has the concept of repositories and versions, so that you can say that a particular jar file requires specific versions of other jar files in the repository. If you find yourself writing a lot of similar Ant code, Maven is definitely worth a look. It takes a little while to get into, but once you do it is fairly straight forward.

      --
      Never express yourself more clearly than you are able to think. --Niels Bohr
    2. Re:Forgive my ignorance... by BigTimOBrien · · Score: 3, Informative

      Maven sits at a higher level than Ant, where Ant is really just a system for defining targets and dependencies between targets, Maven abstracts build logic across all project by way of plugins. So, instead of telling your 10 separate web application projects how to compile, test, and generate a WAR file, you simply describe each project in a common Project Object Model (POM), you then invoke something like the WAR plug-in, which takes your project's model and generates a WAR file. Long story short, in Ant you need to give each project explicit instructions for every task in your build.xml file. In Maven, you rely on common logic shared by all projects.

      Confusing? Well it's not something you should rush into. IF you would like more information about Maven, take a look at Maven: A Developer's Notebook, Vincent Massol and I just finished this bok in March of this year and it was released last month. It is a good introduction to Maven.

      And, if you were wondering, the developers are doing a better job at project documentation for Maven 2.0. It is shaping up well.

      --
      ------ Tim O'Brien
  17. Re:Only two words necessary by Anonymous Coward · · Score: 2, Informative

    Maven has serious issues as eloquently explained by Hani. Be sure to check out his newest article on mergere, the company that attempts to support maven.

  18. Does it apply to NAnt too? by Space_Soldier · · Score: 2, Interesting

    There is a port of Ant to .NET available from here. It had a great following until MS announced MSBuild. Unfortunetly, MS put RIP on it when they created MSBuild, which comes with .NET. Visual Studio project files are MSBuild files.

  19. My gripes about ant by demilurker · · Score: 2, Insightful

    1. The pulling teeth part! You need to use the 3rd party ant-contrib package to even get basic if-else and for loop functionality. And even then, since it's XML, you end up with crap like this:

    <if>
    <equals arg1="${foo}" arg2="bar"/>
    <then>
    <property name="bat" value="barf"/>
    </then>
    </if>

    ... give me a break.

    What I'm always hoping for is a build system that is just a perl / python library, so I can write the build script in a real language and call the build system when I want to.

    2. Ant's simplistic rebuild-on-file-mod way of doing things misses things. Say class A.java calls class B.java. You build and all is well. Then you change B.java's interface, but not where it is called in A.java. By right your build should break now, but ant only rebuilds B.java, because it's file mod time is updated; it does no analysis of what depends on it and should be rebuilt. So you run the program and if that line of code gets called you get a NoSuchMethodError, examine that stack trace, and manually delete the .class file or somesuch. What ant needs is something like what gcc -M does for make.

    ... hey, I use it, but it's the year 2005 for crying out loud.

  20. Ant is simply not a Make replacement by Zenin · · Score: 3, Insightful

    I know Make. Make is a friend of mine. Ant is no Make.

    Ant can automate Java builds slightly better then a .bat or shell script...but that's sadly about where it ends.

    The major problem is that Ant has no built in dependancy system. Dependant tasks don't count as they have no targets and thus nothing to check for dependancies. All real dependancy checking in Ant is embedded in the Ant task code...which varies task to task and worse yet has little to no documentation (not even documented to be taking place or not!). Examples are javac, zip, copy tasks.

    Ant + Javamake gets closer to a Make replacement, but not completely.

    But really, to be accurate Ant is a portable .bat/shellscript replacement...and that's it. Claiming it is a legit replacement for Make is to completely misunderstand what Make actually is and does. That doesn't mean Ant isn't useful, it is, but it is no Make.

    --
    My /. uid is better then your /. uid
    1. Re:Ant is simply not a Make replacement by ebuck · · Score: 2, Informative

      Ant does have a dependset task and an uptodate task for explicitly defining dependencies, in addition it has the condition task to bind several dependencies together in a logical manner.

      But still, ant is no make. It's not ant's fault, but more a fault of the underlying reason that make is both powerful and problematic. Make leverages the power of it's shell and all the utilities that have been written explicitly to make shell scripting possible. Make (by itself) doesn't do a lot except call a bunch of programs using a reverse-chaining algorthim. It's the value of all those shell programs that give make it's lifting power.

      Ant can call a platform's shell programs too, but then you run into difficulties in communicating rich information between the programs, and ant becomes just a funny, XML configured, JAVA version of make. That's why ant's logging capabilites far outstrip those of make, because it's logging facility can differentiate between errors, warnings, and informational messages, routing them to text files, xml files, databases, and web pages.

  21. Ant is a Misapplication of Technology by aldheorte · · Score: 3, Insightful

    It has been a source of constant dismay to me that something has not arisen to replace Ant in for Java builds. The Ant project has created a terrific mess where people essentially *program in XML*. XML is a set of data structure markup semantics, not a programming language. No potential of repurposing ant build files exists, another knock against using XML. Therefore, from a software architecture perspective, Ant is one of the biggest misapplications of technology I have seen to date and despite that, staggeringly popular. I rest my case and shake my head.

    1. Re:Ant is a Misapplication of Technology by holloway · · Score: 2, Interesting
      Dude, you're wrong. As far as appropriate uses of XML goes who do you think would be the authority on that? The W3C who created XML? James Clark? Dave Pawson? People from SGML?

      The answer is that all of these groups and people created a XSLT - a functional XML programming language. That's right, the people who produce the XML spec also produced an XML programming language, just like Ant.

      XML is a meta-markup language, a series of rules, and you can represent data files as much as you can represent programming languages because they're all text files. You may as well say MAKE scripts are also a misuse of technology, being ASCII, if you're going to claim that ASCII should only be used for configuration files.

      With constructs that can be compiled who's to say XML can't be a programming language? The W3C say that depending on the domain it can be, and they disagree with you.

  22. Re:Basically by Karma+Farmer · · Score: 3, Funny

    Make is for C programmers,

    Ant is for Java programmers,

    Maven is for idiots.

  23. Re:Kumar? by frodo+from+middle+ea · · Score: 2, Informative
    Well in Hindi , or any Indian language, it means, "the young one", which can mean either young, or more exotically a virgin (male).

    Some how I think most /. would better associate with the later meaning of the word.

    --
    for the last time people, I am "frodo from middle eaRTH", not "middle eaST".
  24. Re:I completely agree by jag164 · · Score: 2, Interesting
    Oh goodness yes. We use ant and cpptasks in a modularized product of about 600 files, consisting of various shared/static libs, unit tests, and execs. With some work, it plugs into eclipse's CDT too. Simply automates doxygen builds, and rpm builds. Oh yeah, a few modules have to be cross platform so the same build.xml works on XP and MSVC7 with those targets. All this in about a five hundred line build.xml file that took about 3 hours to initially setup and 5 minutes here and there to maintain.

    Good stuff...

  25. Re:GUI by Decaff · · Score: 3, Insightful

    [Doesnt eclipse use Ant for its builds? ]

    No, it doesn't (Thank God!). You're thinking of netbeans.


    Why 'thank God'? Why should internal use of Ant be a problem? On the contrary, it has major advantages: It means you can build the project outside of the IDE, and it means that the IDE can make use of just about any Java tool, as almost all of them provide functionality as Ant tasks. Compare this to eclipse, where you need to install plug-ins.