此文已由作者易国强授权网易云社区发布。
欢迎访问网易云社区,了解更多网易技术产品运营经验。
明确功能,各司其职
在一个结构清晰的项目中,一个没有module划分的结构显然不是最佳实践。有人会说可以在同一个Project中定义不同的包名及包路径来做区分,但这样当功能复杂后并不可取。
当然,如果你的项目足够简单,比如只是提供一个很简单的微服务,没有分层治理的概念,那么则不需要关心这个问题了。
下面就Spring Boot环境中多module打包的注意事项列举如下,希望对大家有所帮助。
新建所需要的module模块,在此示例中新建两个module,bingo-core和bingo-web。其中bingo-core作为封装服务提供给bingo-web使用,bingo-web作为我们的工程的最终jar包提供服务。为了说明问题,我们仍然采用spring boot框架来构建这两个module。
具体新建步骤可参考《从0到1,只需两分钟》这篇文章,不同的是,在新建的时候选择新建module即可。新建完毕后,工程结构如下图所示。注意此时父pom文件的打包方式需要变更成pom,不再是jar或者war。
通过在bingo-core中新建一个类,然后在bingo-web中使用此类以说明问题。(示例类在此省略,大家可以自己试试)
这个时候如果我们不做任何修改,直接package就会出现问题,提示找不到bingo-core中的相关类。如下图所示:
那么问题就是这里了,这个问题和spring boot的打包方式有关系,spring boot默认将每个module打包成一个fat jar,这个jar包和我们正常使用的jar包内部的结构是不相同的,如下图所示,fat jar包含了直接运行所需要的所有信息(包含内嵌的容器,如果是一个web应用的话),那么类的加载路径此时就发生了变化,所以在编译时会提示找不到引用类。
这个时候我们只需要通过配置maven的插件参数来使相关需要使用的jar打包成正常的jar包即可。修改配置如下:
在需要变更打包方式的pom.xml文件中(如在bingo-core模块),修改插件配置如下所示:
<build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> <configuration> <classifier>exec</classifier> </configuration> <executions> <execution> <goals> <goal>repackage</goal> </goals> </execution> </executions> </plugin> </plugins></build>复制代码
另外需要注意的是,需要在bingo-core/bingo-web模块的测试类中加入@SpringBootTest注解的作用范围,如下图所示:
![image](https://github.com/siyuyifang/image/blob/master/spring-boot/4/4-3.png?raw=true)- 此时再执行maven的package命令即可发现打包成功。我们查看bingo-core打包生成的jar包可以发现,实际上会有两个,如下图所示,带-exec后缀的就是我们默认的fat jar。可以直接运行的jar包。
![image](https://github.com/siyuyifang/image/blob/master/spring-boot/4/4-4.png?raw=true)复制代码
多module的打包方式修改比较简单,但当出现这个问题时,如果不清楚其原因,还是比较折腾人的。
不足之处,欢迎指正,谢谢~
更多网易技术、产品、运营经验分享请点击。
相关文章:
【推荐】 PaaS服务之路漫谈(三)
【推荐】 数据采集与分析的那些事——从数据埋点到AB测试