maven - pom.xml文件详解

时间 2019-11-07

标签 maven pom.xml pom xml 文件详解栏目 Maven 繁體版

原文原文链接

settings.xml与pom.xml

settings.xml主要用于配置maven的运行环境等一系列的通用属性，是全局级别的配置文件html

pom.xml主要用于描述项目的坐标，依赖，规则，缺陷管理以及组织，licenses，是项目级别的配置文件java

基础配置

<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.0http://maven.apache.org/xsd/maven-4.0.0.xsd">  
  　
　　<!-- 父项目坐标 -->
　　<parent>

　　　　<!-- 父项目惟一标识 -->
　　　　<groupId></groupId>

　　　　<!-- 父项目构建标识 -->
　　　　<artifactId></artfactId>

　　　　<!-- 父项目构建版本 -->
　　　　<version></version>

　　</parent>
　　　
    <!-- 模型版本 -->  
    <modelVersion>4.0.0</modelVersion>  
  
    <!-- 
　　　　 公司或者组织的惟一标志，而且配置时生成的路径也是由今生成 
　　 　　如com.gc.des，maven会将该项目打成的jar包放本地路径：/com/gc/des -->  
    <groupId>com.gc.des</groupId>  
  
    <!-- 项目的惟一ID，一个groupId下面可能多个项目，经过artifactId区分 -->  
    <artifactId>app-core</artifactId>  
  
    <!-- 项目版本号 -->  
    <version>1.0.0-SNAPSHOT</version>  
  
    <!-- 打包机制，如pom, jar, maven-plugin, war, rar，默认为jar -->  
    <packaging>jar</packaging>  
  　　
　　<!-- 项目名称,用于Maven文档 -->
　　<name>projectName</name>
　　
　　<!-- 项目主页URL,用于Maven产生的文档 -->
　　<url>http://maven.apache.org</url>
　　
　　<!-- 项目详细描述，用于Maven文档 -->
　　<description>a maven project</description>
　　
　　<!-- 模块(子项目),被构建成项目的一部分 -->
　　<modules>

　　　　<!-- 子项目相对路径 -->
　　　　<module></module>

　　</modules>


    <!-- 定义本项目的依赖关系 -->  
    <dependencies>  
  
        <!-- 每一个dependency都对应一个jar包 -->  
        <dependency>  
  
            <!-- 
　　　　　　　　　通常状况下，maven是经过groupId、artifactId、version这三个元素值（GAV俗称坐标）来检索该构件
　　　　　　  　  而后引入你的工程(特殊状况会使用到classifier再进一步检索)。-->
　　　　　　　　  若是别人想引用你如今开发的这个项目（前提是已开发完毕并发布到了远程仓库），   
            　 就须要在他的pom文件中新建一个dependency节点，将本项目的groupId、artifactId、version写入，
　　　　　　　　 maven就会把你上传的jar包下载到他的本地 -->  
            <groupId>com.gc.dsc</groupId>  
            <artifactId>app-core</artifactId>  
            <version>1.0.0-SNAPSHOT</version>  
  
            <!-- 
　　　　　　　　　　maven认为，程序对外部的依赖会随着程序的所处阶段和应用场景而变化，
　　　　　　　　　　因此maven中的依赖关系有做用域(scope)的限制。 
            　　 scope包含以下的取值：compile（编译范围）、provided（已提供范围）、
　　　　　　　　　 runtime（运行时范围）、test（测试范围）、system（系统范围） -->  
            <scope>test</scope>  
  
            <!-- 设置指依赖是否可选，默认为false,即子项目默认都继承。为true,则子项目必需显示的引入  -->  
            <optional>false</optional>  
  
            <!-- 
　　　　　　　　　　屏蔽依赖关系。 好比项目中使用的libA依赖某个库的1.0版，libB依赖某个库的2.0版，
　　　　　　　　　　如今想统一使用2.0版，就应该屏蔽掉对1.0版的依赖 -->  
            <exclusions>  
                <exclusion>  
                    <groupId>org.slf4j</groupId>  
                    <artifactId>slf4j-api</artifactId>  
                </exclusion>  
            </exclusions>  
  
        </dependency>  
  
    </dependencies>  
  　　
　　<!-- 
　　　　继承自本项目的子项目默认依赖信息。
　　　　这部分依赖不会当即被解析，而是当子项目声明一个依赖(包含groupId和artifactId)时，
　　　　经过groupId和artifactId匹配来获取其余依赖信息 -->
　　<dependencymanagement>
　　　　<!-- 参考上文dependencies -->
　　　　<dependencies>
　　　　　　<dependency>
　　　　　　　　<!-- groupId和artifactId是必须的 -->
　　　　　　　　<groupId></groupId>
　　　　　　　　<artifactId></artifactId>
　　　　　　</dependency>
　　　　</dependencies>
 　</depencymanagement>

    <!-- 为pom定义一些常量，在pom中的其它地方能够直接引用 使用方式 以下 ：${file.encoding} -->  
    <properties>  
        <file.encoding>UTF-8</file.encoding>  
        <java.source.version>1.5</java.source.version>  
        <java.target.version>1.5</java.target.version>  
    </properties>  
  
    ...  
</project>

构建配置

<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.0http://maven.apache.org/xsd/maven-4.0.0.xsd"> 

<build>  

    <!-- 产生的构件的文件名，默认值是${artifactId}-${version}。 -->  
    <finalName>name</finalName>  
  
    <!-- 构建产生的全部文件存放的目录,默认为${basedir}/target，即项目根目录下的target -->  
    <directory>${basedir}/target</directory>  
  
    <!--
　　　　　当项目没有规定目标（Maven2叫作阶段（phase））时的默认值， 
        必须跟命令行上的参数相同例如jar:jar，或者与某个阶段（phase）相同例如install、compile等 -->  
    <defaultGoal>install</defaultGoal>  
  
    <!--
　　　　　 当filtering开关打开时，使用到的过滤器属性文件列表。 -->  
    　　　项目配置信息中诸如${spring.version}之类的占位符会被属性文件中的实际值替换掉 -->  
    <filters>  
        <filter>../filter.properties</filter>  
    </filters>  
  
    <!--
　　　　项目相关的全部资源路径列表，例如和项目相关的配置文件、
　　　　属性文件，这些资源被包含在最终的打包文件里。 -->  
    <resources>  
        <resource>  
  
            <!--
　　　　　　　　　描述了资源的目标路径。该路径相对target/classes目录（例如${project.build.outputDirectory}）。 
            　　举个例子，若是你想资源在特定的包里(org.apache.maven.messages)，
　　　　　　　　　你就必须该元素设置为org/apache/maven/messages。  
            　　然而，若是你只是想把资源放到源码目录结构里，就不须要该配置。 -->  
            <targetPath>resources</targetPath>  
  
            <!--
　　　　　　　　　　是否使用参数值代替参数名。
　　　　　　　　　　参数值取自properties元素或者文件里配置的属性，文件在filters元素里列出。 -->  
            <filtering>true</filtering>  
  
            <!--描述存放资源的目录，该路径相对POM路径 -->  
            <directory>src/main/resources</directory>  
  
            <!--包含的模式列表 -->  
            <includes>  
                <include>**/*.properties</include>  
                <include>**/*.xml</include>  
            </includes>  
  
            <!--排除的模式列表 若是<include>与<exclude>划定的范围存在冲突，以<exclude>为准 -->  
            <excludes>  
                <exclude>jdbc.properties</exclude>  
            </excludes>  
  
        </resource>  
    </resources>  
  
    <!--单元测试相关的全部资源路径，配制方法与resources相似 -->  
    <testResources>  
        <testResource>  
            <targetPath />  
            <filtering />  
            <directory />  
            <includes />  
            <excludes />  
        </testResource>  
    </testResources>  
  
    <!--项目源码目录，当构建项目的时候，构建系统会编译目录里的源码。该路径是相对于pom.xml的相对路径。 -->  
    <sourceDirectory>${basedir}\src\main\java</sourceDirectory>  
  
    <!--
　　　　项目脚本源码目录，该目录和源码目录不一样，
　　　　绝大多数状况下，该目录下的内容会被拷贝到输出目录(由于脚本是被解释的，而不是被编译的)。 -->  
    <scriptSourceDirectory>${basedir}\src\main\scripts  
    </scriptSourceDirectory>  
  
    <!--
　　　　项目单元测试使用的源码目录，当测试项目的时候，
　　　　构建系统会编译目录里的源码。该路径是相对于pom.xml的相对路径。 -->  
    <testSourceDirectory>${basedir}\src\test\java</testSourceDirectory>  
  
    <!--被编译过的应用程序class文件存放的目录。 -->  
    <outputDirectory>${basedir}\target\classes</outputDirectory>  
  
    <!--被编译过的测试class文件存放的目录。 -->  
    <testOutputDirectory>${basedir}\target\test-classes  
    </testOutputDirectory>  
  
    <!--
　　　　　　项目的一系列构建扩展,它们是一系列build过程当中要使用的产品，会包含在running bulid‘s classpath里面。  
    　　　 他们能够开启extensions，也能够经过提供条件来激活plugins。   
   　　　　简单来说，extensions是在build过程被激活的产品 -->  
    <extensions>  
  
        <!--
　　　　　　例如，一般状况下，程序开发完成后部署到线上Linux服务器，可能须要经历打包、   
        　将包文件传到服务器、SSH连上服务器、敲命令启动程序等一系列繁琐的步骤。  
          实际上这些步骤均可以经过Maven的一个插件 wagon-maven-plugin 来自动完成  
          下面的扩展插件wagon-ssh用于经过SSH的方式链接远程服务器， 
          相似的还有支持ftp方式的wagon-ftp插件 -->
        <extension>  
            <groupId>org.apache.maven.wagon</groupId>  
            <artifactId>wagon-ssh</artifactId>  
            <version>2.8</version>  
        </extension>  
  
    </extensions>  
  
    <!--使用的插件列表 。 -->  
    <plugins>  
        <plugin>  
            <groupId></groupId>  
            <artifactId>maven-assembly-plugin</artifactId>  
            <version>2.5.5</version>  
  
            <!--在构建生命周期中执行一组目标的配置。每一个目标可能有不一样的配置。 -->  
            <executions>  
                <execution>  
  
                    <!--执行目标的标识符，用于标识构建过程当中的目标，或者匹配继承过程当中须要合并的执行目标 -->  
                    <id>assembly</id>  
  
                    <!--绑定了目标的构建生命周期阶段，若是省略，目标会被绑定到源数据里配置的默认阶段 -->  
                    <phase>package</phase>  
  
                    <!--配置的执行目标 -->  
                    <goals>  
                        <goal>single</goal>  
                    </goals>  
  
                    <!--配置是否被传播到子POM -->  
                    <inherited>false</inherited>  
  
                </execution>  
            </executions>  
  
            <!--做为DOM对象的配置,配置项因插件而异 -->  
            <configuration>  
                <finalName>${finalName}</finalName>  
                <appendAssemblyId>false</appendAssemblyId>  
                <descriptor>assembly.xml</descriptor>  
            </configuration>  
  
            <!--
　　　　　　　　　　是否从该插件下载Maven扩展（例如打包和类型处理器），   
            　　 因为性能缘由，只有在真须要下载时，该元素才被设置成true。 -->  
            <extensions>false</extensions>  
  
            <!--项目引入插件所须要的额外依赖 -->  
            <dependencies>  
                <dependency>...</dependency>  
            </dependencies>  
  
            <!--任何配置是否被传播到子项目 -->  
            <inherited>true</inherited>  
  
        </plugin>  
    </plugins>  
  
    <!--
　　　　 主要定义插件的共同元素、扩展元素集合，相似于dependencyManagement， 
    　　全部继承于此项目的子项目都能使用。该插件配置项直到被引用时才会被解析或绑定到生命周期。   
    　　给定插件的任何本地配置都会覆盖这里的配置 -->  
    <pluginManagement>  
        <plugins>...</plugins>  
    </pluginManagement>  
  
</build>  

</project>

经常使用的配置主要是以上两个，还有可能会用到的是profile配置，能够参考前文 [maven - settings.xml文件详解] 中的profile元素配置spring

其余详细资料可参考：apache