一个项目IntelliJ IDEA的spring boot项目含有多个module,module存在依赖关系。比如项目root项目为parent,有三个module:common,service以及api,其中service依赖common,api依赖service。项目结构如下图:
└─parent
├─api
├─common
└─service
依次配置各个层级的pom.xml文件,其中在父级项目parent的pom.xml中,加入maven构建插件:spring-boot-maven-plugin
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
在parent的根目录下,利用以下命令进行打包,遗憾的是总提示错误:“package common does not exist”。
mvn clean package
原先以为可能compile存在问题,利用以下命令执行后,并未发现编译错误。
mvn clean compile
是否存在引入包冲突的问题呢?利用maven的-X参数执行以下命令,并仔细查看了输出信息,并未发现任何有关包冲突的错误。
mvn clean package -X
是否各个pom.xml文件配置不正确?查阅了相关文档,核对了N遍,确信parent及各个module的pom.xml是配置无误的。
所有问题的原因究竟在哪里?那刻自己也是没了头绪,能想到的原因都已一一排查。一边不断重试(有点盲目),一边在网上搜索是否有类似问题的解决方案。令自己沮丧的是,找了很久并没有发现有人碰到完全一样的问题。
后面的心情可想而知,有种无力感,充满了挫折感,甚至开始怀疑人生……
然而作为技术人,天生有种执着,不解决问题誓不罢休。所以带着的内心的挫败感继续想办法解决这个问题。
在“山重水复疑无路”以及“踏破铁鞋无觅处”时,幸运之神关顾了我,让自己找了一些线索:有人说是maven默认的打包方式引起的,有个选项需要进行正确设置:classifier,这个选项主要有两个用途:标识引入包的版本(包括可以用于指定jdk的版本)以及同时输出不同的构件(artifactid)。
由于主要关注打包的问题,所以找到了官方的文档:Spring Boot Maven Plugin,其中有段文字:
By default, the repackage goal will replace the original artifact with the repackaged one. That's a sane behavior for modules that represent an app but if your module is used as a dependency of another module, you need to provide a classifier for the repackaged one.
If you are usingspring-boot-starter-parent
, therepackage
goal is executed automatically in an execution with idrepackage
. In that setup, only the configuration should be specified as shown in the following example:
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<executions>
<execution>
<id>repackage</id>
<configuration>
<classifier>exec</classifier>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
This configuration will generate two artifacts: the original one and the repackaged counter part produced by the repackage goal. Both will be installed/deployed transparently.
根据文档所述,如果一个module被另一个module所依赖,那么需要显示设置一个classifier。对于spring-boot项目,可以设置:<classifier>exec</classifier>,在打包时会生产两个构件,这两个构件都可以安装或部署。根据这个guide,立马在parent的pom.xml中增加了这个配置,如下图:
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<classifier>exec</classifier>
</configuration>
</plugin>
</plugins>
</build>
运行命令:
mvn clean package
完美打包成功。查看包的输出目录,果真有两个相似名称的包,一个是[name]-[version].jar,另一个是[name]-[version]-exec.jar。解压对比了这两个jar,发现名称含有-exec为可运行包,而另一个为普通包(不可通过 java -jar运行)。
自己将classifier配置删除,打包common,查看输出的jar,发现是个可运行的包,其它的module无法依赖可运行包。原来真正的原因在这里!
折磨近一天的问题终于解决,潦草记录该问题,可能对有些人有些帮助。如果你有任何疑问也可以私信来探讨。
如果你不知道如何利用IntelliJ IDEA创建multi-module的项目,可以参考这篇文章Creating a Multi Module Project