Skip to end of metadata
Go to start of metadata

You can write normal Java servlets in Groovy (i.e. Groovlets).
There is also a GroovyServlet

This feature will automatically compile your .groovy source files, turn them into bytecode, load the Class and cache it until you change the source file.

Here's a simple example to show you the kind of thing you can do from a Groovlet.
Notice the use of implicit variables to access the session, output & request. Also notice that this is more like a script as it doesn't have a class wrapper.

Or, do the same thing using MarkupBuilder:

Implicit variables

The following variables are ready for use in Groovlets:

variable name

bound to










unlike Struts



unlike Struts



can be null! see (star) A



a Map object



a Map object



see (star) B



see (star) B


new MarkupBuilder(out)

see (star) B

jsonnew StreamingJsonBuilder(out)see (star) B

(star) A The session variable is only set, if there was already a session object. See the 'if (session == null)' checks in the examples above.

(star) B These variables cannot be re-assigned inside a Groovlet. They are bound on first access, allowing to e.g. calling methods on the 'response' object before using 'out'.

Setting up groovylets

Put the following in your web.xml:

Then all the groovy jar files into WEB-INF/lib. You should only need to put the groovy.jar, the antlr.jar and the asm.jar. Or copy the groovy-all-xyz.jar into WEB-INF/lib - this almost all jar contains the antlr and asm jars.
Now put the .groovy files in, say, the root directory (i.e. where you would put your html files). The groovy servlet takes care of compiling the .groovy files.

So for example using tomcat you could edit tomcat/conf/server.xml like so:

Then access it with http://localhost:8080/groovy/hello.groovy

  • No labels


  1. I would like the addition of another implicit variable:

    binding, which maps to ServletBinding.getVariables()

    This will enable fancy stuff like:

    String id = 56775;
    String name = "Tonisha"

    // a hibernate hql with named parameters...
    hqlquery = new hqlquery("SELECT * FROM SomeTable WHERE Name=:name AND Id=:id")

    // get list of parameters
    namedPs = hqlquery.getNamedParameters()

    // iterate through and assign from binding...
    for (int i=0; i < namedPs.size(); i++)

    So, as variables are declared in the script and placed into the binding's variable map, they can be looked up from the same Groovlet via map syntax for stuff like above

  2. When printling from closures, you need to use out.println

    [1,2].each { println it } will print to stdout
    [1,2].each { out.println it } will print to the (HTTP) response stream

  3. "binding" is named "this".

  4. I would like the addition URL parameters as implicit variable:

    for example: Groovlets?showComments=true&showCommentArea=true

    in java ,


    in groovlet

  5. binding named this (thumbs up) 。 this is better than in。 this=Attributes=Parameters

  6. It would be great if the "html" binding was simply called "builder" and it was bound to the appropriate builder to serve the response based on what is requested in the header. Then the same groovlet could serve both XML and JSON for example.