关于java:闲扯Maven项目代码组织形式

10次阅读

共计 4448 个字符，预计需要花费 12 分钟才能阅读完成。

@[toc]
因为最近有小伙伴问到了，所以我想和大家轻易扯扯 Maven 我的项目中代码的组织模式这个问题。

其实也不是啥大问题，然而如果不懂的话，就像雾里看花，始终不能看的明明白白，懂了就像一层窗户纸，捅破就好了。

所以咱们就简略扯几句。

首先来说说代码组织模式。

一般来说，就两种比拟常见的模式：

平铺
父子构造

这两种模式松哥在不同的我的项目中都有遇到过，所以咱们就不说孰优孰劣，单纯来说这两种计划。

平铺的代码相似上面这样：

├── 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：

<?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.javaboy</groupId>
    <artifactId>parent</artifactId>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>
    <modules>
        <module>../vhr-dao</module>
        <module>../vhr-service</module>
    </modules>

</project>

能够看到，在指定 module 时，因为 vhr-dao 和 vhr-service 和 parent 的 pom.xml 不在同一个目录下，所以这里应用了相对路径，相对路径的参考根据是 parent 的 pom.xml 文件地位。

vhr-dao：

<?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>parent</artifactId>
        <groupId>org.javaboy</groupId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../parent/pom.xml</relativePath>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>vhr-dao</artifactId>


</project>

能够看到，relativePath 节点中，通过相对路径指定了 parent 的 pom.xml 文件地位，这个相对路径的参考根据是子模块的 pom.xml 文件。

vhr-service：

<?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>parent</artifactId>
        <groupId>org.javaboy</groupId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../parent/pom.xml</relativePath>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>vhr-service</artifactId>


</project>

这个和 vhr-dao 的差不多，不赘述。

父子构造则相似于上面这样：

├── 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：

<?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.javaboy</groupId>
    <artifactId>maven_parent</artifactId>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>
    <modules>
        <module>vhr-dao</module>
        <module>vhr-service</module>
    </modules>


</project>

和后面不同的是，这里申明 modules 不须要相对路径了（其实还是相对路径，只是不须要 ../ 了），因为各个子模块和 parent 的 pom.xml 文件处于同一目录下。

vhr-dao：

<?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>maven_parent</artifactId>
        <groupId>org.javaboy</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>vhr-dao</artifactId>


</project>

这里也不须要通过 relativePath 节点去指定 parent 的 pom.xml 文件地位了，因为 parent 的 pom.xml 和各个子模块处于同一目录下。

vhr-service：

<?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>maven_parent</artifactId>
        <groupId>org.javaboy</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>vhr-service</artifactId>


</project>

有的时候，单纯只是想通过 parent 来对立治理不同的我的项目的依赖，并非一个聚合我的项目。

这个时候只须要去掉 parent 的 pom.xml 中的 modules 节点及其中的内容即可，这样就不是聚合工程了，各个子模块也能够独立打包。

当然很多状况咱们是聚合工程。

聚合工程的话，个别松哥是倡议大家从 parent 处对立进行打包：

这样能够确保打包到的是最新的代码。

当然还有另外一种操作流程：

首先将 parent 装置到本地仓库。
而后别离将 model、dao 以及 service 等模块装置到本地仓库。
最初 web 模块就能够独立打包了。

如果应用这种操作流程，须要留神一点，就是每个模块代码更新之后，要及时装置到本地仓库，否则当 web 模块独立打包时，用到的其余模块就不是最新的代码。

好啦，几个 Maven 中的小问题，窗户纸捅破了就恍然大悟啦～

正文完

java

发表至： java

2021-10-11

0

关于java:关于nacos2连不上的一个原因

关于java:引爆全球的-Log4j2-核弹级漏洞JNDI-到底是个什么鬼

关于java:编写高质量代码改善Java程序的151个建议pdf

关于java:监控链路追踪日志的区别傻傻分不清

关于java:不得不知的-IDEA-实用小技巧

关于java:闲扯Maven项目代码组织形式

1. 代码组织模式

1.1 平铺

1.2 父子构造

2. 打包问题

2.1 继承

2.2 聚合

3. 小结

站内搜索