Maven支持java与groovy混排

最新推荐文章于 2025-03-14 08:26:30 发布

原创最新推荐文章于 2025-03-14 08:26:30 发布 · 2k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#maven #groovy #java #lombok

原创专栏收录该内容

2 篇文章

订阅专栏

本文介绍了如何在Maven项目中同时支持Java和Groovy类的混排，确保代码编译顺利。通过更换maven-compiler-plugin的编译器为groovy-eclipse-compiler，解决了与Lombok的不兼容问题，实现了Groovy和Java代码的无缝编译。

目标

实现在src/main/java目录下可以无差别的创建java class和groovy class。代码编写和编译跟目录下只有java代码的感觉是一致的。

实现

基于maven编译java代码，一般都是使用maven-compiler-plugin插件。

<plugin>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.3</version>
    <configuration>
        <source>1.8</source>
        <target>1.8</target>
        <encoding>UTF-8</encoding>
    </configuration>
</plugin>

maven-compiler-plugin默认使用的是javac编译器，即plexus-compiler-javac。Apache官方还提供了其他的编译器，如下：

aspectj with artifactId plexus-compiler-aspectj.
csharp with artifactId plexus-compiler-csharp.
eclipse with artifactId plexus-compiler-eclipse.
jikes with artifactId plexus-compiler-jikes.

详见链接：http://maven.apache.org/plugins/maven-compiler-plugin/non-javac-compilers.html

不同编译器之间切换，可以使用compilerId属性指定，如果不指定，默认使用的是javac。

1、更换编译器

为实现maven自动编译groovy class，需要更换一下maven-compiler-plugin插件所使用的编译器。Apache官方提供的编译器没有可以支持groovy的，所以我们到groovy官方找到一个，即：groovy-eclipse-compiler。

groovy-eclipse-compiler之详细介绍：

https://github.com/groovy/groovy-eclipse/wiki/Groovy-Eclipse-Maven-plugin

通过该插件可以完美解决java代码里夹杂的groovy class和groovy script被编译的问题。

<plugin>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.3</version>
    <configuration>
        <source>1.8</source>
        <target>1.8</target>
        <encoding>UTF-8</encoding>
        <compilerId>groovy-eclipse-compiler</compilerId>
        <!-- set verbose to be true if you want lots of uninteresting messages -->
        <verbose>true</verbose>
    </configuration>
    <dependencies>
        <dependency>
            <groupId>org.codehaus.groovy</groupId>
            <artifactId>groovy-eclipse-compiler</artifactId>
            <version>2.7.0-01</version>
        </dependency>
    </dependencies>
</plugin>

编译器更换为groovy-eclipse-compiler之后，目录下的groovy文件都可以正常编译了，但是java代码却报错了。编译报错信息都是一些bean的set、get方法找不到，而恰恰这些bean都使用了lombok的注解来自动生成get、set方法的。

2、解决与lombok的不兼容

javac编译器对lombok是无缝兼容的，不需要作任何额外的配置。那groovy-eclipse-compiler该如何与lombok兼容呢？groovy-eclipse-compiler自2.6.1-01版本之后也给出了解决办法，只需要作一些外的配置即可：

添加依赖：

<dependency>
  <groupId>org.projectlombok</groupId>
  <artifactId>lombok</artifactId>
  <version>1.14.8</version>
</dependency>

<configuration>
  <compilerId>groovy-eclipse-compiler</compilerId>
  <verbose>true</verbose>
  <compilerArguments>
    <!-- consult Lombok docs to confirm agent class name for your version -->
    <javaAgentClass>lombok.launch.Agent</javaAgentClass>
  </compilerArguments>
  <fork>true</fork>
</configuration>

按照上述要求，配置如下：

<plugin>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.3</version>
    <configuration>
        <source>1.8</source>
        <target>1.8</target>
        <encoding>UTF-8</encoding>
        <compilerId>groovy-eclipse-compiler</compilerId>
        <verbose>true</verbose>
        <fork>true</fork>
        <compilerArguments>
            <javaAgentClass>lombok.launch.Agent</javaAgentClass>
        </compilerArguments>
    </configuration>
    <dependencies>
        <dependency>
            <groupId>org.codehaus.groovy</groupId>
            <artifactId>groovy-eclipse-compiler</artifactId>
            <version>2.9.1-01</version>
        </dependency>
        <!-- for 2.8.0-01 and later you must have an explicit dependency on groovy-eclipse-batch -->
        <dependency>
            <groupId>org.codehaus.groovy</groupId>
            <artifactId>groovy-eclipse-batch</artifactId>
            <version>2.3.7-01</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.8</version>
        </dependency>
    </dependencies>
</plugin>