maven 中 pom 中标签含义

55 篇文章 0 订阅

参考Maven实践(十一)—POM文件中各种元素的含义

标签

maven 官方 Documentation
pom作为项目对象模型。通过xml表示maven项目使用pom.xml来实现。主要描述了项目:包括配置文件开发者需要遵循的规则缺陷管理系统,组织和licenses,项目的url,项目的依赖性,以及其他所有的项目相关因素。

<span style="padding:0px; margin:0px"><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/maven-v4_0_0.xsd">     
    <!--父项目的坐标。如果项目中没有规定某个元素的值,那么父项目中的对应值即为项目的默认值。 坐标包括group ID,artifact ID和 version。-->    
    <parent>    
     <!--被继承的父项目的构件标识符-->    
     <artifactId/>    
     <!--被继承的父项目的全球唯一标识符-->    
     <groupId/>    
     <!--被继承的父项目的版本-->    
     <version/>    
     <!-- 父项目的pom.xml文件的相对路径。相对路径允许你选择一个不同的路径。默认值是../pom.xml。
     Maven首先在构建当前项目的地方寻找父项 目的pom,其次在文件系统的这个位置(relativePath位置),
     然后在本地仓库,最后在远程仓库寻找父项目的pom。-->    
     <relativePath/>    
 </parent>    
 <!--声明项目描述符遵循哪一个POM模型版本。模型本身的版本很少改变,虽然如此,但它仍然是必不可少的,这是为了当Maven引入了新的特性或者其他模型变更的时候,确保稳定性。-->       
    <modelVersion>4.0.0</modelVersion>     
    <!--项目的全球唯一标识符,通常使用全限定的包名区分该项目和其他项目。并且构建时生成的路径也是由此生成, 如com.mycompany.app生成的相对路径为:/com/mycompany/app-->     
    <groupId>asia.banseon</groupId>     
    <!-- 构件的标识符,它和group ID一起唯一标识一个构件。换句话说,你不能有两个不同的项目拥有同样的artifact ID和groupID;在某个 特定的group ID下,artifact ID也必须是唯一的。构件是项目产生的或使用的一个东西,Maven为项目产生的构件包括:JARs,源 码,二进制发布和WARs等。-->     
    <artifactId>banseon-maven2</artifactId>     
    <!--项目产生的构件类型,例如jar、war、ear、pom。插件可以创建他们自己的构件类型,所以前面列的不是全部构件类型-->     
    <packaging>jar</packaging>     
    <!--项目当前版本,格式为:主版本.次版本.增量版本-限定版本号-->     
    <version>1.0-SNAPSHOT</version>     
    <!--项目的名称, Maven产生的文档用-->     
    <name>banseon-maven</name>     
    <!--项目主页的URL, Maven产生的文档用-->     
    <url>http://www.baidu.com/banseon</url>     
    <!-- 项目的详细描述, Maven 产生的文档用。  当这个元素能够用HTML格式描述时(例如,CDATA中的文本会被解析器忽略,就可以包含HTML标 签), 不鼓励使用纯文本描述。如果你需要修改产生的web站点的索引页面,你应该修改你自己的索引页文件,而不是调整这里的文档。-->     
    <description>A maven project to study maven.</description>     
    <!--描述了这个项目构建环境中的前提条件。-->    
 <prerequisites>    
  <!--构建该项目或使用该插件所需要的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/>    
  <!--该项目使用的持续集成系统的URL(如果持续集成系统有web接口的话)。-->    
  <url/>    
  <!--构建完成时,需要通知的开发者/用户的配置项。包括被通知者信息和通知条件(错误,失败,成功,警告)-->    
  <notifiers>    
   <!--配置一种方式,当构建中断时,以该方式通知用户/开发者-->    
   <notifier>    
    <!--传送通知的途径-->    
    <type/>    
    <!--发生错误时是否通知-->    
    <sendOnError/>    
    <!--构建失败时是否通知-->    
    <sendOnFailure/>    
    <!--构建成功时是否通知-->    
    <sendOnSuccess/>    
    <!--发生警告时是否通知-->    
    <sendOnWarning/>    
    <!--不赞成使用。通知发送到哪里-->    
    <address/>    
    <!--扩展配置项-->    
    <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/>    
            <!--项目开发者在项目中扮演的角色,角色元素描述了各种角色-->    
            <roles>     
                <role>Project Manager</role>     
                <role>Architect</role>     
            </roles>    
            <!--项目开发者所属组织-->    
            <organization>demo</organization>     
            <!--项目开发者所属组织的URL-->    
            <organizationUrl>http://hi.baidu.com/banseon</organizationUrl>     
            <!--项目开发者属性,如即时消息如何处理等-->    
            <properties>     
                <dept>No</dept>     
            </properties>    
            <!--项目开发者所在时区, -11到12范围内的整数。-->    
            <timezone>-5</timezone>     
        </developer>     
    </developers>     
    <!--项目的其他贡献者列表-->     
    <contributors>    
     <!--项目的其他贡献者。参见developers/developer元素-->    
     <contributor>    
   <name/><email/><url/><organization/><organizationUrl/><roles/><timezone/><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/>           
        <!--指向项目的可浏览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/>    
  <!--该元素设置了项目脚本源码目录,该目录和源码目录不同:绝大多数情况下,该目录下的内容 会被拷贝到输出目录(因为脚本是被解释的,而不是被编译的)。-->    
  <scriptSourceDirectory/>    
  <!--该元素设置了项目单元测试使用的源码目录,当测试项目的时候,构建系统会编译目录里的源码。该路径是相对于pom.xml的相对路径。-->    
  <testSourceDirectory/>    
  <!--被编译过的应用程序class文件存放的目录。-->    
  <outputDirectory/>    
  <!--被编译过的测试class文件存放的目录。-->    
  <testOutputDirectory/>    
  <!--使用来自该项目的一系列构建扩展-->    
  <extensions>    
   <!--描述使用到的构建扩展。-->    
   <extension>    
    <!--构建扩展的groupId-->    
    <groupId/>    
    <!--构建扩展的artifactId-->    
    <artifactId/>    
    <!--构建扩展的版本-->    
    <version/>    
   </extension>    
  </extensions>    
  <!--当项目没有规定目标(Maven2 叫做阶段)时的默认值-->    
  <defaultGoal/>    
  <!--这个元素描述了项目相关的所有资源路径列表,例如和项目相关的属性文件,这些资源被包含在最终的打包文件里。-->    
  <resources>    
   <!--这个元素描述了项目相关或测试相关的所有资源路径-->    
   <resource>    
    <!-- 描述了资源的目标路径。该路径相对target/classes目录(例如${project.build.outputDirectory})。举个例 子,如果你想资源在特定的包里(org.apache.maven.messages),你就必须该元素设置为org/apache/maven /messages。然而,如果你只是想把资源放到源码目录结构里,就不需要该配置。-->    
    <targetPath/>    
    <!--是否使用参数值代替参数名。参数值取自properties元素或者文件里配置的属性,文件在filters元素里列出。-->    
    <filtering/>    
    <!--描述存放资源的目录,该路径相对POM路径-->    
    <directory/>    
    <!--包含的模式列表,例如**/*.xml.-->    
    <includes/>    
    <!--排除的模式列表,例如**/*.xml-->    
    <excludes/>    
   </resource>    
  </resources>    
  <!--这个元素描述了单元测试相关的所有资源路径,例如和单元测试相关的属性文件。-->    
  <testResources>    
   <!--这个元素描述了测试相关的所有资源路径,参见build/resources/resource元素的说明-->    
   <testResource>    
    <targetPath/><filtering/><directory/><includes/><excludes/>    
   </testResource>    
  </testResources>    
  <!--构建产生的所有文件存放的目录-->    
  <directory/>    
  <!--产生的构件的文件名,默认值是${artifactId}-${version}。-->    
  <finalName/>    
  <!--当filtering开关打开时,使用到的过滤器属性文件列表-->    
  <filters/>    
  <!--子项目可以引用的默认插件信息。该插件配置项直到被引用时才会被解析或绑定到生命周期。给定插件的任何本地配置都会覆盖这里的配置-->    
  <pluginManagement>    
   <!--使用的插件列表 。-->    
   <plugins>    
    <!--plugin元素包含描述插件所需要的信息。-->    
    <plugin>    
     <!--插件在仓库里的group ID-->    
     <groupId/>    
     <!--插件在仓库里的artifact ID-->    
     <artifactId/>    
     <!--被使用的插件的版本(或版本范围)-->    
     <version/>    
     <!--是否从该插件下载Maven扩展(例如打包和类型处理器),由于性能原因,只有在真需要下载时,该元素才被设置成enabled。-->    
     <extensions/>    
     <!--在构建生命周期中执行一组目标的配置。每个目标可能有不同的配置。-->    
     <executions>    execute 激活
      <!--execution元素包含了插件执行需要的信息-->    
      <execution>    
       <!--执行目标的标识符,用于标识构建过程中的目标,或者匹配继承过程中需要合并的执行目标-->    
       <id/>    
       <!--绑定了目标的构建生命周期阶段,如果省略,目标会被绑定到源数据里配置的默认阶段-->    
       <phase/>    
       <!--配置的执行目标-->    
       <goals/>    
       <!--配置是否被传播到子POM-->    
       <inherited/>    
       <!--作为DOM对象的配置-->    
       <configuration/>    
      </execution>    
     </executions>    
     <!--项目引入插件所需要的额外依赖-->    
     <dependencies>    
      <!--参见dependencies/dependency元素-->    
      <dependency>    
       ......    
      </dependency>    
     </dependencies>         
     <!--任何配置是否被传播到子项目-->    
     <inherited/>    
     <!--作为DOM对象的配置-->    
     <configuration/>    
    </plugin>    
   </plugins>    
  </pluginManagement>    
  <!--使用的插件列表-->    
  <plugins>    
   <!--参见build/pluginManagement/plugins/plugin元素-->    
   <plugin>    
    <groupId/><artifactId/><version/><extensions/>    
    <executions>    
     <execution>    
      <id/><phase/><goals/><inherited/><configuration/>    
     </execution>    
    </executions>    
    <dependencies>    
     <!--参见dependencies/dependency元素-->    
     <dependency>    
      ......    
     </dependency>    
    </dependencies>    
    <goals/><inherited/><configuration/>    
   </plugin>    
  </plugins>    
 </build>    
 <!--在列的项目构建profile,如果被激活,会修改构建处理-->    
 <profiles>    
  <!--根据环境参数或命令行参数激活某个构建处理-->    
  <profile>    
   <!--构建配置的唯一标识符。即用于命令行激活,也用于在继承时合并具有相同标识符的profile。-->    
   <id/>    
   <!--自动触发profile的条件逻辑。Activation是profile的开启钥匙。profile的力量来自于它    
   能够在某些特定的环境中自动使用某些特定的值;这些环境通过activation元素指定。activation元素并不是激活profile的唯一方式。-->    
   <activation>    
    <!--profile默认是否激活的标志-->    
    <activeByDefault/>    
    <!--当匹配的jdk被检测到,profile被激活。例如,1.4激活JDK1.4,1.4.0_2,而!1.4激活所有版本不是以1.4开头的JDK。-->    
    <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/><filtering/><directory/><includes/><excludes/>    
     </resource>    
    </resources>    
    <testResources>    
     <testResource>    
      <targetPath/><filtering/><directory/><includes/><excludes/>    
     </testResource>    
    </testResources>    
    <directory/><finalName/><filters/>    
    <pluginManagement>    
     <plugins>    
      <!--参见build/pluginManagement/plugins/plugin元素-->    
      <plugin>    
       <groupId/><artifactId/><version/><extensions/>    
       <executions>    
        <execution>    
         <id/><phase/><goals/><inherited/><configuration/>    
        </execution>    
       </executions>    
       <dependencies>    
        <!--参见dependencies/dependency元素-->    
        <dependency>    
         ......    
        </dependency>    
       </dependencies>    
       <goals/><inherited/><configuration/>    
      </plugin>    
     </plugins>    
    </pluginManagement>    
    <plugins>    
     <!--参见build/pluginManagement/plugins/plugin元素-->    
     <plugin>    
      <groupId/><artifactId/><version/><extensions/>    
      <executions>    
       <execution>    
        <id/><phase/><goals/><inherited/><configuration/>    
       </execution>    
      </executions>    
      <dependencies>    
       <!--参见dependencies/dependency元素-->    
       <dependency>    
        ......    
       </dependency>    
      </dependencies>    
      <goals/><inherited/><configuration/>    
     </plugin>    
    </plugins>    
   </build>    
   <!--模块(有时称作子项目) 被构建成项目的一部分。列出的每个模块元素是指向该模块的目录的相对路径-->    
   <modules/>    
   <!--发现依赖和扩展的远程仓库列表。-->    
   <repositories>    
    <!--参见repositories/repository元素-->    
    <repository>    
     <releases>    
      <enabled/><updatePolicy/><checksumPolicy/>    
     </releases>    
     <snapshots>    
      <enabled/><updatePolicy/><checksumPolicy/>    
     </snapshots>    
     <id/><name/><url/><layout/>    
    </repository>    
   </repositories>    
   <!--发现插件的远程仓库列表,这些插件用于构建和报表-->    
   <pluginRepositories>    
    <!--包含需要连接到远程插件仓库的信息.参见repositories/repository元素-->        
    <pluginRepository>    
     <releases>    
      <enabled/><updatePolicy/><checksumPolicy/>    
     </releases>    
     <snapshots>    
      <enabled/><updatePolicy/><checksumPolicy/>    
     </snapshots>    
     <id/><name/><url/><layout/>    
    </pluginRepository>    
   </pluginRepositories>    
   <!--该元素描述了项目相关的所有依赖。 这些依赖组成了项目构建过程中的一个个环节。它们自动从项目定义的仓库中下载。要获取更多信息,请看项目依赖机制。-->    
   <dependencies>    
    <!--参见dependencies/dependency元素-->    
    <dependency>    
     ......    
    </dependency>    
   </dependencies>    
   <!--不赞成使用. 现在Maven忽略该元素.-->    
   <reports/>       
   <!--该元素包括使用报表插件产生报表的规范。当用户执行“mvn site”,这些报表就会运行。 在页面导航栏能看到所有报表的链接。参见reporting元素-->    
   <reporting>    
    ......    
   </reporting>    
   <!--参见dependencyManagement元素-->    
   <dependencyManagement>    
    <dependencies>    
     <!--参见dependencies/dependency元素-->    
     <dependency>    
      ......    
     </dependency>    
    </dependencies>    
   </dependencyManagement>    
   <!--参见distributionManagement元素-->    
   <distributionManagement>    
    ......    
   </distributionManagement>    
   <!--参见properties元素-->    
   <properties/>    
  </profile>    
 </profiles>    
 <!--模块(有时称作子项目) 被构建成项目的一部分。列出的每个模块元素是指向该模块的目录的相对路径-->    
 <modules/>    
    <!--发现依赖和扩展的远程仓库列表。-->     
    <repositories>     
     <!--包含需要连接到远程仓库的信息-->    
        <repository>    
         <!--如何处理远程仓库里发布版本的下载-->    
         <releases>    
          <!--true或者false表示该仓库是否为下载某种类型构件(发布版,快照版)开启。 -->    
    <enabled/>    
    <!--该元素指定更新发生的频率。Maven会比较本地POM和远程POM的时间戳。这里的选项是:always(一直),daily(默认,每日),interval:X(这里X是以分钟为单位的时间间隔),或者never(从不)。-->    
    <updatePolicy/>    
    <!--当Maven验证构件校验文件失败时该怎么做:ignore(忽略),fail(失败),或者warn(警告)。-->    
    <checksumPolicy/>    
   </releases>    
   <!-- 如何处理远程仓库里快照版本的下载。有了releases和snapshots这两组配置,POM就可以在每个单独的仓库中,为每种类型的构件采取不同的 策略。例如,可能有人会决定只为开发目的开启对快照版本下载的支持。参见repositories/repository/releases元素 -->    
   <snapshots>    
    <enabled/><updatePolicy/><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>    		exclude 排除
             <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/>    
    <!--报表插件在仓库里的artifact ID-->    
    <artifactId/>    
    <!--被使用的报表插件的版本(或版本范围)-->    
    <version/>    
    <!--任何配置是否被传播到子项目-->    
    <inherited/>    
    <!--报表插件的配置-->    
    <configuration/>    
    <!--一组报表的多重规范,每个规范可能有不同的配置。一个规范(报表集)对应一个执行目标 。例如,有1,2,3,4,5,6,7,8,9个报表。1,2,5构成A报表集,对应一个执行目标。2,5,8构成B报表集,对应另一个执行目标-->    
    <reportSets>    
     <!--表示报表的一个集合,以及产生该集合的配置-->    
     <reportSet>    
      <!--报表集合的唯一标识符,POM继承时用到-->    
      <id/>    
      <!--产生报表集合时,被使用的报表的配置-->    
      <configuration/>    
      <!--配置是否被继承到子POMs-->    
      <inherited/>    
      <!--这个集合里使用到哪些报表-->    
      <reports/>    
     </reportSet>    
    </reportSets>    
   </plugin>    
  </plugins>    
 </reporting>    
 <!-- 继承自该项目的所有子项目的默认依赖信息。这部分的依赖信息不会被立即解析,而是当子项目声明一个依赖(必须描述group ID和 artifact ID信息),如果group ID和artifact ID以外的一些信息没有描述,则通过group ID和artifact ID 匹配到这里的依赖,并使用这里的依赖信息。-->   
 <!-- 
    例如 B,C 为 依赖 A 的子项目, A B C 中都有一个依赖 xxx,但是版本不同
    则可以通过 在 A 中的 pom 文件中 <dependencyManagement> 声明 该 xxx 依赖的版本, B C 中此依赖版本 跟随 <dependencyManagement> 中的定义
 -->  
 <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/>    
  </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/>    
  </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/>    
   <!--构件新的artifact ID-->    
   <artifactId/>    
   <!--构件新的版本号-->    
   <version/>    
   <!--显示给用户的,关于移动的额外信息,例如原因。-->    
   <message/>    
  </relocation>    
  <!-- 给出该构件在远程仓库的状态。不得在本地项目中设置该元素,因为这是工具自动更新的。有效的值有:none(默认),converted(仓库管理员从 Maven 1 POM转换过来),partner(直接从伙伴Maven 2仓库同步过来),deployed(从Maven 2实例部 署),verified(被核实时正确的和最终的)。-->    
  <status/>           
    </distributionManagement>    
    <!--以值替代名称,Properties可以在整个POM中使用,也可以作为触发条件(见settings.xml配置文件里activation元素的说明)。格式是<name>value</name>。-->    
    <properties/>    
</project>  </span> 

maven 相关重要的几个

repositories

<uniqueVersion>指定是否产生一个唯一性的version number还是使用address里的其中version部分.(true or false)
<id>  库的id
<name> 库的名称
<url> 库的url
<layout> default或者legacy

应用中需要一些比较新的依赖,而这些依赖并没有正式发布,还是处于milestone或者是snapshot阶段并不能从中央仓库或者镜像站上下载到。此时,就需要 自定义Maven的<repositories>

以Spring应用程序程序为例,需要添加一个Spring Security 5.2.0.BUILD-SNAPSHOT版本的依赖,可惜这是个snapshot并不在镜像站中

解决方法就是在 pom.xml 添加一个snapshot的地址

<!-- Spring Snapshots仓库 -->

<repositories>
    <repository> 
        <id>spring-snapshots</id> 
        <name>Spring Snapshots</name>   人类可读名称
        <url>https://repo.spring.io/snapshot</url> 
    </repository>
</repositories>

这样,就能从这个仓库中,获取到 Spring Security 5.2.0.BUILD-SNAPSHOT版本的依赖了。

例2

maven仓库分为两种 release发布仓库(<repository>) snapshot快照仓库(<snapshotsrepository>)
snapshot快照仓库用于保存开发过程中的不稳定版本
release正式仓库用来保存稳定的发行版本

<!-- repository的releases和snapshots标签中有个enabled属性,默认为true。,
表示是否需要从这个远程仓库中下载稳定版本或者快照版本的构件,一般使用第三方仓库,建议下载稳定版本的构件。 -->
<repository>
  <id>aliyun-releases</id>
  <url>https://maven.aliyun.com/repository/public</url>
  <releases>
    <enabled>true</enabled>
  </releases>
  <snapshots>
    <enabled>false</enabled>
  </snapshots>
</repository>


<repository>
    <id>its-snapshots</id>  唯一标识符
    <url>https://pkg.sensetime.com/repository/its-maven2-snapshot-hosted-private/</url>
    <releases>
        <enabled>false</enabled>
    </releases>
    <snapshots>
        <enabled>true</enabled>                  是否使用此存储库下载此类型的项目
        <updatePolicy>always</updatePolicy>      下载更新的频率 
        <checksumPolicy>fail</checksumPolicy>    当项目校验和验证失败时该怎么办
    </snapshots>
</repository>

问题

有时,跟着上面的设置方法并不奏效,仍然还是从之前的镜像站中去下载。此时,我们需要去检查下 Maven 安装目录下的settings.xml:

<mirror>
    <id>nexus-aliyun</id>
    <mirrorOf>*</mirrorOf>
    <name>Nexus aliyun</name>
    <url>http://maven.aliyun.com/nexus/content/groups/public</url>
</mirror>

可以看到,在设置镜像时,mirrorOf设置为了“*”,意味所有的依赖都是从这个镜像上下载。完全不给Spring Snapshots机会了。

解决方法也简单,改为下面的方式:

<mirror>
    <id>nexus-aliyun</id>
    <mirrorOf>*,!spring-snapshots</mirrorOf>
    <name>Nexus aliyun</name>
    <url>http://maven.aliyun.com/nexus/content/groups/public</url>
</mirror>

mirrorOf设置为了“*,!spring-snapshots”,意味除了Spring Snapshots外,所有的依赖都是从这个镜像上下载。这样就能下载到 Spring Snapshots了。

*:所有依赖;

external:*:所有不再本地和不是基于文件的依赖;

repo,repo1:所有来自repo或者repo1仓库的依赖;

*,!repo1:除了repo1外的所有依赖。即上面示例中的场景。

distributionManagement

负责管理构件的发布

distributionManagement 中的 repository && snapshotsrepository

pom配置之:< distributionManagement >snapshot快照库和release发布库

maven仓库分为两种 release发布仓库(<repository>) snapshot快照仓库(<snapshotsrepository>)
snapshot快照仓库用于保存开发过程中的不稳定版本
release正式仓库用来保存稳定的发行版本

定义一个组件/模块为快照版本  
只需要在pom文件中的该模板的版本号后面加上 -SNAPSHOT就可以了

注意:必须是大写

maven会根据模块的版本号(pom文件中的<version>版本号</version>)中是否带有-SNAPSHOT来判断这个是快照版本还是正式版本


1 如果是快照版本:

mvn deploy时自动发布到快照版本库中
使用快照版本的模块,在不更改版本号的情况下,直接编译打包时,maven会自动从镜像服务器上下载最新的快照版本

2 如果是正式发布版本:

那么在mvn deploy时会自动发布到正式版本库中
使用正式版本的模块,在不更改版本号的情况下,编译打包时,如果本地已经存在该版本的模块则使用本地的而不是主动去镜像服务器上下载


将项目打包上传到nexus私服

pom.xml文件添加distributionManagement节点

<!-- 使用分发管理将本项目打成jar包,直接上传到指定服务器 -->
  <distributionManagement>
	<!--正式版本-->
	<repository>
		<!-- nexus服务器中用户名:在settings.xml中<server>的id-->
		<id>yang</id>
		<!-- 这个名称自己定义 -->
		<name>Release repository</name>
		<url>http://192.168.1.105:8081/repository/yang/</url>
	</repository>
	<!--快照-->
	<snapshotRepository>
		<id>nexus-snapshots</id>
		<name>Snapshots repository</name>
		<url>http://192.168.1.105/repository/yang/</url>
	</snapshotRepository>
  </distributionManagement>

< repository >节点下的< id >对应setting.xml文件中的server的id

上传正式版本,pom.xml文件version中不能有SNAPSHOT,否则会自动打包到 snapshots 的仓库

  <groupId>com.yang</groupId>
  <artifactId>shade-plugin</artifactId>
  <version>0.0.1</version>
  <!--  <version>0.0.1-SNAPSHOT</version> -->

profiles

在开发Spring Boot应用时,通常同一套程序会被应用和安装到几个不同的环境,比如:开发、测试、生产等。其中每个环境的数据库地址服务器端口等等配置都会不同,如果在为不同环境打包时都要频繁修改配置文件的话,那必将是个非常繁琐且容易发生错误的事

对于多环境的配置,各种项目构建工具或是框架的基本思路是一致的,通过配置多份不同环境的配置文件,再通过打包命令指定需要打包的内容之后进行区分打包,Spring Boot也不例外,或者说更加简单。

可以通过pom.xml定义多个profile,也可以通过settings.xml文件定义多个profile。对于一个profile,如果同时在pom.xml和settings.xml中配置,则settings.xml中的配置优先

settings.xml中的profile只能配置如下元素

id
activation
repositories
pluginRepositories
properties
pom.xml中的profile能配置如下元素:

id
activation
repositories
pluginRepositories
properties
build
modules
dependencies
dependencyManagement
repositories
pluginRepositories
distributionManagement
reporting
  <profiles>
    <profile>
      <id>mytest</id>
      <activation>
        <activeByDefault>false</activeByDefault>
        <jdk>1.5</jdk>    检查构建使用的JDK
        <os>    检查构建服务器的操作系统
          <name>Windows XP</name>
          <family>Windows</family>
          <arch>x86</arch>
          <version>5.1.2600</version>
        </os>
        <property>   检查构建过程中是否存在名为${name}的属性及其值
          <name>sparrow-type</name>
          <value>African</value>
        </property>
        <file>    检查这里配置的文件是否存在(<exists>)或者不存在<missing>
          <exists>${basedir}/file2.properties</exists>
          <missing>${basedir}/file1.properties</missing>
        </file>
      </activation>
      ...
    </profile>
  </profiles>
</project>

pom.xml 中

<profiles>
	<profile>
		<id>registry</id>
		<build>
			<plugins>
				<plugin>
					<groupId>com.google.cloud.tools</groupId>
					<artifactId>jib-maven-plugin</artifactId>
					<executions>
						<execution>
							<id>docker-push</id>
							<phase>package</phase>
							<goals>
								<goal>build</goal>
							</goals>
						</execution>
					</executions>
				</plugin>
			</plugins>
		</build>
	</profile>
</profiles>
mvn clean deploy -Pregistry 表示deploy到 registry 环境

例2

<profiles>
    <!-- 开发环境,默认激活 -->
    <profile>
        <id>dev</id>
        <activation>
            <!-- 默认 -->
            <activeByDefault>true</activeByDefault>
        </activation>
        <build>
            <resources>
                <resource>
                    <directory>src/main/profiles/dev</directory>
                    <filtering>true</filtering>
                </resource>
            </resources>
        </build>
    </profile>
    <!-- 持续集成环境 -->
    <profile>
        <id>ci</id>
        <build>
            <resources>
                <resource>
                    <directory>src/main/profiles/ci</directory>
                    <filtering>true</filtering>
                </resource>
            </resources>
        </build>
    </profile>
    <!-- 测试环境 -->
    <profile>
        <id>test</id>
        <build>
            <resources>
                <resource>
                    <directory>src/main/profiles/test</directory>
                    <filtering>true</filtering>
                </resource>
            </resources>
        </build>
    </profile>
    <!-- 生产环境 -->
    <profile>
        <id>prd</id>
        <build>
            <resources>
                <resource>
                    <directory>src/main/profiles/prd</directory>
                    <filtering>true</filtering>
                </resource>
            </resources>
        </build>
    </profile>
</profiles>

repositories 和 pluginRepositories

repositories 名为仓库,解决项目依赖第三方jar包存放位置,以及多个项目公用第三方jar包
pluginRepositories 名为插件仓库,存放maven插件的仓库,告诉项目您使用的插件应该去什么地方下载

Maven仓库就是放置所有JAR文件(WAR,ZIP,POM等等)的地方所有Maven项目可以从同一个Maven仓库中获取自己所需要的依赖JAR,这节省了磁盘资源。此外,由于Maven仓库中所有的JAR都有其自己的坐标,该坐标告诉Maven它的组ID,构件ID,版本,打包方式等等,因此Maven项目可以方便的进行依赖版本管理

本地仓库(.m2)

Maven所需要的任何构件都是直接从本地仓库获取的。如果本地仓库没有,它会首先尝试从远程仓库下载构件至本地仓库,然后再使用本地仓库的构件

如果尝试过所有远程仓库之后,Maven还是没能够下载到该文件,它就会报错

Maven缺省的本地仓库地址user.home/.m2/repository
一个用户会对应的拥有一个本地仓库 。 你也可以自定义本地仓库的位置,修改{user.home}/.m2/settings.xml

  <!-- localRepository
   | The path to the local repository maven will use to store artifacts.
   |
   | Default: ${user.home}/.m2/repository-->
  <localRepository>D:/.m2/repository</localRepository>

当我们运行install的时候,Maven实际上是将项目生成的构件安装到了本地仓库,即只有install了之后其它项目才能使用此项目生成的构件

远程仓库(联网)

Maven远程仓库,即Maven中央仓库

安装好Maven之后,我们可以建立一个简单的项目,配置一些简单的依赖,然后运行mvn clean install,项目就构建好了。我们没有手工的去下载任何jar文件,这一切都是因为Maven中央仓库的存在,当Maven在本地仓库找不到需要的jar文件时,它会查找远程仓库,而一个原始的Maven安装就自带了一个远程仓库——Maven中央仓库

这个Maven中央仓库是在哪里定义的呢?在我的机器上,我安装了maven-2.0.10,我可以找到这个文件:${M2_HOME}/lib/maven-2.0.10-uber.jar

但是到了3.xxx版本之后在:/lib/maven-model-builder-${version}.jar

打开该文件,能找到超级POM\org\apache\maven\model\pom-4.0.0.xml ,它是所有Maven POM的父POM,所有Maven项目继承该配置,你可以在这个POM中发现如下配置:

  <repositories>
    <repository>
      <id>central</id>
      <name>Central Repository</name>
      <url>https://repo.maven.apache.org/maven2</url>
      <layout>default</layout>
      <snapshots>
        <enabled>false</enabled>
      </snapshots>
    </repository>
  </repositories>

中央仓库的id为central,远程url地址为http://repo.maven.apache.org/maven2,它关闭了snapshot版本构件下载的支持。

在POM中配置远程仓库

前面我们看到超级POM配置了ID为central的远程仓库,我们可以在POM中配置其它的远程仓库

这样做的原因有很多,比如你有一个局域网的远程仓库,使用该仓库能大大提高下载速度,继而提高构建速度,也有可能你依赖的一个jar在central中找不到,它只存在于某个特定的公共仓库,这样你也不得不添加那个远程仓库的配置。

<project>
...
  <repositories>
    <repository>
      <id>maven-net-cn</id>
      <name>Maven China Mirror</name>
      <url>http://maven.net.cn/content/groups/public/</url>
      <releases>
        <enabled>true</enabled>    可以从这个仓库下载releases版本的构件
      </releases>
      <snapshots>
        <enabled>false</enabled>    不要从这个仓库下载snapshot版本的构件
      </snapshots>
    </repository>
  </repositories>
  <pluginRepositories>
    <pluginRepository>
      <id>maven-net-cn</id>
      <name>Maven China Mirror</name>
      <url>http://maven.net.cn/content/groups/public/</url>
      <releases>
        <enabled>true</enabled>
      </releases>
      <snapshots>
        <enabled>false</enabled>
      </snapshots>    
    </pluginRepository>
  </pluginRepositories>
...
</project>

可以在<repositories>下面添加多个<repository> ,每个都有它唯一的ID,一个描述性的name,以及最重要的,远程仓库的url

禁止从公共仓库下载snapshot构件是推荐的做法,因为这些构件不稳定,且不受你控制,你应该避免使用。当然,如果你想使用局域网内组织内部的仓库,你可以激活snapshot的支持。

<pluginRepositories>,这是配置Maven从什么地方下载插件构件(Maven的所有实际行为都由其插件完成)。该元素的内部配置和<repository>完全一样。

MAVEN仓库的请求顺序

1.本地仓库 -2.中央仓库(MAVEN缺省的远程仓库) -3.远程仓库

其他操作

maven 配合 @ConditionOnClass

A 项目依赖 B 项目

B 项目中配置
@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(value = {RestHighLevelClient.class, ElasticSearchUtil.class})
public class ElasticsearchAutoConfiguration {

    @Bean
    @ConfigurationProperties("xxx.elasticsearch")
    public ElasticSearchProperties elasticSearchProperties() {
        return new ElasticSearchProperties();
    }

    @Bean
    @ConditionalOnBean(ElasticSearchProperties.class)
    public ElasticSearchUtil elasticSearchUtil(ElasticSearchProperties searchProperties) {
        Assert.notBlank(searchProperties.getClusterAddress(),"cluster address must not blank");
        return ElasticSearchUtil.create(searchProperties);
    }
}

想要上面 es 配置在 A项目中 不生效

在 A 中 pom.xml 引入 B项目依赖的时候,exclude {RestHighLevelClient.class, ElasticSearchUtil.class}
定位到 {RestHighLevelClient.class, ElasticSearchUtil.class} 之一所在的包,在 A 中 exclude

<dependency>
    <groupId>com.xxx</groupId>
    <artifactId>B-client</artifactId>
    <exclusions>
        <exclusion>
            <artifactId>spring-data-elasticsearch</artifactId>
            <groupId>org.springframework.data</groupId>
        </exclusion>
    </exclusions>
</dependency>
  • 1
    点赞
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值