Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<p>There are several approaches to compiling Groovy code in your Maven projects.  <a href="http://docs.codehaus.org/display/GMAVEN/Home">GMaven</a> is the most flexible and feature rich, but it has some difficulties with joint Java-Groovy projects and it is no longer under active development.  The <a class="confluence-link" href="/display/GROOVY/Groovy-Eclipse+compiler+plugin+for+Maven" data-linked-resource-id="193888332" data-linked-resource-type="page" data-linked-resource-default-alias="Groovy-Eclipse compiler plugin for Maven" data-base-url="http://docs.codehaus.org">Groovy-Eclipse compiler plugin for Maven</a> sidesteps the joint compilation issues.  Read <a class="confluence-link" href="/display/GROOVY/Groovy-Eclipse+compiler+plugin+for+Maven" data-linked-resource-id="193888332" data-linked-resource-type="page" data-linked-resource-default-alias="Groovy-Eclipse compiler plugin for Maven" data-base-url="http://docs.codehaus.org">this page</a> for a deeper discussion of the benefits and disadvantages of the two approaches.</p>

<p>A third approach is to use Maven's Ant plugin to compile a groovy project. Note that the Ant plugin is bound to the compile and test-compile phases of the build in the example below. It will be invoked during these phases and the contained tasks will be carried out which runs the Groovy compiler over the source and test directories. The resulting Java classes will coexist with and be treated like any standard Java classes compiled from Java source and will appear no different to the JRE, or the JUnit runtime.</p>
<table class="wysiwyg-macro" data-macro-name="code" data-macro-default-parameter="xml" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6eG1sfQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
&lt;project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
    &lt;modelVersion>4.0.0&lt;/modelVersion>
    &lt;groupId>com.mycomp.MyGroovy&lt;/groupId>
    &lt;artifactId>MyGroovy&lt;/artifactId>
    &lt;packaging>jar&lt;/packaging>
    &lt;version>1.0-SNAPSHOT&lt;/version>
    &lt;name>Maven Example building a Groovy project&lt;/name>
    &lt;dependencies>
        &lt;dependency>
            &lt;groupId>junit&lt;/groupId>
            &lt;artifactId>junit&lt;/artifactId>
            &lt;version>3.8.1&lt;/version>
            &lt;scope>test&lt;/scope>
        &lt;/dependency>
        &lt;dependency>
            &lt;groupId>groovy&lt;/groupId>
            &lt;artifactId>groovy-all-1.0-jsr&lt;/artifactId>
            &lt;version>05&lt;/version>
        &lt;/dependency>
    &lt;/dependencies>
    &lt;build>
        &lt;plugins>
            &lt;plugin>
                &lt;artifactId>maven-antrun-plugin&lt;/artifactId>
                &lt;executions>
                    &lt;execution&gt;
                        &lt;id>compile&lt;/id>
                        &lt;phase>compile&lt;/phase>
                        &lt;configuration>
                            &lt;tasks>
                                &lt;mkdir dir="${basedir}/src/main/groovy"/>
                                &lt;taskdef name="groovyc"
                                    classname="org.codehaus.groovy.ant.Groovyc">
                                    &lt;classpath refid="maven.compile.classpath"/>
                                &lt;/taskdef>
                                &lt;mkdir dir="${project.build.outputDirectory}"/>
                                &lt;groovyc destdir="${project.build.outputDirectory}"
                                    srcdir="${basedir}/src/main/groovy/" listfiles="true">
                                    &lt;classpath refid="maven.compile.classpath"/>
                                &lt;/groovyc>
                            &lt;/tasks>
                        &lt;/configuration>
                        &lt;goals>
                            &lt;goal>run&lt;/goal>
                        &lt;/goals>
                    &lt;/execution>
                    &lt;execution>
                        &lt;id>test-compile&lt;/id>
                        &lt;phase>test-compile&lt;/phase>
                        &lt;configuration>
                            &lt;tasks>
                                &lt;mkdir dir="${basedir}/src/test/groovy"/>
                                &lt;taskdef name="groovyc"
                                    classname="org.codehaus.groovy.ant.Groovyc">
                                    &lt;classpath refid="maven.test.classpath"/>
                                &lt;/taskdef>
                                &lt;mkdir dir="${project.build.testOutputDirectory}"/>
                                &lt;groovyc destdir="${project.build.testOutputDirectory}"
                                    srcdir="${basedir}/src/test/groovy/" listfiles="true">
                                    &lt;classpath refid="maven.test.classpath"/>
                                &lt;/groovyc>
                            &lt;/tasks>
                        &lt;/configuration>
                        &lt;goals>
                            &lt;goal>run&lt;/goal>
                        &lt;/goals>
                    &lt;/execution>
                &lt;/executions>
            &lt;/plugin>
        &lt;/plugins>
    &lt;/build>
&lt;/project>
</pre></td></tr></table>
<p>This assumes you have a Maven project setup with &quot;groovy&quot; subfolders as peers to the java src and test subfolders. You can use the java/jar archetype to set this up then rename the java folders to groovy or keep the java folders and just create groovy peer folders. There exists, also a groovy plugin which has not been tested or used in production. After defining the build section as in the above example, you can invoke the typical Maven build phases normally. For example, &quot;mvn test&quot; will execute the test phase, compiling Groovy source and Groovy test source and finally executing the unit tests. If you run &quot;mvn jar&quot; it will execute the jar phase bundling up all of your compiled production classes into a jar after all of the unit tests pass. For more detail on Maven build phases consult the Maven2 documentation.</p>