闲扯Maven项目代码组织形式
@[toc]
因为最近有小伙伴问到了,所以我想和大家随便扯扯 Maven 项目中代码的组织形式这个问题。
其实也不是啥大问题,但是如果不懂的话,就像雾里看花,始终不能看的明明白白,懂了就像一层窗户纸,捅破就好了。
所以我们就简单扯几句。
1. 代码组织形式
首先来说说代码组织形式。
一般来说,就两种比较常见的形式:
- 平铺
- 父子结构
1.1 平铺
平铺的代码类似下面这样:
├── parent
│├── pom.xml
│└── src
│├── main
││├── java
││└── resources
│└── test
│└── java
├── vhr-dao
│├── pom.xml
│├── src
││├── main
│││├── java
│││└── resources
││└── test
││└── java
└── vhr-service
├── pom.xml
├── src
│├── main
││├── java
││└── resources
│└── test
│└── java
如下图:
文章图片
可以看到,在这种结构下,parent 父工程和各个子工程从代码组织形式上来看都是平级的,都处于同一个目录下。
不过仔细查看 pom.xml 文件,还是能够清晰的看到这三个 module 的父子关系的:
parent:
4.0.0 org.javaboy
parentpom
1.0-SNAPSHOT
../vhr-dao
../vhr-service
可以看到,在指定 module 时,由于 vhr-dao 和 vhr-service 和 parent 的 pom.xml 不在同一个目录下,所以这里使用了相对路径,相对路径的参考依据是 parent 的 pom.xml 文件位置。
vhr-dao:
【闲扯Maven项目代码组织形式】parent
org.javaboy
1.0-SNAPSHOT
../parent/pom.xml
4.0.0 vhr-dao
可以看到,relativePath 节点中,通过相对路径指定了 parent 的 pom.xml 文件位置,这个相对路径的参考依据是子模块的 pom.xml 文件。
vhr-service:
parent
org.javaboy
1.0-SNAPSHOT
../parent/pom.xml
4.0.0 vhr-service
这个和 vhr-dao 的差不多,不赘述。
1.2 父子结构
父子结构则类似于下面这样:
├── maven_parent
│├── pom.xml
│├── vhr-dao
││├── pom.xml
││└── src
││├── main
│││├── java
│││└── resources
││└── test
││└── java
│└── vhr-service
│├── pom.xml
│└── src
│├── main
││├── java
││└── resources
│└── test
│└── java
如下图:
文章图片
这种父子结构的看起来就非常的层次分明了,parent 和各个 module 一眼就能看出来,我们从 GitHub 上下载的很多开源项目如 Shiro,都是这种结构。
不过文件夹的层级并不能说明任何问题,关键还是要看 pom.xml 中的定义,接下来我们就来看看 parent 的 pom.xml 和各个子模块的 pom.xml 有何异同。
maven_parent:
4.0.0 org.javaboy
maven_parentpom
1.0-SNAPSHOT
vhr-dao
vhr-service
和前面不同的是,这里声明 modules 不需要相对路径了(其实还是相对路径,只是不需要
../
了),因为各个子模块和 parent 的 pom.xml 文件处于同一目录下。vhr-dao:
maven_parent
org.javaboy
1.0-SNAPSHOT
4.0.0 vhr-dao
这里也不需要通过 relativePath 节点去指定 parent 的 pom.xml 文件位置了,因为 parent 的 pom.xml 和各个子模块处于同一目录下。
vhr-service:
maven_parent
org.javaboy
1.0-SNAPSHOT
4.0.0 vhr-service
2. 打包问题 2.1 继承
有的时候,单纯只是想通过 parent 来统一管理不同的项目的依赖,并非一个聚合项目。
这个时候只需要去掉 parent 的 pom.xml 中的 modules 节点及其中的内容即可,这样就不是聚合工程了,各个子模块也可以独立打包。
2.2 聚合
当然很多情况我们是聚合工程。
聚合工程的话,一般松哥是建议大家从 parent 处统一进行打包:
文章图片
这样可以确保打包到的是最新的代码。
当然还有另外一种操作流程:
- 首先将 parent 安装到本地仓库。
- 然后分别将 model、dao 以及 service 等模块安装到本地仓库。
- 最后 web 模块就可以独立打包了。
3. 小结 好啦,几个 Maven 中的小问题,窗户纸捅破了就豁然开朗啦~
推荐阅读
- 17|17 关山松 第二课作业#公众号项目# D20
- RxJava|RxJava 在Android项目中的使用(一)
- Hacking|Hacking with iOS: SwiftUI Edition - SnowSeeker 项目(一)
- 靠QQ月入上万灰色暴利偏门的项目
- spring|spring boot项目启动websocket
- vuex|vuex 基础结构
- 区块链开发平台(以太坊)
- 如何在手机上查看测试vue-cli构建的项目
- django2.2|django2.2 一般项目步骤(初步)
- 项目团队管理|项目团队管理 - 塔克曼阶梯理论