Maven项目代码组织形式

转载

程序三两行 2022-10-09 16:35:34

文章标签 maven java xml apache 文章分类 运维

1、常见的maven项目两种代码组织形式

1.1、平铺

Maven项目代码组织形式_maven

可以看到，在这种结构下，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>

1.2、父子

Maven项目代码组织形式_apache_02

这种父子结构的看起来就非常的层次分明了，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 和各个子模块处于同一目录下。