maven入门详解

山山而川907
42 阅读9分钟

一、配置文件解析

配置详解

<!-- 父项目的坐标。如果项目中没有规定某个元素的值，那么父项目中的对应值即为项目的默认值。坐标包括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> 

<!-- 描述了这个项目构建环境中的前提条件。 --> 
<prerequisites> 
    <!-- 构建该项目或使用该插件所需要的Maven的最低版本 --> 
    <maven></maven> 
</prerequisites> 

<!-- 项目的问题管理系统(Bugzilla, Jira, Scarab,或任何你喜欢的问题管理系统)的名称和URL，本例为 jira --> 
<issueManagement> 
    <!-- 问题管理系统（例如jira）的名字， --> 
    <system> jira </system> 

    <!-- 该项目使用的问题管理系统的URL --> 
    <url> http://jira.baidu.com/banseon </url> 
</issueManagement> 

<!-- 项目持续集成信息 --> 
<ciManagement> 
    <!-- 持续集成系统的名字，例如continuum --> 
    <system></system> 

    <!-- 该项目使用的持续集成系统的URL（如果持续集成系统有web接口的话）。 --> 
    <url></url> 

    <!-- 构建完成时，需要通知的开发者/用户的配置项。包括被通知者信息和通知条件（错误，失败，成功，警告） --> 
    <notifiers> 
        <!-- 配置一种方式，当构建中断时，以该方式通知用户/开发者 --> 
        <notifier> 
            <!-- 传送通知的途径 --> 
            <type></type> 

            <!-- 发生错误时是否通知 --> 
            <sendOnError></sendOnError> 

            <!-- 构建失败时是否通知 --> 
            <sendOnFailure></sendOnFailure> 

            <!-- 构建成功时是否通知 --> 
            <sendOnSuccess></sendOnSuccess> 

            <!-- 发生警告时是否通知 --> 
            <sendOnWarning></sendOnWarning> 

            <!-- 不赞成使用。通知发送到哪里 --> 
            <address></address> 

            <!-- 扩展配置项 --> 
            <configuration></configuration> 
        </notifier> 
    </notifiers> 
</ciManagement> 

<!-- 项目创建年份，4位数字。当产生版权信息时需要使用这个值。 --> 
<inceptionYear /> 

<!-- 项目相关邮件列表信息 --> 
<mailingLists> 
    <!-- 该元素描述了项目相关的所有邮件列表。自动产生的网站引用这些信息。 --> 
    <mailingList> 
        <!-- 邮件的名称 --> 
        <name> Demo </name> 

        <!-- 发送邮件的地址或链接，如果是邮件地址，创建文档时，mailto: 链接会被自动创建 --> 
        <post> banseon@126.com </post> 

        <!-- 订阅邮件的地址或链接，如果是邮件地址，创建文档时，mailto: 链接会被自动创建 --> 
        <subscribe> banseon@126.com </subscribe> 

        <!-- 取消订阅邮件的地址或链接，如果是邮件地址，创建文档时，mailto: 链接会被自动创建 --> 
        <unsubscribe> banseon@126.com </unsubscribe> 

        <!-- 你可以浏览邮件信息的URL --> 
        <archive> http:/hi.baidu.com/banseon/demo/dev/ </archive> 
    </mailingList> 
</mailingLists> 

<!-- 项目开发者列表 --> 
<developers> 
    <!-- 某个项目开发者的信息 --> 
    <developer> 
        <!-- SCM里项目开发者的唯一标识符 --> 
        <id> HELLO WORLD </id>
        
        <!-- 项目开发者的全名 --> 
        <name> banseon </name> 

        <!-- 项目开发者的email --> 
        <email> banseon@126.com </email> 

        <!-- 项目开发者的主页的URL --> 
        <url></url> 

        <!-- 项目开发者在项目中扮演的角色，角色元素描述了各种角色 --> 
        <roles> 
            <role> Project Manager </role> 
            <role> Architect </role> 
        </roles> 

        <!-- 项目开发者所属组织 --> 
        <organization> demo </organization> 

        <!-- 项目开发者所属组织的URL --> 
        <organizationUrl> http://hi.baidu.com/xxx </organizationUrl> 

        <!-- 项目开发者属性，如即时消息如何处理等 --> 
        <properties> 
            <dept> No </dept> 
        </properties> 

        <!-- 项目开发者所在时区， -11到12范围内的整数。 --> 
        <timezone> -5 </timezone> 
    </developer> 
</developers> 

<!-- 项目的其他贡献者列表 --> 
<contributors> 
    <!-- 项目的其他贡献者。参见developers/developer元素 --> 
    <contributor> 
        <!-- 项目贡献者的全名 --> 
        <name></name>

        <!-- 项目贡献者的email -->
        <email></email>

        <!-- 项目贡献者的主页的URL -->
        <url></url>

        <!-- 项目贡献者所属组织 -->
        <organization></organization>

        <!-- 项目贡献者所属组织的URL -->
        <organizationUrl></organizationUrl>

        <!-- 项目贡献者在项目中扮演的角色，角色元素描述了各种角色 --> 
        <roles> 
            <role> Project Manager </role> 
            <role> Architect </role> 
        </roles>

        <!-- 项目贡献者所在时区， -11到12范围内的整数。 --> 
        <timezone></timezone>
        
        <!-- 项目贡献者属性，如即时消息如何处理等 --> 
        <properties> 
            <dept> No </dept> 
        </properties>  
    </contributor> 
</contributors> 

<!-- 该元素描述了项目所有License列表。 应该只列出该项目的license列表，不要列出依赖项目的 license列表。
     如果列出多个license，用户可以选择它们中的一个而不是接受所有license。 --> 
<licenses> 
    <!-- 描述了项目的license，用于生成项目的web站点的license页面，其他一些报表和validation也会用到该元素。 --> 
    <license> 
        <!-- license用于法律上的名称 --> 
        <name> Apache 2 </name> 

        <!-- 官方的license正文页面的URL --> 
        <url> http://www.baidu.com/banseon/LICENSE-2.0.txt </url> 

        <!-- 项目分发的主要方式： 
                repo，可以从Maven库下载 
                manual， 用户必须手动下载和安装依赖 --> 
        <distribution> repo </distribution> 

        <!-- 关于license的补充信息 --> 
        <comments> A business-friendly OSS license </comments> 
    </license> 
</licenses> 

<!-- SCM(Source Control Management)标签允许你配置你的代码库，供Maven web站点和其它插件使用。 --> 
<scm> 
    <!-- SCM的URL,该URL描述了版本库和如何连接到版本库。欲知详情，请看SCMs提供的URL格式和列表。该连接只读。 --> 
    <connection> 
        scm:svn:http://svn.baidu.com/banseon/maven/banseon/banseon-maven2-trunk(dao-trunk)
    </connection> 

    <!-- 给开发者使用的，类似connection元素。即该连接不仅仅只读 --> 
    <developerConnection> 
        scm:svn:http://svn.baidu.com/banseon/maven/banseon/dao-trunk 
    </developerConnection> 

    <!-- 当前代码的标签，在开发阶段默认为HEAD --> 
    <tag></tag> 

    <!-- 指向项目的可浏览SCM库（例如ViewVC或者Fisheye）的URL。 --> 
    <url> http://svn.baidu.com/banseon </url> 
</scm> 

<!-- 描述项目所属组织的各种属性。Maven产生的文档用 --> 
<organization> 
    <!-- 组织的全名 --> 
    <name> demo </name> 

    <!-- 组织主页的URL --> 
    <url> http://www.baidu.com/banseon </url> 
</organization> 

<!-- 构建项目需要的信息 --> 
<build> 
    <!-- 该元素设置了项目源码目录，当构建项目的时候，构建系统会编译目录里的源码。该路径是相对
         于pom.xml的相对路径。 --> 
    <sourceDirectory></sourceDirectory> 

    <!-- 该元素设置了项目脚本源码目录，该目录和源码目录不同：绝大多数情况下，该目录下的内容会
         被拷贝到输出目录(因为脚本是被解释的，而不是被编译的)。 --> 
    <scriptSourceDirectory></scriptSourceDirectory> 

    <!-- 该元素设置了项目单元测试使用的源码目录，当测试项目的时候，构建系统会编译目录里的源码。
         该路径是相对于pom.xml的相对路径。 --> 
    <testSourceDirectory></testSourceDirectory> 

    <!-- 被编译过的应用程序class文件存放的目录。 --> 
    <outputDirectory></outputDirectory> 

    <!-- 被编译过的测试class文件存放的目录。 --> 
    <testOutputDirectory></testOutputDirectory> 

    <!-- 使用来自该项目的一系列构建扩展 --> 
    <extensions> 
        <!-- 描述使用到的构建扩展。 --> 
        <extension> 
            <!-- 构建扩展的groupId --> 
            <groupId></groupId> 

            <!-- 构建扩展的artifactId --> 
            <artifactId></artifactId> 

            <!-- 构建扩展的版本 --> 
            <version></version> 
        </extension> 
    </extensions> 

    <!-- 当项目没有规定目标（Maven2 叫做阶段）时的默认值 --> 
    <defaultGoal></defaultGoal> 

    <!-- 这个元素描述了项目相关的所有资源路径列表，例如和项目相关的属性文件，这些资源被包含在
         最终的打包文件里。 --> 
    <resources> 
        <!-- 这个元素描述了项目相关或测试相关的所有资源路径 --> 
        <resource> 
            <!-- 描述了资源的目标路径。该路径相对target/classes目录（例如${project.build.outputDirectory}）。
                 举个例子，如果你想资源在特定的包里(org.apache.maven.messages)，你就必须该元素设置为
                org/apache/maven/messages。然而，如果你只是想把资源放到源码目录结构里，就不需要该配置。 --> 
            <targetPath></targetPath> 

            <!-- 是否使用参数值代替参数名。参数值取自properties元素或者文件里配置的属性，文件在filters元素
                 里列出。 --> 
            <filtering></filtering>

            <!-- 描述存放资源的目录，该路径相对POM路径 --> 
            <directory></directory>

            <!-- 包含的模式列表，例如**/*.xml. --> 
            <includes>
                <include></include>
            </includes>

            <!-- 排除的模式列表，例如**/*.xml -->
            <excludes>
                <exclude></exclude>
            </excludes>
        </resource> 
    </resources> 

    <!-- 这个元素描述了单元测试相关的所有资源路径，例如和单元测试相关的属性文件。 --> 
    <testResources> 
        <!-- 这个元素描述了测试相关的所有资源路径，参见build/resources/resource元素的说明 --> 
        <testResource> 
            <!-- 描述了测试相关的资源的目标路径。该路径相对target/classes目录（例如${project.build.outputDirectory}）。
                 举个例子，如果你想资源在特定的包里(org.apache.maven.messages)，你就必须该元素设置为
                org/apache/maven/messages。然而，如果你只是想把资源放到源码目录结构里，就不需要该配置。 --> 
            <targetPath></targetPath> 

            <!-- 是否使用参数值代替参数名。参数值取自properties元素或者文件里配置的属性，文件在filters元素
                 里列出。 --> 
            <filtering></filtering>

            <!-- 描述存放测试相关的资源的目录，该路径相对POM路径 --> 
            <directory></directory>

            <!-- 包含的模式列表，例如**/*.xml. --> 
            <includes>
                <include></include>
            </includes>

            <!-- 排除的模式列表，例如**/*.xml -->
            <excludes>
                <exclude></exclude>
            </excludes> 
        </testResource> 
    </testResources> 

    <!-- 构建产生的所有文件存放的目录 --> 
    <directory></directory> 

    <!-- 产生的构件的文件名，默认值是${artifactId}-${version}。 --> 
    <finalName></finalName> 

    <!-- 当filtering开关打开时，使用到的过滤器属性文件列表 --> 
    <filters></filters> 

    <!-- 子项目可以引用的默认插件信息。该插件配置项直到被引用时才会被解析或绑定到生命周期。给定插件的任何本
         地配置都会覆盖这里的配置 --> 
    <pluginManagement> 
        <!-- 使用的插件列表 。 --> 
        <plugins> 
            <!-- plugin元素包含描述插件所需要的信息。 --> 
            <plugin> 
                <!-- 插件在仓库里的group ID --> 
                <groupId></groupId> 

                <!-- 插件在仓库里的artifact ID --> 
                <artifactId></artifactId> 

                <!-- 被使用的插件的版本（或版本范围） --> 
                <version></version> 

                <!-- 是否从该插件下载Maven扩展（例如打包和类型处理器），由于性能原因，只有在真需要下载时，该
                     元素才被设置成enabled。 --> 
                <extensions>true/false</extensions> 

                <!-- 在构建生命周期中执行一组目标的配置。每个目标可能有不同的配置。 --> 
                <executions> 
                    <!-- execution元素包含了插件执行需要的信息 --> 
                    <execution> 
                        <!-- 执行目标的标识符，用于标识构建过程中的目标，或者匹配继承过程中需要合并的执行目标 --> 
                        <id></id>

                        <!-- 绑定了目标的构建生命周期阶段，如果省略，目标会被绑定到源数据里配置的默认阶段 --> 
                        <phase></phase>

                        <!-- 配置的执行目标 --> 
                        <goals></goals> 

                        <!-- 配置是否被传播到子POM --> 
                        <inherited>true/false</inherited> 

                        <!-- 作为DOM对象的配置 --> 
                        <configuration></configuration>
                    </execution> 
                </executions> 

                <!-- 项目引入插件所需要的额外依赖 --> 
                <dependencies>
                    <!-- 参见dependencies/dependency元素 --> 
                    <dependency> 
                    </dependency> 
                </dependencies> 

                <!-- 任何配置是否被传播到子项目 --> 
                <inherited>true/false</inherited>

                <!-- 作为DOM对象的配置 --> 
                <configuration></configuration>
            </plugin> 
        </plugins> 
    </pluginManagement> 

    <!-- 该项目使用的插件列表 。 --> 
    <plugins> 
        <!-- plugin元素包含描述插件所需要的信息。 --> 
        <plugin> 
            <!-- 插件在仓库里的group ID --> 
            <groupId></groupId> 

            <!-- 插件在仓库里的artifact ID --> 
            <artifactId></artifactId> 

            <!-- 被使用的插件的版本（或版本范围） --> 
            <version></version> 

            <!-- 是否从该插件下载Maven扩展（例如打包和类型处理器），由于性能原因，只有在真需要下载时，该
                 元素才被设置成enabled。 --> 
            <extensions>true/false</extensions> 

            <!-- 在构建生命周期中执行一组目标的配置。每个目标可能有不同的配置。 --> 
            <executions> 
                <!-- execution元素包含了插件执行需要的信息 --> 
                <execution> 
                    <!-- 执行目标的标识符，用于标识构建过程中的目标，或者匹配继承过程中需要合并的执行目标 --> 
                    <id></id>

                    <!-- 绑定了目标的构建生命周期阶段，如果省略，目标会被绑定到源数据里配置的默认阶段 --> 
                    <phase></phase>

                    <!-- 配置的执行目标 --> 
                    <goals></goals> 

                    <!-- 配置是否被传播到子POM --> 
                    <inherited>true/false</inherited> 

                    <!-- 作为DOM对象的配置 --> 
                    <configuration></configuration>
                </execution> 
            </executions> 

            <!-- 项目引入插件所需要的额外依赖 --> 
            <dependencies>
                <!-- 参见dependencies/dependency元素 --> 
                <dependency> 
                </dependency> 
            </dependencies> 

            <!-- 任何配置是否被传播到子项目 --> 
            <inherited>true/false</inherited> 

            <!-- 作为DOM对象的配置 --> 
            <configuration></configuration> 
        </plugin> 
    </plugins>
</build> 

<!-- 在列的项目构建profile，如果被激活，会修改构建处理 --> 
<profiles> 
    <!-- 根据环境参数或命令行参数激活某个构建处理 --> 
    <profile> 
        <!-- 构建配置的唯一标识符。即用于命令行激活，也用于在继承时合并具有相同标识符的profile。 --> 
        <id></id>

        <!-- 自动触发profile的条件逻辑。Activation是profile的开启钥匙。profile的力量来自于它能够
             在某些特定的环境中自动使用某些特定的值；这些环境通过activation元素指定。activation元
             素并不是激活profile的唯一方式。 --> 
        <activation> 
            <!-- profile默认是否激活的标志 --> 
            <activeByDefault>true/false</activeByDefault> 

            <!-- 当匹配的jdk被检测到，profile被激活。例如，1.4激活JDK1.4，1.4.0_2，而!1.4激活所有版本
                 不是以1.4开头的JDK。 --> 
            <jdk>jdk版本，如:1.7</jdk> 

            <!-- 当匹配的操作系统属性被检测到，profile被激活。os元素可以定义一些操作系统相关的属性。 --> 
            <os> 
                <!-- 激活profile的操作系统的名字 --> 
                <name> Windows XP </name> 

                <!-- 激活profile的操作系统所属家族(如 'windows') --> 
                <family> Windows </family> 

                <!-- 激活profile的操作系统体系结构 --> 
                <arch> x86 </arch> 

                <!-- 激活profile的操作系统版本 --> 
                <version> 5.1.2600 </version> 
            </os> 

            <!-- 如果Maven检测到某一个属性（其值可以在POM中通过${名称}引用），其拥有对应的名称和值，Profile
                 就会被激活。如果值字段是空的，那么存在属性名称字段就会激活profile，否则按区分大小写方式匹
                 配属性值字段 --> 
            <property> 
                <!-- 激活profile的属性的名称 --> 
                <name> mavenVersion </name> 

                <!-- 激活profile的属性的值 --> 
                <value> 2.0.3 </value> 
            </property> 

            <!-- 提供一个文件名，通过检测该文件的存在或不存在来激活profile。missing检查文件是否存在，如果不存在则激活 
                 profile。另一方面，exists则会检查文件是否存在，如果存在则激活profile。 --> 
            <file> 
                <!-- 如果指定的文件存在，则激活profile。 --> 
                <exists> /usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/ </exists> 

                <!-- 如果指定的文件不存在，则激活profile。 --> 
                <missing> /usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/ </missing> 
            </file> 
        </activation> 

        <!-- 构建项目所需要的信息。参见build元素 --> 
        <build> 
            <defaultGoal /> 
            <resources> 
                <resource> 
                    <targetPath></targetPath>
                    <filtering></filtering>
                    <directory></directory>
                    <includes>
                        <include></include>
                    </includes>
                    <excludes>
                        <exclude></exclude>
                    </excludes>
                </resource> 
            </resources> 
            <testResources> 
                <testResource> 
                    <targetPath></targetPath>
                    <filtering></filtering>
                    <directory></directory>
                    <includes>
                        <include></include>
                    </includes>
                    <excludes>
                        <exclude></exclude>
                    </excludes> 
                </testResource> 
            </testResources> 
            <directory></directory>
            <finalName></finalName>
            <filters></filters> 
            <pluginManagement> 
                <plugins> 
                    <!-- 参见build/pluginManagement/plugins/plugin元素 --> 
                    <plugin> 
                        <groupId></groupId>
                        <artifactId></artifactId>
                        <version></version>
                        <extensions>true/false</extensions> 
                        <executions> 
                            <execution> 
                                <id></id>
                                <phase></phase>
                                <goals></goals>
                                <inherited>true/false</inherited>
                                <configuration></configuration> 
                            </execution> 
                        </executions> 
                        <dependencies> 
                            <!-- 参见dependencies/dependency元素 --> 
                            <dependency> 
                            </dependency> 
                        </dependencies> 
                        <goals></goals>
                        <inherited>true/false</inherited>
                        <configuration></configuration>
                    </plugin> 
                </plugins> 
            </pluginManagement> 
            <plugins> 
                <!-- 参见build/pluginManagement/plugins/plugin元素 --> 
                <plugin> 
                    <groupId></groupId>
                    <artifactId></artifactId>
                    <version></version>
                    <extensions>true/false</extensions> 
                    <executions> 
                        <execution> 
                            <id></id>
                            <phase></phase>
                            <goals></goals>
                            <inherited>true/false</inherited>
                            <configuration></configuration> 
                        </execution> 
                    </executions> 
                    <dependencies> 
                        <!-- 参见dependencies/dependency元素 --> 
                        <dependency> 
                        </dependency> 
                    </dependencies> 
                    <goals></goals>
                    <inherited>true/false</inherited>
                    <configuration></configuration> 
                </plugin> 
            </plugins> 
        </build> 

        <!-- 模块（有时称作子项目） 被构建成项目的一部分。列出的每个模块元素是指向该模块的目录的
             相对路径 --> 
        <modules>
            <!--子项目相对路径-->
            <module></module>
        </modules> 

        <!-- 发现依赖和扩展的远程仓库列表。 --> 
        <repositories> 
            <!-- 参见repositories/repository元素 --> 
            <repository> 
                <releases> 
                    <enabled><enabled>
                    <updatePolicy></updatePolicy>
                    <checksumPolicy></checksumPolicy> 
                </releases> 
                <snapshots> 
                    <enabled><enabled>
                    <updatePolicy></updatePolicy>
                    <checksumPolicy></checksumPolicy> 
                </snapshots> 
                <id></id>
                <name></name>
                <url></url>
                <layout></layout> 
            </repository> 
        </repositories> 

        <!-- 发现插件的远程仓库列表，这些插件用于构建和报表 --> 
        <pluginRepositories> 
            <!-- 包含需要连接到远程插件仓库的信息.参见repositories/repository元素 --> 
            <pluginRepository> 
                <releases> 
                    <enabled><enabled>
                    <updatePolicy></updatePolicy>
                    <checksumPolicy></checksumPolicy> 
                </releases> 
                <snapshots> 
                    <enabled><enabled>
                    <updatePolicy></updatePolicy>
                    <checksumPolicy></checksumPolicy>
                </snapshots> 
                <id></id>
                <name></name>
                <url></url>
                <layout></layout> 
            </pluginRepository> 
        </pluginRepositories> 

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

        <!-- 不赞成使用. 现在Maven忽略该元素. --> 
        <reports></reports> 

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

        <!-- 参见dependencyManagement元素 --> 
        <dependencyManagement> 
            <dependencies> 
                <!-- 参见dependencies/dependency元素 --> 
                <dependency> 
                </dependency> 
            </dependencies> 
        </dependencyManagement> 

        <!-- 参见distributionManagement元素 --> 
        <distributionManagement> 
        </distributionManagement> 

        <!-- 参见properties元素 --> 
        <properties /> 
    </profile> 
</profiles> 

<!-- 模块（有时称作子项目） 被构建成项目的一部分。列出的每个模块元素是指向该模块的目录的相对路径 --> 
<modules>
    <!--子项目相对路径-->
    <module></module>
</modules> 

<!-- 发现依赖和扩展的远程仓库列表。 --> 
<repositories> 
    <!-- 包含需要连接到远程仓库的信息 --> 
    <repository> 
        <!-- 如何处理远程仓库里发布版本的下载 --> 
        <releases> 
            <!-- true或者false表示该仓库是否为下载某种类型构件（发布版，快照版）开启。 --> 
            <enabled><enabled> 

            <!-- 该元素指定更新发生的频率。Maven会比较本地POM和远程POM的时间戳。这里的选项是：always（一直），
                 daily（默认，每日），interval：X（这里X是以分钟为单位的时间间隔），或者never（从不）。 --> 
            <updatePolicy></updatePolicy> 

            <!-- 当Maven验证构件校验文件失败时该怎么做：ignore（忽略），fail（失败），或者warn（警告）。 --> 
            <checksumPolicy></checksumPolicy> 
        </releases> 

        <!-- 如何处理远程仓库里快照版本的下载。有了releases和snapshots这两组配置，POM就可以在每个单独的仓库中，
             为每种类型的构件采取不同的策略。例如，可能有人会决定只为开发目的开启对快照版本下载的支持。参见repositories/repository/releases元素 --> 
        <snapshots> 
            <enabled><enabled>
            <updatePolicy></updatePolicy>
            <checksumPolicy></checksumPolicy> 
        </snapshots> 

        <!-- 远程仓库唯一标识符。可以用来匹配在settings.xml文件里配置的远程仓库 --> 
        <id> banseon-repository-proxy </id> 

        <!-- 远程仓库名称 --> 
        <name> banseon-repository-proxy </name> 

        <!-- 远程仓库URL，按protocol://hostname/path形式 --> 
        <url> http://192.168.1.169:9999/repository/ </url> 

        <!-- 用于定位和排序构件的仓库布局类型-可以是default（默认）或者legacy（遗留）。Maven 2为其仓库提供了一个默认
             的布局；然而，Maven 1.x有一种不同的布局。我们可以使用该元素指定布局是default（默认）还是legacy（遗留）。 --> 
        <layout> default </layout> 
    </repository> 
</repositories> 

<!-- 发现插件的远程仓库列表，这些插件用于构建和报表 --> 
<pluginRepositories> 
    <!-- 包含需要连接到远程插件仓库的信息.参见repositories/repository元素 --> 
    <pluginRepository> 
    </pluginRepository> 
</pluginRepositories> 

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

        <!-- 依赖的artifact ID --> 
        <artifactId> maven-artifact </artifactId> 

        <!-- 依赖的版本号。 在Maven 2里, 也可以配置成版本号的范围。 --> 
        <version> 3.8.1 </version> 

        <!-- 依赖类型，默认类型是jar。它通常表示依赖的文件的扩展名，但也有例外。一个类型可以被映射成另外一个扩展
             名或分类器。类型经常和使用的打包方式对应，尽管这也有例外。一些类型的例子：jar，war，ejb-client和test-jar。
             如果设置extensions为 true，就可以在plugin里定义新的类型。所以前面的类型的例子不完整。 --> 
        <type> jar </type> 

        <!-- 依赖的分类器。分类器可以区分属于同一个POM，但不同构建方式的构件。分类器名被附加到文件名的版本号后面。例如，
             如果你想要构建两个单独的构件成JAR，一个使用Java 1.4编译器，另一个使用Java 6编译器，你就可以使用分类器来生
             成两个单独的JAR构件。 --> 
        <classifier></classifier> 

        <!-- 依赖范围。在项目发布过程中，帮助决定哪些构件被包括进来。欲知详情请参考依赖机制。 
            - compile ：默认范围，用于编译 
            - provided：类似于编译，但支持你期待jdk或者容器提供，类似于classpath 
            - runtime: 在执行时需要使用 
            - test: 用于test任务时使用 
            - system: 需要外在提供相应的元素。通过systemPath来取得 
            - systemPath: 仅用于范围为system。提供相应的路径 
            - optional: 当项目自身被依赖时，标注依赖是否传递。用于连续依赖时使用 --> 
        <scope> test </scope> 

        <!-- 仅供system范围使用。注意，不鼓励使用这个元素，并且在新的版本中该元素可能被覆盖掉。该元素为依赖规定了文件
             系统上的路径。需要绝对路径而不是相对路径。推荐使用属性匹配绝对路径，例如${java.home}。 --> 
        <systemPath></systemPath> 

        <!-- 当计算传递依赖时， 从依赖构件列表里，列出被排除的依赖构件集。即告诉maven你只依赖指定的项目，不依赖项目的
             依赖。此元素主要用于解决版本冲突问题 --> 
        <exclusions> 
            <exclusion> 
                <artifactId> spring-core </artifactId> 
                <groupId> org.springframework </groupId> 
            </exclusion> 
        </exclusions> 

        <!-- 可选依赖，如果你在项目B中把C依赖声明为可选，你就需要在依赖于B的项目（例如项目A）中显式的引用对C的依赖。
             可选依赖阻断依赖的传递性。 --> 
        <optional> true </optional> 
    </dependency> 
</dependencies> 

<!-- 不赞成使用. 现在Maven忽略该元素. --> 
<reports></reports> 

<!-- 该元素描述使用报表插件产生报表的规范。当用户执行“mvn site”，这些报表就会运行。 在页面导航栏能看到所有报表的链接。 --> 
<reporting> 
    <!-- true，则，网站不包括默认的报表。这包括“项目信息”菜单中的报表。 --> 
    <excludeDefaults /> 

    <!-- 所有产生的报表存放到哪里。默认值是${project.build.directory}/site。 --> 
    <outputDirectory /> 

    <!-- 使用的报表插件和他们的配置。 --> 
    <plugins> 
        <!-- plugin元素包含描述报表插件需要的信息 --> 
        <plugin> 
            <!-- 报表插件在仓库里的group ID --> 
            <groupId></groupId> 
            <!-- 报表插件在仓库里的artifact ID --> 
            <artifactId></artifactId> 

            <!-- 被使用的报表插件的版本（或版本范围） --> 
            <version></version> 

            <!-- 任何配置是否被传播到子项目 --> 
            <inherited>true/false</inherited> 

            <!-- 报表插件的配置 --> 
            <configuration></configuration> 

            <!-- 一组报表的多重规范，每个规范可能有不同的配置。一个规范（报表集）对应一个执行目标 。例如，
                 有1，2，3，4，5，6，7，8，9个报表。1，2，5构成A报表集，对应一个执行目标。2，5，8构成B报
                 表集，对应另一个执行目标 --> 
            <reportSets> 
                <!-- 表示报表的一个集合，以及产生该集合的配置 --> 
                <reportSet> 
                    <!-- 报表集合的唯一标识符，POM继承时用到 --> 
                    <id></id> 

                    <!-- 产生报表集合时，被使用的报表的配置 --> 
                    <configuration></configuration> 

                    <!-- 配置是否被继承到子POMs --> 
                    <inherited>true/false</inherited> 

                    <!-- 这个集合里使用到哪些报表 --> 
                    <reports></reports> 
                </reportSet> 
            </reportSets> 
        </plugin> 
    </plugins> 
</reporting> 

<!-- 继承自该项目的所有子项目的默认依赖信息。这部分的依赖信息不会被立即解析,而是当子项目声明一个依赖
    （必须描述group ID和artifact ID信息），如果group ID和artifact ID以外的一些信息没有描述，则通过
        group ID和artifact ID匹配到这里的依赖，并使用这里的依赖信息。 --> 
<dependencyManagement> 
    <dependencies> 
        <!-- 参见dependencies/dependency元素 --> 
        <dependency> 
        </dependency> 
    </dependencies> 
</dependencyManagement> 

<!-- 项目分发信息，在执行mvn deploy后表示要发布的位置。有了这些信息就可以把网站部署到远程服务器或者
     把构件部署到远程仓库。 --> 
<distributionManagement> 
    <!-- 部署项目产生的构件到远程仓库需要的信息 --> 
    <repository> 
        <!-- 是分配给快照一个唯一的版本号（由时间戳和构建流水号）？还是每次都使用相同的版本号？参见
             repositories/repository元素 --> 
        <uniqueVersion /> 
        <id> banseon-maven2 </id> 
        <name> banseon maven2 </name> 
        <url> file://${basedir}/target/deploy </url> 
        <layout></layout> 
    </repository> 

    <!-- 构件的快照部署到哪里？如果没有配置该元素，默认部署到repository元素配置的仓库，参见
         distributionManagement/repository元素 --> 
    <snapshotRepository> 
        <uniqueVersion /> 
        <id> banseon-maven2 </id> 
        <name> Banseon-maven2 Snapshot Repository </name> 
        <url> scp://svn.baidu.com/banseon:/usr/local/maven-snapshot </url> 
        <layout></layout>
    </snapshotRepository> 

    <!-- 部署项目的网站需要的信息 --> 
    <site> 
        <!-- 部署位置的唯一标识符，用来匹配站点和settings.xml文件里的配置 --> 
        <id> banseon-site </id> 

        <!-- 部署位置的名称 --> 
        <name> business api website </name> 

        <!-- 部署位置的URL，按protocol://hostname/path形式 --> 
        <url> 
            scp://svn.baidu.com/banseon:/var/www/localhost/banseon-web 
        </url> 
    </site> 

    <!-- 项目下载页面的URL。如果没有该元素，用户应该参考主页。使用该元素的原因是：帮助定位
         那些不在仓库里的构件（由于license限制）。 --> 
    <downloadUrl /> 

    <!-- 如果构件有了新的group ID和artifact ID（构件移到了新的位置），这里列出构件的重定位信息。 --> 
    <relocation> 
        <!-- 构件新的group ID --> 
        <groupId></groupId> 

        <!-- 构件新的artifact ID --> 
        <artifactId></artifactId> 

        <!-- 构件新的版本号 --> 
        <version></version> 

        <!-- 显示给用户的，关于移动的额外信息，例如原因。 --> 
        <message></message> 
    </relocation> 

    <!-- 给出该构件在远程仓库的状态。不得在本地项目中设置该元素，因为这是工具自动更新的。有效的值
         有：none（默认），converted（仓库管理员从Maven 1 POM转换过来），partner（直接从伙伴Maven 
         2仓库同步过来），deployed（从Maven 2实例部署），verified（被核实时正确的和最终的）。 --> 
    <status></status> 
</distributionManagement> 

<!-- 以值替代名称，Properties可以在整个POM中使用，也可以作为触发条件（见settings.xml配置文件里
     activation元素的说明）。格式是<name>value</name>。 --> 
<properties>
    <name>value</name>
</properties>

依赖范围(scope)

  • compile:默认的依赖范围，表示参与当前项目的编译、测试、运行，是较强的依赖
  • test:表示只参与测试相关工作，包括测试代码编译运行。例如Junit
  • runntime:表示不参与编译，但是参与到后期测试和运行中。
  • provided:表示打包时排除，其他容器会提供。
  • system:从参与程度上来说，和 provided 类似，但不通过 Maven 仓库解析，需要指定文件路径，要谨慎使用。 图片

传递性依赖

A项目依赖B，B依赖C。那么C就会成为A的范围依赖，C是A的一个传递性依赖：

image.png

有了传递性依赖机制，在使用Spring Framework的时候就不用去考虑它依赖了什么，也不用担心引入多余的依赖。Maven会解析各个直接依赖的POM，将那些必要的间接依赖，以传递性依赖的形式引入到当前的项目中。

依赖可选(optional)

如上传递性依赖，C是A的传递性依赖，但是我不想使用，那么我可以在B的依赖上添加optional=true

<project>  
    <modelVersion>4.0.0</modelVersion>  
    <groupId>com.itwanger</groupId>  
    <artifactId>project-b</artifactId>  
    <version>1.0.0</version>  
    <dependencies>  
        <dependency>  
            <groupId>mysql</groupId>  
            <artifactId>mysql-connector-java</artifactId>  
            <version>5.1.10</version>  
            <optional>true</optional>  
        </dependency>  
        <dependency>  
            <groupId>postgresql</groupId>  
            <artifactId>postgresql</groupId>  
            <version>8.4-701.jdbc3</version>  
            <optional>true</optional>  
        </dependency>  
    </dependencies>  
</project>

依赖排除

有时候你引入的依赖中包含你不想要的依赖包，你想引入自己想要的，这时候就要用到排除依赖了，比如下图中spring-boot-starter-web自带了logback这个日志包，我想引入log4j2的，所以我先排除掉logback的依赖包，再引入想要的包就行了。

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-web</artifactId>
 <version>2.5.6</version>
 <exclusions>
  <exclusion>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-logging</artifactId>
  </exclusion>
 </exclusions>
</dependency>
<!-- 使用 log4j2 -->
<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-log4j2</artifactId>
 <version>2.5.6</version>
</dependency>

声明exclustion的时候只需要groupId和artifactId，不需要version元素，因为groupId和artifactId就能唯一定位某个依赖。

依赖冲突

依赖冲突是指项目依赖的某一个jar包，有多个不同的版本，因而造成了包版本冲突。

我们在maven项目的pom中 一般会引用许许多多的dependency。例如，项目A有这样的依赖关系：

A -> C -> X(1.0)
B -> D -> X(2.0)

X是A的传递性依赖，但是两条依赖路径上有两个版本的X,那么哪个X会被Maven解析使用呢? 两个版本都被解析显然是不对的，因为那会造成依赖重复，因此必须选择一个。

冲突解决： 一般利用插件找出依赖路径，选择需要的依赖版本，然后通过exclusions去除掉不想要的重复版本即可。

依赖上传

当我们的maven配置了连接的远程仓库，并且想让其他成员使用我们自己的项目构件，这时候需要配置distributionManagement元素：

<distributionManagement>
        <repository>
            <id>releases</id>
            <name>public</name>
            <url>http://59.50.95.66:8081/nexus/content/repositories/releases</url>
        </repository>
        <snapshotRepository>
            <id>snapshots</id>
            <name>Snapshots</name>
            <url>http://59.50.95.66:8081/nexus/content/repositories/snapshots</url>
        </snapshotRepository>
</distributionManagement>
  • repository表示发布版本构件的仓库。
  • snapshotRepository 表示快照版本（开发测试用）的仓库。
  • 这两个元素都需要配置id、name和url，id为远程仓库的唯一标识，name是为了方便阅读，url表示仓库的地址。

配置好了以后运行命令 mvn clean deploy，Maven就会将项目部署到对应的远程仓库。项目是快照还是发布版本通过之前远程仓库配置项中的 releases 和 snapshots 来区分。

二、Maven 仓库

在 Maven 的术语中，仓库是一个位置（place），项目中依赖的第三方库以及插件（可统称为构件），都放在这里。所有的 Maven 项目都可以共享这个仓库，只需要根据依赖的坐标，就可以在需要的时候找到仓库中的依赖，并使用它们。

仓库分为本地仓库、远程仓库：

图片

本地仓库

当Maven在执行编译或测试时，如果需要使用依赖文件，它总是基于坐标使用本地仓库的依赖文件。

如果你想自定义本地仓库目录地址，可以编辑conf目录下文件settings.xml，设置localRepository元素的值为你想要的仓库地址，例如:

<localRepository>/path/to/local/repo</localRepository>

远程仓库

默认情况下，本地仓库是被注释掉的，也就是空的，那么就必须得给 Maven 配置一个可用的远程仓库，否则 Maven 在 build（构建）的时候就无法去下载依赖。

中央仓库就是这样一个可用的远程仓库，里面包含了这个世界上绝大多数流行的开源 Java 类库，以及源码、作者信息、许可证信息等等。

不过，默认的中央仓库访问速度比较慢，通常我们会选择使用阿里的 Maven 远程仓库。

<repositories>
 <repository>
  <id>ali-maven</id>
  <url>http://maven.aliyun.com/nexus/content/groups/public</url>
  <releases>
   <enabled>true</enabled>
  </releases>
  <snapshots>
   <enabled>true</enabled>
   <updatePolicy>always</updatePolicy>
   <checksumPolicy>fail</checksumPolicy>
  </snapshots>
 </repository>
</repositories>
  • repositories 可以包含一个或者多个repository元素，以声明一个或者多个仓库。
  • id，仓库声明的唯一id，需要注意的是，Maven自带的中央仓库使用的id为central，如果其他仓库也使用了该id，就会覆盖中央仓库的配置。
  • url，指向了仓库的地址。
  • releases和snapshots，用来控制Maven对于发布版构件和快照版构件的下载权限。
  • enabled子元素为 true 时表示可以从仓库下载发布版构件和快照版构件。
  • updatePolicy 子元素用来配置Maven从远处仓库检查更新的频率。
    • 默认值是daily，表示每天检查一次；
    • 可选值 never 表示从不检查；
    • 可选值always表示每次构建时检查更新；
    • 可选值interval表示每隔X分钟检查一次更新（X为任意整数）。
  • checksumPolicy 子元素用来配置Maven检查校验的策略。在下载构件的时候，Maven会去校验，如果校验失败，
    • 当checksumPolicy的值为默认的warn时，Maven会在执行构建时输出警告信息；
    • 值为fail 时，Maven遇到校验错误就让构建失败；
    • 值为ignore时，Maven将完全忽略校验。

仓库镜像

如果仓库X可以提供仓库Y存储的所有内容，那么就可以认为X是Y的一个镜像。通常我们会在 settings.xml 文件中添加阿里云镜像：

<mirrors>
    <mirror>
      <id>alimaven</id>
      <name>aliyun maven</name>
      <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
      <mirrorOf>central</mirrorOf>        
    </mirror>
  </mirrors>

其中 mirrorOf 元素的可选项有：

  • <mirrorOf>*</mirrorOf>，匹配所有远程仓库。
  • <mirrorOf>external:*</mirrorOf>，匹配所有远程仓库，使用localhost的除外，使用 file:// 协议的除外。也就是说，匹配所有不在本机上的远程仓库。
  • <mirrorOf>repo1,repo2</mirrorOf>，匹配仓库repo1和repo2，使用逗号分隔多个远程仓库。
  • <mirrorOf>*,!repo1<mirrorOf>，匹配所有远程仓库，repo1除外，使用感叹号将仓库从匹配中排除。

上例中 <mirrorOf>central</mirrorOf> 表示任何对于中央仓库的请求都会转至该镜像。

私服

私服是一种特殊的远程仓库，它架设在局域网内中，私服代理广域网上的远程仓库，供局域网内的Maven用户使用。当Maven需要下载构件的时候，先从私服请求，如果私服上不存在该构件，则从外部的远程仓库下载，并缓存到私服上。

私服有以下好处：

  • 节省外网访问速度
  • 加速Maven构建
  • 提高稳定性，增强控制
  • 降低中央仓库的负荷

仓库服务搜索

推荐 2 个提供仓库搜索服务的网站：

三、使用 Maven

Maven 常见命令

  • mvn clean：表示运行清理操作（会默认把target文件夹中的数据清理）。
  • mvn clean compile：表示先运行清理之后运行编译，会将代码编译到target文件夹中。
  • mvn clean test：运行清理和测试。
  • mvn clean package：运行清理和打包。
  • mvn clean install：运行清理和安装，会将打好的包安装到本地仓库中，以便其他的项目可以调用。
  • mvn clean deploy：运行清理和发布（发布到私服上面）。

Maven 常用 POM 属性

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

Intellij IDEA 配置 Maven

在配置搜索maven即可： image.png

Maven 常用插件

插件是Maven的核心功能，它允许在多个项目中重用通用的构建逻辑。插件可用于：

  • 创建jar文件，
  • 创建war文件，
  • 编译代码，
  • 单元测试代码，
  • 创建项目文档等。

常用的插件有：

  • maven-antrun-plugin，让用户在 Maven 项目中运行 Ant 任务。用户可以直接在该插件的配置以 Ant 的方式编写 Target，然后交给该插件的 run 目标去执行。在一些由 Ant 往 Maven 迁移的项目中，该插件尤其有用。此外当你发现需要编写一些自定义程度很高的任务，同时又觉得 Maven 不够灵活时，也可以以 Ant 的方式实现之。maven-antrun-plugin 的 run 目标通常与生命周期绑定运行。
  • maven-assembly-plugin，制作项目分发包，该分发包可能包含了项目的可执行文件、源代码、readme、平台脚本等等。maven-assembly-plugin 支持各种主流的格式如 zip、tar.gz、jar 和 war 等，具体打包哪些文件是高度可控的，例如用户可以按文件级别的粒度、文件集级别的粒度、模块级别的粒度、以及依赖级别的粒度控制打包，此外，包含和排除配置也是支持的。maven-assembly-plugin 要求用户使用一个名为assembly.xml的元数据文件来表述打包，它的 single 目标可以直接在命令行调用，也可以被绑定至生命周期。
  • maven-help-plugin，一个小巧的辅助工具，最简单的help:system可以打印所有可用的环境变量和 Java 系统属性。help:effective-pom和help:effective-settings最为有用，它们分别打印项目的有效 POM 和有效 settings，有效 POM 是指合并了所有父 POM（包括 Super POM）后的 XML，当你不确定 POM 的某些信息从何而来时，就可以查看有效 POM。
  • maven-javadoc-plugin，javadoc 插件，将源码的 javadoc 发布出去。
avatar
文章
阅读
粉丝