Maven pom文件基本结构一

最新推荐文章于 2024-08-15 06:15:00 发布

Marvin-Fox

最新推荐文章于 2024-08-15 06:15:00 发布

阅读量2.7k

点赞数 3

分类专栏： Maven

本文链接：https://blog.csdn.net/fox_bert/article/details/85525198

版权

Maven 专栏收录该内容

8 篇文章 0 订阅

订阅专栏

POM文件结构

Project Object Model是Maven2项目的基础所在，简单来说它就是一个XML文件，Maven2用它来描述一个工程的整个生命周期所需要执行的一系列功能和特性。

最小配置

任何项目都最少要包含以下几个标签。

<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.fox</groupId>
  <artifactId>demo</artifactId>
  <version>1.0</version>
</project>

modelVersion这个标签必须存在，而且它的值必须是4.0.0，这标志着我们现在使用的是maven2。

groupId和artifactId合起来作为当前项目的唯一标识，maven2最终会根据这两个值，决定项目发布到repo上时所处的位置。

version是项目的版本号，它用来标记同一个项目发布的不同版本。

pom文件常用结构标签

<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 "> 
 
    <!-- 父项目的坐标。如果项目中没有规定某个元素的值，那么父项目中的对应值即为项目的默认值。
         坐标包括group ID，artifact ID和 version。 --> 
    <parent> 
        <!-- 被继承的父项目的构件标识符 --> 
        <artifactId>xxx</artifactId>
        <!-- 被继承的父项目的全球唯一标识符 -->
        <groupId>xxx</groupId> 
        <!-- 被继承的父项目的版本 --> 
        <version>xxx</version>
        <!-- 父项目的pom.xml文件的相对路径。相对路径允许你选择一个不同的路径。默认值是../pom.xml。
             Maven首先在构建当前项目的地方寻找父项目的pom，其次在文件系统的这个位置（relativePath位置），
             然后在本地仓库，最后在远程仓库寻找父项目的pom。 --> 
        <relativePath>xxx</relativePath> 
    </parent> 
 
 
    <!-- 声明项目描述符遵循哪一个POM模型版本。模型本身的版本很少改变，虽然如此，但它仍然是必不可少的，
         这是为了当Maven引入了新的特性或者其他模型变更的时候，确保稳定性。 --> 
    <modelVersion> 4.0.0 </modelVersion> 
    <!-- 项目的全球唯一标识符，通常使用全限定的包名区分该项目和其他项目。并且构建时生成的路径也是由此生成， 
         如com.mycompany.app生成的相对路径为：/com/mycompany/app --> 
    <groupId>xxx</groupId> 
    <!-- 构件的标识符，它和group ID一起唯一标识一个构件。换句话说，你不能有两个不同的项目拥有同样的artifact ID
         和groupID；在某个特定的group ID下，artifact ID也必须是唯一的。构件是项目产生的或使用的一个东西，Maven
         为项目产生的构件包括：JARs，源码，二进制发布和WARs等。 --> 
    <artifactId>xxx</artifactId> 
    <!-- 项目产生的构件类型，例如jar、war、ear、pom。插件可以创建他们自己的构件类型，所以前面列的不是全部构件类型 --> 
    <packaging> jar </packaging> 
    <!-- 项目当前版本，格式为:主版本.次版本.增量版本-限定版本号 --> 
    <version> 1.0-SNAPSHOT </version> 
    <!-- 项目的名称, Maven产生的文档用 --> 
    <name> xxx-maven </name> 
    <!-- 项目主页的URL, Maven产生的文档用 --> 
    <url> http://maven.apache.org </url> 
    <!-- 项目的详细描述, Maven 产生的文档用。 当这个元素能够用HTML格式描述时（例如，CDATA中的文本会被解析器忽略，
         就可以包含HTML标签）， 不鼓励使用纯文本描述。如果你需要修改产生的web站点的索引页面，你应该修改你自己的
         索引页文件，而不是调整这里的文档。 --> 
    <description> A maven project to study maven. </description> 
     <!-- 项目创建年份，4位数字。当产生版权信息时需要使用这个值。 --> 
    <inceptionYear /> 

	
	<!-- 模块（有时称作子项目） 被构建成项目的一部分。列出的每个模块元素是指向该模块的目录的相对路径 --> 
    <modules>
        <!--子项目相对路径-->
        <module></module>
    </modules>
	
	<!-- 继承自该项目的所有子项目的默认依赖信息。这部分的依赖信息不会被立即解析,而是当子项目声明一个依赖
        （必须描述group ID和artifact ID信息），如果group ID和artifact ID以外的一些信息没有描述，则通过
            group ID和artifact ID匹配到这里的依赖，并使用这里的依赖信息。 --> 
    <dependencyManagement> 
        ......
    </dependencyManagement> 

 
    <!-- 构建项目需要的信息 --> 
    <build> 
        ......
    </build> 

    <!-- 发现依赖和扩展的远程仓库列表。 --> 
    <repositories> 
        ......
    </repositories>
 
    <!-- 在列的项目构建profile，如果被激活，会修改构建处理 --> 
    <profiles> 
        ......
    </profiles> 

    <!-- 发现插件的远程仓库列表，这些插件用于构建和报表 --> 
    <pluginRepositories> 
        ......
    </pluginRepositories> 

    <!-- 该元素描述了项目相关的所有依赖。 这些依赖组成了项目构建过程中的一个个环节。它们自动从项目定义的仓库中下载。
         要获取更多信息，请看项目依赖机制。 --> 
    <dependencies> 
        ......
    </dependencies> 

    <!-- 该元素描述使用报表插件产生报表的规范。当用户执行“mvn site”，这些报表就会运行。 在页面导航栏能看到所有报表的链接。 --> 
    <reporting> 
        ......
    </reporting> 

    <!-- 项目分发信息，在执行mvn deploy后表示要发布的位置。有了这些信息就可以把网站部署到远程服务器或者
         把构件部署到远程仓库。 --> 
    <distributionManagement> 
        ......
    </distributionManagement> 
 
    <!-- 以值替代名称，Properties可以在整个POM中使用，也可以作为触发条件（见settings.xml配置文件里
         activation元素的说明）。格式是<name>value</name>。 --> 
    <properties>
        <name>value</name>
    </properties> 
</project>

管理依赖

我们平常接触最多的就是dependencies标签了。因为既然使用了maven2，最大的得益之处还是可以用它统一管理依赖库。dependencies和它内部的dependency标签就用来配置当前项目所依赖的第三方库的。

<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.fox</groupId>
  <artifactId>demo</artifactId>
  <version>1.0</version>

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

我们可以看到dependency标签中也包含了groupId，artifactId和version信息，这三部分就是一个maven2项目所需的最小配置，也是maven2所管理的项目的唯一标识，有了这三个数据，maven2就可以在repo中查找到对应的依赖，并将其包含到我们的项目中，从而实现对依赖库的管理。

<scope>:上面的依赖中，我们使用了groupId为junit，artifactId为junit，版本为3.8.1的依赖，这个依赖会在test作用域中起作用，也就是说，只有在进行单元测试的时候，才会用到这个依赖，与之对应的是，当我们的程序正常编译，运行，打包发布时，是不会包含这个依赖的。maven2内置了多个作用域，可以让我们将不同阶段使用的依赖库进行隔离，之后我们会慢慢讨论这部分的信息。

现在你需要知道，可以使用dependencies和dependency为项目定义多个依赖，并且每个依赖都需要groupId，artifactId和version这些数据就可以了。

构建部分

pom中一大部分配置都包含在build标签中，这部分是在对项目进行构建时所需要的配置，当你对项目进行编译，测试，打包，发布的时候，这部分配置就会在对应的阶段起作用了。

build标签中可以包含很多插件，这些插件可以配置到项目的某些构建阶段，随着项目的构建进程发挥作用。

<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.fox</groupId>
  <artifactId>demo</artifactId>
  <version>1.0</version>

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

  <build>
    <plugins>  
        <plugin>  
            <artifactId>maven-compiler-plugin</artifactId>  
            <configuration>  
                <source>1.6</source>  
                <target>1.6</target>  
            </configuration>  
        </plugin>  
    </plugins>  
  </build>
</project>

报表部分

我们执行mvn site就可以为项目生成一系列可以用来描述项目信息的网页，maven2中的一大部分插件就是专门在这时候发挥效用的，它们可以根据项目的结构，源代码，测试，SCM信息等，生成各种特殊功能的报表，这要把这些插件配置在reporting标签中，它们就会在执行mvn site的同时起作用。

<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.fox</groupId>
  <artifactId>demo</artifactId>
  <version>1.0</version>

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

  <build>
    <plugins>  
        <plugin>  
            <artifactId>maven-compiler-plugin</artifactId>  
            <configuration>  
                <source>1.6</source>  
                <target>1.6</target>  
            </configuration>  
        </plugin>  
    </plugins>  
  </build>

  <reporting>
  </reporting>
</project>