继承和聚合

聚合

所谓聚合,顾名思义,就是把多个模块或项目聚合到一起,一条命令构建多个模块。

为什么要聚合?

随着技术的飞速发展和各类用户对软件的要求越来越高,软件本身也变得越来越复杂,软件设计人员开始采用各种方式进行开发,于是就有了我们的分层架构、分模块开发,来提高代码的清晰和重用。

针对于这一特性,maven也给予了相应的配置。

Demo

有项目Demo下面有a, b两个模块:

mvn archetype:generate -DgroupId=org.demo -DartifactId=demoA -Dversion=1.0.0-SNAPSHOT -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

mvn archetype:generate -DgroupId=org.demo -DartifactId=demoB -Dversion=1.0.0-SNAPSHOT -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

新建Demo目录,结构如下:

├─demoA
│  └─src
│      ├─main
│      │  └─java
│      │      └─org
│      │          └─demo
│      └─test
│          └─java
│              └─org
│                  └─demo
└─demoB
    └─src
        ├─main
        │  └─java
        │      └─org
        │          └─demo
        └─test
            └─java
                └─org
                    └─demo

编写Demo/pom.xml

<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/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>org.demo</groupId>
  <artifactId>Demo</artifactId>
  <packaging>pom</packaging>
  <version>1.0.0-SNAPSHOT</version>
  <name>Demo</name>
  <url>http://maven.apache.org</url>

    <modules>
          <module>demoA</module>
          <module>demoB</module>
  </modules>
</project>

注意文件中的packaging节点值为pom,表示此POM是一个聚合POM,modules节点包含了子模块的列表,module节点定义了子模块的相对路径。

为了方便构建,通常将聚合模块放在项目目录层的最顶层,其它聚合模块作为子目录存在。

此时,在Demo目录中执行mvn clean package时,模块A与模块B都会被构建。

wKioL1c0NwaTzw-YAAAa_4FO16M602.png

聚合模块的内容仅仅是一个pom.xml文件,它不包含src/main/java、src/test/java等目录,因为它只是用来帮助其它模块构建的工具,本身并没有实质的内容。

继承

为什么要继承?

继承是为了避免重复,简化配置,它还有一个好处就是让项目更加安全

Demo

上面的示例中,demoA与demoB都使用了Junit的依赖,都在自己的POM配置中添加了dependencies节点说明。

修改Demo/pom.xml

<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/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.demo</groupId>
    <artifactId>Demo</artifactId>
    <packaging>pom</packaging>
    <version>1.0.0-SNAPSHOT</version>
    <name>Demo</name>
    <url>http://maven.apache.org</url>

    <modules>
        <module>demoA</module>
        <module>demoB</module>
    </modules>


    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>3.8.1</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

修改Demo/demoA/pom.xml

<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/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <artifactId>demoA</artifactId>
    <packaging>jar</packaging>

    <name>demoA</name>
    <url>http://maven.apache.org</url>

    <parent>
        <groupId>org.demo</groupId>
        <artifactId>Demo</artifactId>
        <version>1.0.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>
</project>

修改Demo/demoB/pom.xml

<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/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <artifactId>demoB</artifactId>
    <packaging>jar</packaging>

    <name>demoB</name>
    <url>http://maven.apache.org</url>

    <parent>
        <groupId>org.demo</groupId>
        <artifactId>Demo</artifactId>
        <version>1.0.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>
</project>

子模块中用parent元素声明父模块,parent下的子节点groupIdartifactIdversion指定父模块的坐标,这三个元素是必须的。节点relativePath指定父模块pom的路径,默认值是:../pom.xml

可以被继承的POM元素:

  • groupId:项目id,项目坐标的核心元素

  • version:项目版本,项目坐标的核心元素

  • description:项目描述信息

  • organization:项目组织信息

  • inceptionYear:项目创世年月

  • developers:项目开发者信息

  • contributors:项目贡献者信息

  • distributionManagement:项目部署配置

  • scm:项目的版本控制信息

  • mailingLists:项目邮件列表信息

  • properties:自定义的属性

  • dependencies:项目的依赖配置

  • dependencyManagement:项目的依赖管理配置

  • repositories:项目的仓库配置

  • build:项目源码目录配置。输出目录配置,插件配置等。

maven的依赖管理

从上面可以看出:dependencies配置是可以被继承的,项目的共用依赖元素可以转移到parent中去,这样就简化了配置。但是问题也随之而来,如果有一个新的模块,但是这个模块不需要这些parent的依赖,这时候如何处理?

maven的依赖管理(dependencyManagement)就是来解决这个问题的。

dependencyManagement的特性:在dependencyManagement中配置的元素既不会给parent引入依赖,也不会给它的子模块引入依赖,仅仅是它的配置是可继承的

Demo:

父模块添加声明:

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>yourgroupId</groupId>
            <artifactId>yourartifactId</artifactId>
            <version>${target.version}</version>
        </dependency>
    </dependencies>
</dependencyManagement>

子模块的POM继承这些配置:

<dependencies>
    <dependency>
        <groupId>yourgroupId</groupId>
        <artifactId>yourartifactId</artifactId>
    </dependency>
</dependencies>

子模块继承这些配置的时候,仍然要声明groupId和artifactId,表示当前配置是继承于父POM的,从而直接使用父POM的对应版本的组件。

父模块中使用dependencyManagement的组件,只有子模块配置了继承的元素,才会真正的有效,否则maven是不会加载父模块中声明的元素。

这个可以有效的避免多个子模块使用依赖版本不一致的情况,有助于降低依赖冲突的几率。

maven的插件管理

在我们项目开发的过程中,也会频繁的引入插件,所以解决这些复杂配置的方法就是使用插件管理

父模块中可以添加pluginManagement用于管理插件。这个元素和dependencyManagement相类似。

Demo:

<pluginManagement>
    <plugins>
        <plugin>
            <groupId></groupId>
            <artifactId></artifactId>
            <version></version>
            <executions>
                <execution>
                    <id></id>
                    <goals>
                        <goal></goal>
                    </goals>
                    <phase></phase>
                    <configuration>
                        <source></source>
                        <target></target>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</pluginManagement>