用 Maven pom.xml配置子项目

青旅半醒 2024-04-17 05:52 36阅读 0赞

比较大点的项目都是在项目中分模块化，每个模块都是其子项目，可以单独运行，由此想要学习一下怎样规范的搭建项目和环境配置。这次总结一下Maven的配置。  
一个Maven项目的核心就是 pom 文件，本文大致讲Maven pom.xml中的 `modules`、`parent`、`properties`以及 `import` 元素。

### 准备 ###

--------------------

##### 1.创建一个Maven项目 #####

因为我们要创建子项目，所以没有必要的目录可以不要，只留pom.xml就可以。  
![在这里插入图片描述][20190824165353118.png]

##### 2.创建 maven 的 Module #####

![在这里插入图片描述][20190824165642255.png]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2tfeW91bmcxOTk3_size_16_color_FFFFFF_t_70]  
创建后的项目结构  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2tfeW91bmcxOTk3_size_16_color_FFFFFF_t_70 1]  
===========================================================================

### modules ###

--------------------

当我们的项目中分了多个模块，每当我们需要构建项目时如果把每个模块都构建一遍这就太麻烦了，这时候就需要用 `modules` 元素了。此元素写在父模块的 pom 文件中，即上文的 test 的 pom 文件中。  
   `modules` 中，每一个 `model` 元素都表示一个模块，这样在构建项目时，这些模块会一块被构建，而不用一个一个构建。

### parent ###

--------------------

继承，和java中的继承相当，作用就是复用。

当每一个子模块中都引用了某个或多个相同的依赖时，我们是不是要在每个子模块中都引用相同的依赖呢？显然这样是繁琐的。那有没有解决办法呢？显然是有的。  
  通过 `parent` 元素即可实现对父模块依赖的复用。我们只需在子模块的 pom 文件中添加 `parent` 元素即可。

父模块（test）的 pom 文件：

<?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>test</groupId>
        <artifactId>test</artifactId>
        <packaging>pom</packaging>
        <version>1.0-SNAPSHOT</version>
        <modules>
            <module>demo1</module>
            <module>demo2</module>
        </modules>
        
    	
        <dependencies>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-core</artifactId>
                <version>4.0.2.RELEASE</version>
            </dependency>
        </dependencies>
    
    </project>

子模块（dome1、dome2） 的 pom 文件：

<?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>test</artifactId>
            <groupId>test</groupId>
            <version>1.0-SNAPSHOT</version>
            <relativePath>../pom.xml</relativePath> 
        </parent>
        <packaging>war</packaging>
        <modelVersion>4.0.0</modelVersion>
    
        <artifactId>demo1</artifactId>
    
     	
        <dependencies>
            <dependency>
                <groupId>junit</groupId>
    			<artifactId>junit</artifactId>
    			<version>4.7</version>
    			<scope>test</scope>
    		</dependency>
        </dependencies>
        
    </project>

### dependencyManagement ###

--------------------

通过 `parent` 可以帮助我们达到复用依赖的目的，但是继承就一定有没有弊端吗？设想一下，假如我们有三个子模块，**模块A** 和 **模块B** 需要复用三个依赖，而 **模块C** 只需要三个依赖中的一个，其他两个根本就不需要，这时就会造成 **模块C** 存在多余的依赖。

不过不用担心，这个问题 Maven 提供了解决办法，那就是 `dependencyManagement` 元素。

只需在父模块的 pom 文件中加入 `dependencyManagement` 元素，就既能让子模块继承到父模块的依赖配置，又能保证子模块依赖使用的灵活性。在 `dependencyManagement` 元素下得依赖声明不会引入实际的依赖，不过它能够约束 `dependencyManagement` 下的依赖使用。

父模块（test）的 pom 文件：

<?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>test</groupId>
        <artifactId>test</artifactId>
        <packaging>pom</packaging>
        <version>1.0-SNAPSHOT</version>
        <modules>
            <module>demo1</module>
            <module>demo2</module>
        </modules>
        
        <dependencyManagement>
    		
    	    <dependencies>
    	        <dependency>
    	            <groupId>org.springframework</groupId>
    	            <artifactId>spring-core</artifactId>
    	            <version>4.0.2.RELEASE</version>
    	        </dependency>
    	    </dependencies>
    	</dependencyManagement>
    
    </project>

子模块（dome1、dome2） 的 pom 文件：

<?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>test</artifactId>
            <groupId>test</groupId>
            <version>1.0-SNAPSHOT</version>
            <relativePath>../pom.xml</relativePath> 
        </parent>
        <packaging>war</packaging>
        <modelVersion>4.0.0</modelVersion>
    
        <artifactId>demo1</artifactId>
    
        <dependencies>
        	
            <dependency>
                <groupId>junit</groupId>
    			<artifactId>junit</artifactId>
    			<version>4.7</version>
    			<scope>test</scope>
    		</dependency>
    		
    		<dependency>
    	        <groupId>org.springframework</groupId>
    	        <artifactId>spring-core</artifactId>
    	    </dependency>
        </dependencies>
        
    </project>

使用这种依赖管理机制似乎不能减少太多的POM配置，感觉没啥作用呀；其实作用还是挺大的，父POM使用 `dependencyManagement` 能够统一项目范围中依赖的版本，当依赖版本在父POM中声明后，子模块在使用依赖的时候就无须声明版本，也就不会发生多个子模块使用版本不一致的情况，帮助降低依赖冲突的几率。如果子模块不声明依赖的使用，即使该依赖在父POM中的 `dependencyManagement` 中声明了，也不会产生任何效果。

### import ###

--------------------

import只在`dependencyManagement`元素下才有效果，作用是将目标POM中的`dependencyManagement`配置导入并合并到当前POM的`dependencyManagement`元素中，如下就是将test中的`dependencyManagement`配置导入并合并到当前 pom 中。

<dependencyManagement>
        <dependencies>
          <dependency>
             <groupId>test</groupId>
       		 <artifactId>test</artifactId>
             <version>1.0.0-SNAPSHOT</version>
             <type>pom</type>
             <scope>import</scope>
          </dependency>
        </dependencies>
    </dependencyManagement>

### properties ###

--------------------

`properties` 元素可以在 pom 文件中定义一个或多个属性，可以消除重复和统一管理。在 pom 文件的其他地方使用$\{属性名\}的方式引用该属性。

<properties>
       <junit.version>4.8</junit.version>
    </properties>
    
    <dependencies>
    	<dependency>
    		<groupId>junit</groupId>
    		<artifactId>junit</artifactId>
    		<version>${junit.version}</version>
    		<scope>test</scope>
    	</dependency>
    </dependencies>

Maven总共有6类属性，内置属性、POM属性、自定义属性、Settings属性、java系统属性和环境变量属性；

##### 自定义属性 #####

自定义属性就是上边用 `properties` 元素定义的属性。继承了此pom.xml的子模块也可以用此自定义属性。

##### 内置属性 #####

两个常用内置属性  b a s e d i r 表 示 项 目 跟 目 录 ， 即 包 含 p o m . x m l 文 件 的 目 录 ； \{basedir\} 表示项目跟目录，即包含pom.xml文件的目录； basedir表示项目跟目录，即包含pom.xml文件的目录；\{version\} 表示项目版本

##### pom属性 #####

用户可以使用该类属性引用 pom 文件中对应元素的值。如$\{project.artifactId\}就对应了<project> 中 <artifactId> 元素的值，常用的 pom 属性包括：

*  $\{project.build.sourceDirectory\}:项目的主源码目录，默认为src/main/java/
 *  $\{project.build.testSourceDirectory\}:项目的测试源码目录，默认为src/test/java/
 *  $\{project.build.directory\} ： 项目构建输出目录，默认为target/
 *  $\{project.outputDirectory\} : 项目主代码编译输出目录，默认为target/classes/
 *  $\{project.testOutputDirectory\}：项目测试主代码输出目录，默认为target/testclasses/
 *  $\{project.groupId\}：项目的groupId
 *  $\{project.artifactId\}：项目的artifactId
 *  $\{project.version\}：项目的version,与$\{version\} 等价
 *  $\{project.build.finalName\}：项目打包输出文件的名称，默认$\{project.artifactId\}-$\{project.version\}

##### settings属性 #####

与POM属性同理，用户使用以settings. 开头的属性引用settings.xml文件中的XML元素的值。

##### Java系统属性 #####

所有java系统属性都可以用Maven属性引用，如$\{user.home\}指向了用户目录。

##### 环境变量属性 #####

所有环境变量属性都可以使用以env. 开头的Maven属性引用，如$\{env.JAVA\_HOME\}指代了JAVA\_HOME环境变量的的值。

### 聚合与继承的关系 ###

--------------------

1.聚合主要是为了方便快速构建项目，继承主要是为了消除重复配置；

2.对于聚合模块而言，它知道有哪些被聚合的模块，但那些被聚合的模块不知道这个聚合模块的存在；对于继承的父pom而言，它不知道有哪些子模块继承它，但那些子模块都必须知道自己的父POM是什么；

3.聚合POM与继承中的父POM的packaging都必须是pom；同时，聚合模块与继承中的父模块除了POM外，都没有实际的内容。

本文参考自：https://www.cnblogs.com/youzhibing/p/5427130.html

[20190824165353118.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/752e2c2da34b4cb897a66cde3239ca1c.png
[20190824165642255.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/dbb5814396564052b5b71d58af98030b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2tfeW91bmcxOTk3_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/684067d145ae43edb1f864e7c657cf7e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2tfeW91bmcxOTk3_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/162e5967fabe4f5aa29ae6bc0a431e6c.png