2015年12月27日星期日

Maven_004:聚合与继承

环境: OS X EI Capitan 10.11.2 + JDK 1.8.0_66 + Maven 3.3.9

1. 聚合
实际情况中,一个项目是由多个Maven项目组成的,如果每次构建整个项目都要逐一手工构建Maven项目,那就太麻烦了。
聚合就是解决此类问题的:只需运行一次Maven命令,就可以构建整个项目。

在子Maven项目的上一级目录创建一个父目录,比如account-aggregator,作为聚合项目。
该项目只有一个pom.xml,没有其它内容,因为它的作用就是聚合。
各个子Maven项目依然可以独立构建。

<project>
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.juvenxu.mvnbook.account</groupId>
    <artifactId>account-parent</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <packaging>pom</packaging>
    <name>Account Parent</name>
    <modules>
        <module>account-email</module>
        <module>account-persist</module>
    </modules>
</project>

(1)modules 中指定包含的子Maven项目,这里的值是子Maven项目的目录名称。
(2)packaging 必须设置为 pom。
(3)modules 中指定子Maven项目。

完成后的项目目录结构如下:
account-aggregator
    -- account-email
        -- pom.xml
        ...
    -- account-persist
        -- pom.xml
        ... 
    -- pom.xml

2. 继承
聚合解决了使用一条Maven命令构建多个Maven项目的问题。
但实际情况中,多个Maven子项目具有共同的属性,建议把这些相同的属性抽取出来,放到一个父 Maven 项目中声明,然后在各个子Maven项目中继承来自父 Maven 项目中声明。

在子Maven项目的同级目录创建一个目录,比如account-parent,作为父项目。
该项目只有一个pom.xml,没有其它内容,因为它的作用就是继承。

<project>
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.juvenxu.mvnbook.account</groupId>
    <artifactId>account-parent</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <packaging>pom</packaging>
    <name>Account Parent</name>
</project>

(1)packaging 必须设置为 pom。

同时,在各个子Maven项目中,也要指向该父 Maven 项目,以account-email为例:

<project>
    <modelVersion>4.0.0</modelVersion>
   
    <parent>
        <groupId>com.juvenxu.mvnbook.account</groupId>
        <artifactId>account-parent</artifactId>
        <version>1.0.0-SNAPSHOT</version>
        <relativePath>../account-parent/pom.xml</relativePath>
    </parent>
   
    <artifactId>account-email</artifactId>
    <name>Account Email</name>
</project>

(1)parent 使用parent元素声明父模块,groupId + artifactId + version 唯一定位父模块。
(2)relativePath 指定父模块pom.xml文件的相对路径。这个设置很重要,如果找不到父模块的pom.xml,子Maven项目将构建失败。
(3)在子Maven项目中不再声明 groupId 和 version,因为已经从父模块中继承了。当然,如果子Maven 项目中的groupId 和 version 与父模块中的声明不同,也可以继续声明,覆盖父模块中的声明。

最后,在 account-aggregator 项目中还要增加 account-parent 模块。

<project>
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.juvenxu.mvnbook.account</groupId>
    <artifactId>account-parent</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <packaging>pom</packaging>
    <name>Account Parent</name>
    <modules>
        <module>account-parent</module>
        <module>account-email</module>
        <module>account-persist</module>
    </modules>
</project>

完成后的项目目录结构如下:
account-aggregator
    -- account-email
        -- pom.xml
        ...
    -- account-persist
        -- pom.xml
        ...
    -- account-parent
        -- pom.xml
    -- pom.xml

3. 其它可继承的POM元素
除了 groupId 和 version,还有很多元素可以继承,其中最重要的是依赖关系:dependencies。
直接把dependicies加到父Maven项目中是可以的,但是还不够灵活,因为不是每个子Maven项目都需要这些依赖。
dependencyManagement 既可以让子模块继承到父模块的以来配置,又能保证子模块依赖使用的灵活性。
在dependencyManagement中声明的依赖不会引入实际的依赖,但是可以约束dependencies的使用。
如果子模块不声明依赖的使用,即使该依赖在父模块的 dependencyManagement 中声明了,还是不会起作用。
要引入实际的依赖,还是要在dependencies元素中定义才有效。

在父Maven项目:account-parent 中加入 dependencyManagement 配置信息:

<project>
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.juvenxu.mvnbook.account</groupId>
    <artifactId>account-parent</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <packaging>pom</packaging>
    <name>Account Parent</name>
    <properties>
        <springframework.version>2.5.6</springframework.version>
        <junit.version>4.7</junit.version>
    </properties>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-core</artifactId>
                <version>${springframework.version}</version>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-beans</artifactId>
                <version>${springframework.version}</version>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-context</artifactId>
                <version>${springframework.version}</version>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-context-support</artifactId>
                <version>${springframework.version}</version>
            </dependency>
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>${junit.version}</version>
                <scope>test</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>

此时,在子Maven项目:account-email 中的依赖配置如下:

<project>
    <modelVersion>4.0.0</modelVersion>
   
    <parent>
        <groupId>com.juvenxu.mvnbook.account</groupId>
        <artifactId>account-parent</artifactId>
        <version>1.0.0-SNAPSHOT</version>
        <relativePath>../account-parent/pom.xml</relativePath>
    </parent>
   
    <artifactId>account-email</artifactId>
    <name>Account Email</name>

    <properties>
        <javax.mail.version>1.4.1</javax.mail.version>
        <greenmail.version>1.3.1b</greenmail.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>       
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-beans</artifactId>           
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>           
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context-support</artifactId>           
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
        <dependency>
            <groupId>javax.mail</groupId>
            <artifactId>mail</artifactId>
            <version>${javax.mail.version}</version>
        </dependency>       
        <dependency>
            <groupId>com.icegreen</groupId>
            <artifactId>greenmail</artifactId>
            <version>${greenmail.version}</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

(1)子Maven项目中的依赖只需定义groupId 和 artifactId,因为version 和 scope 已经从父Maven项目中继承了,从而保证所有子Maven项目使用的依赖是同一个版本,降低依赖冲突。
(2)子Maven项目中可以继续详细定义没有在父Maven项目中定义的依赖。
(3)在子Maven项目中不再声明 groupId 和 version,因为已经从父模块中继承了。
当然,如果子Maven 项目中的groupId 和 version 与父模块中的声明不同,也可以继续声明,覆盖父模块中的声明。

4. 导入 dependencyManagement 中声明的依赖
还记得依赖关系中有个import的scope吧,这个范围的依赖只在 dependencyManagement 元素中才有意义。

<dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>com.juvenxu.mvnbook.account</groupId>
                <artifactId>account-parent</artifactId>
                <version>1.0.0-SNAPSHOT</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>          
        </dependencies>
</dependencyManagement>

(1)导入account-parent 模块中定义的dependencyManagement 内容。
(2)如果有多个项目使用的依赖版本都是一致的,则可以定义一个使用 dependencyManagement 专门管理依赖的POM,然后在各个项目中导入这个依赖。

5. 使用 pluginManagement 管理插件
与 dependencyManagement 使用方法类似,Maven使用pluginManagement 管理插件。
在父模块中声明可以使用的插件,在子模块中声明要使用的插件。

参考文献:
1. 《Maven 实战》 徐晓斌著

没有评论: