maven配置文件详解

Posted 2022-06-30 guohu

settings.xml

本篇文章主要对maven中setting.xml配置文件进行解释

 

1.声明规范

 

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" 
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">

2.localRepository

    <!-- 本地仓库的路径。默认值为 -->
    <localRepository>/opt/repository</localRepository>

3.interactiveMode

    <!--Maven是否需要和用户交互以获得输入。如果Maven需要和用户交互以获得输入，则设置成true，反之则应为false。默认为true。-->
    <interactiveMode>true</interactiveMode>

4.usePluginRegistry

    <!--Maven是否需要使用plugin-registry.xml文件来管理插件版本。如果需要让Maven使用文件来管理插件版本，则设为true。默认为false。-->
    <usePluginRegistry>false</usePluginRegistry>

5.offline

    <!--表示Maven是否需要在离线模式下运行。如果构建系统需要在离线模式下运行，则为true，默认为false。当由于网络设置原因或者安全因素，构建服务器不能连接远程仓库的时候，该配置就十分有用。 -->
    <offline>false</offline>

6.pluginGroups

    <!--当插件的组织Id（groupId）没有显式提供时，供搜寻插件组织Id（groupId）的列表。该元素包含一个pluginGroup元素列表，每个子元素包含了一个组织Id（groupId）。当我们使用某个插件，并且没有在命令行为其提供组织Id（groupId）的时候，Maven就会使用该列表。默认情况下该列表包含了org.apache.maven.plugins和org.codehaus.mojo -->
    <pluginGroups>
      <!--plugin的组织Id（groupId） -->
      <pluginGroup>org.codehaus.mojo</pluginGroup>
    </pluginGroups>

7.proxies

    <!--用来配置不同的代理，多代理profiles 可以应对笔记本或移动设备的工作环境：通过简单的设置profile id就可以很容易的更换整个代理配置。 -->
    <proxies>
      <!--代理元素包含配置代理时需要的信息-->
      <proxy>
       <!--代理的唯一定义符，用来区分不同的代理元素。-->
       <id>myproxy</id>
       <!--该代理是否是激活的那个。true则激活代理。当我们声明了一组代理，而某个时候只需要激活一个代理的时候，该元素就可以派上用处。 -->
       <active>true</active>
       <!--代理的协议。 协议://主机名:端口，分隔成离散的元素以方便配置。-->
       <protocol>http</protocol>
       <!--代理的主机名。协议://主机名:端口，分隔成离散的元素以方便配置。  -->
       <host>proxy.somewhere.com</host>
       <!--代理的端口。协议://主机名:端口，分隔成离散的元素以方便配置。 -->
       <port>8080</port>
       <!--代理的用户名，用户名和密码表示代理服务器认证的登录名和密码。 -->
       <username>proxyuser</username>
       <!--代理的密码，用户名和密码表示代理服务器认证的登录名和密码。 -->
       <password>somepassword</password>
       <!--不该被代理的主机名列表。该列表的分隔符由代理服务器指定；例子中使用了竖线分隔符，使用逗号分隔也很常见。-->
       <nonProxyHosts>*.google.com|ibiblio.org</nonProxyHosts>
      </proxy>
    </proxies>

8.servers

    <!--配置服务端的一些设置。一些设置如安全证书不应该和pom.xml一起分发。这种类型的信息应该存在于构建服务器上的settings.xml文件中。-->
    <servers>
      <!--服务器元素包含配置服务器时需要的信息 -->
      <server>
       <!--这是server的id（注意不是用户登陆的id），该id与distributionManagement中repository元素的id相匹配。-->
       <id>server001</id>
       <!--鉴权用户名。鉴权用户名和鉴权密码表示服务器认证所需要的登录名和密码。 -->
       <username>my_login</username>
       <!--鉴权密码 。鉴权用户名和鉴权密码表示服务器认证所需要的登录名和密码。密码加密功能已被添加到2.1.0 +。详情请访问密码加密页面-->
       <password>my_password</password>
       <!--鉴权时使用的私钥位置。和前两个元素类似，私钥位置和私钥密码指定了一个私钥的路径（默认是$user.home/.ssh/id_dsa）以及如果需要的话，一个密语。将来passphrase和password元素可能会被提取到外部，但目前它们必须在settings.xml文件以纯文本的形式声明。 -->
       <privateKey>$usr.home/.ssh/id_dsa</privateKey>
       <!--鉴权时使用的私钥密码。-->
       <passphrase>some_passphrase</passphrase>
       <!--文件被创建时的权限。如果在部署的时候会创建一个仓库文件或者目录，这时候就可以使用权限（permission）。这两个元素合法的值是一个三位数字，其对应了unix文件系统的权限，如664，或者775。 -->
       <filePermissions>664</filePermissions>
       <!--目录被创建时的权限。 -->
       <directoryPermissions>775</directoryPermissions>
      </server>
    </servers>

9.mirrors

    <!--为仓库列表配置的下载镜像列表。高级设置请参阅镜像设置页面 -->
    <mirrors>
      <!--给定仓库的下载镜像。 -->
      <mirror>
       <!--该镜像的唯一标识符。id用来区分不同的mirror元素。 -->
       <id>planetmirror.com</id>
       <!--镜像名称 -->
       <name>PlanetMirror Australia</name>
       <!--该镜像的URL。构建系统会优先考虑使用该URL，而非使用默认的服务器URL。 -->
       <url>http://downloads.planetmirror.com/pub/maven2</url>
       <!--被镜像的服务器的id。例如，如果我们要设置了一个Maven中央仓库（http://repo.maven.apache.org/maven2/）的镜像，就需要将该元素设置成central。这必须和中央仓库的id central完全一致。-->
       <mirrorOf>central</mirrorOf>
      </mirror>
    </mirrors>

10.profiles

    <!--根据环境参数来调整构建配置的列表。settings.xml中的profile元素是pom.xml中profile元素的裁剪版本。它包含了id，activation, repositories, pluginRepositories和 properties元素。这里的profile元素只包含这五个子元素是因为这里只关心构建系统这个整体（这正是settings.xml文件的角色定位），而非单独的项目对象模型设置。如果一个settings中的profile被激活，它的值会覆盖任何其它定义在POM中或者profile.xml中的带有相同id的profile。 -->
    <profiles>
      <!--根据环境参数来调整的构件的配置-->
      <profile>
       <!--该配置的唯一标识符。 -->
       <id>test</id>

11.Activation

    <!--自动触发profile的条件逻辑。Activation是profile的开启钥匙。如POM中的profile一样，profile的力量来自于它能够在某些特定的环境中自动使用某些特定的值；这些环境通过activation元素指定。activation元素并不是激活profile的唯一方式。settings.xml文件中的activeProfile元素可以包含profile的id。profile也可以通过在命令行，使用-P标记和逗号分隔的列表来显式的激活（如，-P test）。-->
       <activation>
    <!--profile默认是否激活的标识-->
        <activeByDefault>false</activeByDefault>
    <!--当匹配的jdk被检测到，profile被激活。例如，1.4激活JDK1.4，1.4.0_2，而!1.4激活所有版本不是以1.4开头的JDK。-->
        <jdk>1.5</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中通过$name引用），其拥有对应的name = 值，Profile就会被激活。如果值字段是空的，那么存在属性名称字段就会激活profile，否则按区分大小写方式匹配属性值字段-->
        <property>
    <!--激活profile的属性的名称-->
         <name>mavenVersion</name>
    <!--激活profile的属性的值 -->
         <value>2.0.3</value>
        </property>
    <!--提供一个文件名，通过检测该文件的存在或不存在来激活profile。missing检查文件是否存在，如果不存在则激活profile。另一方面，exists则会检查文件是否存在，如果存在则激活profile。-->
        <file>
    <!--如果指定的文件存在，则激活profile。 -->
         <exists>$basedir/file2.properties</exists>
    <!--如果指定的文件不存在，则激活profile。-->
         <missing>$basedir/file1.properties</missing>
        </file>
       </activation>

12.Repositories

    <repository> 
               <id>nexus</id> 
               <name>local private nexus</name> 
               <url>http://localhost:8081/nexus/content/groups/public</url> 
               <releases><enabled>true</enabled></releases>
                <snapshots><enabled>true</enabled></snapshots>
       </repository>
    </repositories>
    <!--远程仓库列表，它是Maven用来填充构建系统本地仓库所使用的一组远程项目。 -->
    <repositories>
    <!--包含需要连接到远程仓库的信息 -->
        <repository>
    <!--远程仓库唯一标识-->
         <id>codehausSnapshots</id>
    <!--远程仓库名称 -->
         <name>Codehaus Snapshots</name>
    <!--如何处理远程仓库里发布版本的下载-->
         <releases>
    <!--true或者false表示该仓库是否为下载某种类型构件（发布版，快照版）开启。  -->
          <enabled>false</enabled>
    <!--该元素指定更新发生的频率。Maven会比较本地POM和远程POM的时间戳。这里的选项是：always（一直），daily（默认，每日），interval：X（这里X是以分钟为单位的时间间隔），或者never（从不）。 -->
          <updatePolicy>always</updatePolicy>
    <!--当Maven验证构件校验文件失败时该怎么做-ignore（忽略），fail（失败），或者warn（警告）。-->
          <checksumPolicy>warn</checksumPolicy>
         </releases>
    <!--如何处理远程仓库里快照版本的下载。有了releases和snapshots这两组配置，POM就可以在每个单独的仓库中，为每种类型的构件采取不同的策略。例如，可能有人会决定只为开发目的开启对快照版本下载的支持。参见repositories/repository/releases元素-->
         <snapshots>
          <enabled/><updatePolicy/><checksumPolicy/>
         </snapshots>
    <!--远程仓库URL，按protocol://hostname/path形式 -->
         <url>http://snapshots.maven.codehaus.org/maven2</url>
    <!--用于定位和排序构件的仓库布局类型-可以是default（默认）或者legacy（遗留）。Maven 2为其仓库提供了一个默认的布局；然而，Maven 1.x有一种不同的布局。我们可以使用该元素指定布局是default（默认）还是legacy（遗留）。 -->
         <layout>default</layout>
        </repository>
       </repositories>
    <!--发现插件的远程仓库列表。仓库是两种主要构件的家。第一种构件被用作其它构件的依赖。这是中央仓库中存储的大部分构件类型。另外一种构件类型是插件。Maven插件是一种特殊类型的构件。由于这个原因，插件仓库独立于其它仓库。pluginRepositories元素的结构和repositories元素的结构类似。每个pluginRepository元素指定一个Maven可以用来寻找新插件的远程地址。-->
       <pluginRepositories>
     <!--包含需要连接到远程插件仓库的信息.参见profiles/profile/repositories/repository元素的说明-->
              <pluginRepository>           
         <releases>      
          <enabled/><updatePolicy/><checksumPolicy/>
         </releases>
         <snapshots>
          <enabled/><updatePolicy/><checksumPolicy/>
         </snapshots>
         <id/><name/><url/><layout/>
              </pluginRepository>
            </pluginRepositories>
      </profile>
     </profiles>

13.activeProfiles

    默认配置：
    <activeProfiles> 
        <activeProfile>dev</activeProfile> 
        <!--    <activeProfile>devitcast</activeProfile>-->
    </activeProfiles>
    配置解释：
    <!--手动激活profiles的列表，按照profile被应用的顺序定义activeProfile。 该元素包含了一组activeProfile元素，每个activeProfile都含有一个profile id。任何在activeProfile中定义的profile id，不论环境设置如何，其对应的profile都会被激活。如果没有匹配的profile，则什么都不会发生。例如，env-test是一个activeProfile，则在pom.xml（或者profile.xml）中对应id的profile会被激活。如果运行过程中找不到这样一个profile，Maven则会像往常一样运行 -->
     <activeProfiles>
        <!-- -->
        <activeProfile>env-test</activeProfile>
     </activeProfiles>
    </settings>

配置示例：

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
  <!-- localRepository
   | The path to the local repository maven will use to store artifacts.
   |
   | Default: $user.home/.m2/repository
  <localRepository>/path/to/local/repo</localRepository>
  -->

  <localRepository>/opt/repository/maven</localRepository>
  <!-- interactiveMode
   | This will determine whether maven prompts you when it needs input. If set to false,
   | maven will use a sensible default value, perhaps based on some other setting, for
   | the parameter in question.
   |
   | Default: true
  <interactiveMode>true</interactiveMode>
  -->

  <!-- offline
   | Determines whether maven should attempt to connect to the network when executing a build.
   | This will have an effect on artifact downloads, artifact deployment, and others.
   |
   | Default: false
  <offline>false</offline>
  -->

  <!-- pluginGroups
   | This is a list of additional group identifiers that will be searched when resolving plugins by their prefix, i.e.
   | when invoking a command line like "mvn prefix:goal". Maven will automatically add the group identifiers
   | "org.apache.maven.plugins" and "org.codehaus.mojo" if these are not already contained in the list.
   |-->
  <pluginGroups>
    <!-- pluginGroup
     | Specifies a further group identifier to use for plugin lookup.
    <pluginGroup>com.your.plugins</pluginGroup>
    -->
  </pluginGroups>

  <!-- proxies
   | This is a list of proxies which can be used on this machine to connect to the network.
   | Unless otherwise specified (by system property or command-line switch), the first proxy
   | specification in this list marked as active will be used.
   |-->
  <proxies>
    <!-- proxy
     | Specification for one proxy, to be used in connecting to the network.
     |
    <proxy>
      <id>optional</id>
      <active>true</active>
      <protocol>http</protocol>
      <username>proxyuser</username>
      <password>proxypass</password>
      <host>proxy.host.net</host>
      <port>80</port>
      <nonProxyHosts>local.net|some.host.com</nonProxyHosts>
    </proxy>
    -->
  </proxies>

  <!-- servers
   | This is a list of authentication profiles, keyed by the server-id used within the system.
   | Authentication profiles can be used whenever maven must make a connection to a remote server.
   |-->
  <servers>
    <!-- server
     | Specifies the authentication information to use when connecting to a particular server, identified by
     | a unique name within the system (referred to by the ‘id‘ attribute below).
     |
     | NOTE: You should either specify username/password OR privateKey/passphrase, since these pairings are
     |       used together.
     |
    <server>
      <id>deploymentRepo</id>
      <username>repouser</username>
      <password>repopwd</password>
    </server>
    -->

    <!-- Another sample, using keys to authenticate.
    <server>
      <id>siteServer</id>
      <privateKey>/path/to/private/key</privateKey>
      <passphrase>optional; leave empty if not used.</passphrase>
    </server>
    -->
 <server>
        <id>nexus</id>
        <username>admin</username>
        <password>admin123</password>
    </server>
    <server>
        <id>releases</id>
        <username>admin</username>
        <password>anonymous123</password>
    </server>
    <server>
        <id>snapshots</id>
        <username>admin</username>
        <password>anonymous123</password>
    </server>
        <server>
            <id>thirdparty</id>
            <username>admin</username>
            <password>anonymous123</password>
        </server>
  </servers>

  <!-- mirrors
   | This is a list of mirrors to be used in downloading artifacts from remote repositories.
   |
   | It works like this: a POM may declare a repository to use in resolving certain artifacts.
   | However, this repository may have problems with heavy traffic at times, so people have mirrored
   | it to several places.
   |
   | That repository definition will have a unique id, so we can create a mirror reference for that
   | repository, to be used as an alternate download site. The mirror site will be the preferred
   | server for that repository.
   |-->
  <mirrors>
    <!-- mirror
     | Specifies a repository mirror site to use instead of a given repository. The repository that
     | this mirror serves has an ID that matches the mirrorOf element of this mirror. IDs are used
     | for inheritance and direct lookup purposes, and must be unique across the set of mirrors.
     |
    <mirror>
      <id>mirrorId</id>
      <mirrorOf>repositoryId</mirrorOf>
      <name>Human Readable Name for this Mirror.</name>
      <url>http://my.repository.com/repo/path</url>
    </mirror>
     -->
        <mirror>
            <id>nexus</id>
            <name>internal nexus repository</name>
            <url>http://10.0.0.241:9999/repository/maven-public/</url> 
            <mirrorOf>*</mirrorOf> 
        </mirror> 
  </mirrors>

  <!-- profiles
   | This is a list of profiles which can be activated in a variety of ways, and which can modify
   | the build process. Profiles provided in the settings.xml are intended to provide local machine-
   | specific paths and repository locations which allow the build to work in the local environment.
   |
   | For example, if you have an integration testing plugin - like cactus - that needs to know where
   | your Tomcat instance is installed, you can provide a variable here such that the variable is
   | dereferenced during the build process to configure the cactus plugin.
   |
   | As noted above, profiles can be activated in a variety of ways. One way - the activeProfiles
   | section of this document (settings.xml) - will be discussed later. Another way essentially
   | relies on the detection of a system property, either matching a particular value for the property,
   | or merely testing its existence. Profiles can also be activated by JDK version prefix, where a
   | value of ‘1.4‘ might activate a profile when the build is executed on a JDK version of ‘1.4.2_07‘.
   | Finally, the list of active profiles can be specified directly from the command line.
   |
   | NOTE: For profiles defined in the settings.xml, you are restricted to specifying only artifact
   |       repositories, plugin repositories, and free-form properties to be used as configuration
   |       variables for plugins in the POM.
   |
   |-->
  <profiles>
    <!-- profile
     | Specifies a set of introductions to the build process, to be activated using one or more of the
     | mechanisms described above. For inheritance purposes, and to activate profiles via <activatedProfiles/>
     | or the command line, profiles have to have an ID that is unique.
     |
     | An encouraged best practice for profile identification is to use a consistent naming convention
     | for profiles, such as ‘env-dev‘, ‘env-test‘, ‘env-production‘, ‘user-jdcasey‘, ‘user-brett‘, etc.
     | This will make it more intuitive to understand what the set of introduced profiles is attempting
     | to accomplish, particularly when you only have a list of profile id‘s for debug.
     |
     | This profile example uses the JDK version to trigger activation, and provides a JDK-specific repo.
    <profile>
      <id>jdk-1.4</id>

      <activation>
        <jdk>1.4</jdk>
      </activation>

      <repositories>
        <repository>
          <id>jdk14</id>
          <name>Repository for JDK 1.4 builds</name>
          <url>http://www.myhost.com/maven/jdk14</url>
          <layout>default</layout>
          <snapshotPolicy>always</snapshotPolicy>
        </repository>
      </repositories>
    </profile>
    -->

    <!--
     | Here is another profile, activated by the system property ‘target-env‘ with a value of ‘dev‘,
     | which provides a specific path to the Tomcat instance. To use this, your plugin configuration
     | might hypothetically look like:
     |
     | ...
     | <plugin>
     |   <groupId>org.myco.myplugins</groupId>
     |   <artifactId>myplugin</artifactId>
     |
     |   <configuration>
     |     <tomcatLocation>$tomcatPath</tomcatLocation>
     |   </configuration>
     | </plugin>
     | ...
     |
     | NOTE: If you just wanted to inject this configuration whenever someone set ‘target-env‘ to
     |       anything, you could just leave off the <value/> inside the activation-property.
     |
    <profile>
      <id>env-dev</id>

      <activation>
        <property>
          <name>target-env</name>
          <value>dev</value>
        </property>
      </activation>

      <properties>
        <tomcatPath>/path/to/tomcat/instance</tomcatPath>
      </properties>
    </profile>
    -->
<profile> 
<id>apatch</id> 
<repositories> 
<repository> 
<id>re-apatch</id> 
<name>remote apatch</name> 
<url>http://inno.starhubdev.com/nexus/content/groups/public/</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>true</enabled> 
</snapshots>
</repository>
</repositories> 
</profile> 
<profile> 
<id>ibiblio</id> 
<repositories> 
<repository> 
<id>re-ibiblio</id> 
<name>remote ibiblio</name> 
<url>https://nexus.sourcesense.com/nexus/content/repositories/public/</url> 
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository> 
</repositories> 
</profile> 
<profile> 
<id>redev</id> 
<repositories> 
<repository> 
<id>re-nexus</id> 
<name>remote nexus</name> 
<url>http://repository.sonatype.org/content/groups/public/</url> 
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository> 
</repositories> 
</profile> 
<profile>
            <id>dev</id>
            <repositories>
                <repository>
                    <id>nexus</id>
                    <url>http://10.0.0.241:9999/nexus/content/groups/public</url>
                    <releases><enabled>true</enabled></releases>
                    <snapshots><enabled>true</enabled></snapshots>
                </repository>
            </repositories>
            <pluginRepositories>
                <pluginRepository>
                    <id>nexus</id>
                    <url>http://10.0.0.241:9999/nexus/content/groups/public</url>
                    <releases><enabled>true</enabled></releases>
                    <snapshots><enabled>true</enabled></snapshots>
                </pluginRepository>
            </pluginRepositories>
    </profile>
  </profiles>
  <!-- activeProfiles
   | List of profiles that are active for all builds.
   |
  <activeProfiles>
    <activeProfile>alwaysActiveProfile</activeProfile>
    <activeProfile>anotherAlwaysActiveProfile</activeProfile>
  </activeProfiles>
  -->
</settings>