Maven中settings.xml的配置項說明

時間 2019-11-13

標籤 maven settings.xml settings xml 配置說明欄目 Maven 简体版

原文原文鏈接

一.Maven的setting配置文件和在Eclipse中對Maven的正確配置。

1.Maven的配置文件（Maven的安裝目錄/conf/settings.xml ）和 Maven倉庫下（默認的Maven倉庫的是用戶家目錄下的.m2文件，能夠另行制定）的settings.xml文件

在Maven中提供了一個settings.xml文件來定義Maven的全局環境信息。這個文件會存在於Maven的安裝目錄的conf子目錄下面，或者是用戶家目錄的.m2子目錄下面。咱們能夠經過這個文件來定義本地倉庫、遠程倉庫和聯網使用的代理信息等。apache

其實相對於多用戶的PC機而言，在Maven安裝目錄的conf子目錄下面的settings.xml纔是真正的全局的配置。而用戶家目錄的.m2子目錄下面的settings.xml的配置只是針對當前用戶的。服務器

當這兩個文件同時存在的時候，那麼對於相同的配置信息用戶家目錄下面的settings.xml中定義的會覆蓋Maven安裝目錄下面的settings.xml中的定義。maven

用戶家目錄下的settings.xml文件通常是不存在的，可是Maven容許咱們在這裏定義咱們本身的settings.xml，若是須要在這裏定義咱們本身的settings.xml的時候就能夠把Maven安裝目錄下面的settings.xml文件拷貝到用戶家目錄的.m2目錄下，而後改爲本身想要的樣子。編輯器

2.在Eclipse中正確的配置Maven（此處個人Maven倉庫由默認的用戶家目錄下的.m2文件改爲了F:\Development\m2\repository）

博客園編輯器對圖片的顯示有壓縮,看高清大圖請點擊:http://images2017.cnblogs.com/blog/610238/201710/610238-20171014114125668-433293838.pngthis

二.settings.xml文件中對應的配置項

先來看看一個基本的settings.xml文件中的內容:（若是使用默認的settings.xml文件不少配置多都註釋掉了,只有一個<localRepository>，此處該settings.xml文件進行了一些其餘配置）url

<?xml version="1.0" encoding="UTF-8"?>
<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>D:\\develop\\mavenRepository</localRepository>
  <interactiveMode>true</interactiveMode>
  <offline>false</offline>
  <pluginGroups>
 
  </pluginGroups>
 
  <proxies>
    <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>
    <server>
      <id>deploymentRepo</id>
      <username>repouser</username>
      <password>repopwd</password>
    </server>
  </servers>
 
  <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>
  </mirrors>
 
  <profiles>
    <profile>
      <id>jdk-1.5</id>
      <activation>
        <jdk>1.5</jdk>
      </activation>
      <repositories>
        <repository>
          <id>jdk15</id>
          <name>jdk1.5</name>
          <url>http://www.myhost.com/maven/jdk15</url>
          <layout>default</layout>
          <snapshotPolicy>always</snapshotPolicy>
        </repository>
      </repositories>
    </profile>
  </profiles>
  <activeProfiles>
    <activeProfile>jdk-1.5</activeProfile>
  </activeProfiles>
</settings>

settings.xml中主要包括如下元素：

1.localRepository：

表示Maven用來在本地儲存信息的本地倉庫的目錄。默認是用戶家目錄下面的.m2/repository目錄。spa

2.interactiveMode：

表示是否使用交互模式，默認是true；若是設爲false，那麼當Maven須要用戶進行輸入的時候，它會使用一個默認值。操作系統

3.offline：

表示是否離線，默認是false。這個屬性表示在Maven進行項目編譯和部署等操做時是否容許Maven進行聯網來下載所須要的信息。.net

4.pluginGroups：

在pluginGroups元素下面能夠定義一系列的pluginGroup元素。表示當經過plugin的前綴來解析plugin的時候到哪裏尋找。pluginGroup元素指定的是plugin的groupId。默認狀況下，Maven會自動把org.apache.maven.plugins和org.codehaus.mojo添加到pluginGroups下。插件

5.proxies：

其下面能夠定義一系列的proxy子元素，表示Maven在進行聯網時須要使用到的代理。當設置了多個代理的時候第一個標記active爲true的代理將會被使用。下面是一個使用代理的例子：

<proxies>
  <proxy>
      <id>xxx</id>
      <active>true</active>
      <protocol>http</protocol>
      <username>用戶名</username>
      <password>密碼</password>
      <host>代理服務器地址</host>
      <port>代理服務器的端口</port>
      <nonProxyHosts>不使用代理的主機</nonProxyHosts>
  </proxy>
</proxies>

6.servers：

其下面能夠定義一系列的server子元素，表示當須要鏈接到一個遠程服務器的時候須要使用到的驗證方式。這主要有username/password和privateKey/passphrase這兩種方式。如下是一個使用servers的示例：

  <servers>
    <server>
      <id>id</id>
      <username>用戶名</username>
      <password>密碼</password>
    </server>
  </servers>

7.mirrors：

用於定義一系列的遠程倉庫的鏡像。咱們能夠在pom中定義一個下載工件的時候所使用的遠程倉庫。可是有時候這個遠程倉庫會比較忙，因此這個時候人們就想着給它建立鏡像以緩解遠程倉庫的壓力，也就是說會把對遠程倉庫的請求轉換到對其鏡像地址的請求。每一個遠程倉庫都會有一個id，這樣咱們就能夠建立本身的mirror來關聯到該倉庫，那麼之後須要從遠程倉庫下載工件的時候Maven就能夠從咱們定義好的mirror站點來下載，這能夠很好的緩解咱們遠程倉庫的壓力。在咱們定義的mirror中每一個遠程倉庫都只能有一個mirror與它關聯，也就是說你不能同時配置多個mirror的mirrorOf指向同一個repositoryId。

看如下是一個使用mirrors的例子：

<mirrors>
    <mirror>
      <id>mirrorId</id>
      <mirrorOf>repositoryId</mirrorOf>
      <name>定義一個容易看懂的名稱 </name>
      <url>http://my.repository.com/repo/path</url>
    </mirror>
</mirrors>

　　1> id：

　　是用來區別mirror的，全部的mirror不能有相同的id

　　2> mirrorOf：

　　　用來表示該mirror是關聯的哪個倉庫，其值爲其關聯倉庫的id。當要同時關聯多個倉庫時，這多個倉庫之間能夠用逗號隔開；當要關聯全部的倉庫時，可使用「*」表示；當要關聯除某一個倉庫之外的其餘全部倉庫時，能夠表示爲「*,!repositoryId」；當要關聯不是localhost或用file請求的倉庫時，能夠表示爲「external:*」。

　　3> url：

　　表示該鏡像的url。當Maven在創建系統的時候就會使用這個url來鏈接到咱們的遠程倉庫。

8.profiles：

用於指定一系列的profile。profile元素由activation、repositories、pluginRepositories和properties四個元素組成。當一個profile在settings.xml中是處於活動狀態而且在pom.xml中定義了一個相同id的profile時，settings.xml中的profile會覆蓋pom.xml中的profile。

　　1> activation：

　　這是profile中最重要的元素。跟pom.xml中的profile同樣，settings.xml中的profile也能夠在特定環境下改變一些值，而這些環境是經過activation元素來指定的。

看下面一個例子：

  <profiles>
    <profile>
      <id>test</id>
      <activation>
        <activeByDefault>false</activeByDefault>
        <jdk>1.6</jdk>
        <os>
          <name>Windows 7</name>
          <family>Windows</family>
          <arch>x86</arch>
          <version>5.1.2600</version>
        </os>
        <property>
          <name>mavenVersion</name>
          <value>2.0.3</value>
        </property>
        <file>
          <exists>${basedir}/file2.properties</exists>
          <missing>${basedir}/file1.properties</missing>
        </file>
      </activation>
      ...
    </profile>
  </profiles>

在上面這段代碼中，當全部的約束條件都知足的時候就會激活這個profile。

jdk：表示當jdk的版本知足條件的時候激活，在這裏是1.6。這裏的版本還能夠用一個範圍來表示，如

<jdk>[1.4,1.7)</jdk>表示1.四、1.5和1.6知足；

<jdk>[1.4,1.7]</jdk>表示1.四、1.五、1.6和1.7知足；

os：表示當操做系統知足條件的時候激活。

property：property是鍵值對的形式，表示當Maven檢測到了這樣一個鍵值對的時候就激活該profile。

①下面的示例表示當存在屬性hello的時候激活該profile。

<property>
       <name>hello</name>
</property>

②下面的示例表示當屬性hello的值爲world的時候激活該profile。

<property>
       <name>hello</name>
       <value>world</value>
</property>

這個時候若是要激活該profile的話，能夠在調用Maven指令的時候加上參數hello並指定其值爲world，如：mvn compile –Dhello=world

　　2>file：

　　表示當文件存在或不存在的時候激活，exists表示存在，missing表示不存在。以下面的例子表示當文件hello/world不存在的時候激活該profile。

<profile>
       <activation>
              <file>
                     <missing>hello/world</missing>
              </file>
       </activation>
</profile>

　　3>activeByDefault：

　　當其值爲true的時候表示若是沒有其餘的profile處於激活狀態的時候，該profile將自動被激活。

　　4>properties：

　　用於定義屬性鍵值對的。當該profile是激活狀態的時候，properties下面指定的屬性均可以在pom.xml中使用。

　　5>repositories：

　　用於定義遠程倉庫的，當該profile是激活狀態的時候，這裏面定義的遠程倉庫將做爲當前pom的遠程倉庫。

      <repositories>
        <repository>
          <id>codehausSnapshots</id>
          <name>Codehaus Snapshots</name>
          <releases>
            <enabled>false</enabled>
            <updatePolicy>always</updatePolicy>
            <checksumPolicy>warn</checksumPolicy>
          </releases>
          <snapshots>
            <enabled>true</enabled>
            <updatePolicy>never</updatePolicy>
            <checksumPolicy>fail</checksumPolicy>
          </snapshots>
          <url>http://snapshots.maven.codehaus.org/maven2</url>
          <layout>default</layout>
        </repository>
      </repositories>

　　releases、snapshots：這是對於工件的類型的限制。

　　enabled：表示這個倉庫是否容許這種類型的工件

　　updatePolicy：表示多久嘗試更新一次。可選值有always、daily、interval:minutes（表示每多久更新一次）和never。

　　checksumPolicy：當Maven在部署項目到倉庫的時候會連同校驗文件一塊兒提交，checksumPolicy表示當這個校驗文件缺失或不正確的時候該如何處理，可選項有ignore、fail和warn。

6>pluginRepositories：

　　在Maven中有兩種類型的倉庫，一種是存儲工件的倉庫，另外一種就是存儲plugin插件的倉庫。pluginRepositories的定義和repositories的定義相似，它表示Maven在哪些地方能夠找到所須要的插件。

9.activeProfiles：

底包含一系列的activeProfile元素，表示對於全部的pom都處於活躍狀態的profile。如：

  <activeProfiles>
    <activeProfile>alwaysActiveProfile</activeProfile>
    <activeProfile>anotherAlwaysActiveProfile</activeProfile>
  </activeProfiles>