概要

settings.xml有什麼用？

如果在Eclipse中使用過Maven插件，想必會有這個經驗：配置settings.xml檔案的路徑。

maven全局配置檔案settings.xml詳解概要settings.xml元素詳解更多閱讀

settings.xml檔案是幹什麼的，為什麼要配置它呢？

從settings.xml的檔案名就可以看出，它是用來設定maven參數的配置檔案。并且，settings.xml是maven的全局配置檔案。而pom.xml檔案是所在項目的局部配置。

Settings.xml中包含類似本地倉儲位置、修改遠端倉儲伺服器、認證資訊等配置。

settings.xml檔案位置

settings.xml檔案一般存在于兩個位置：

全局配置: ${M2_HOME}/conf/settings.xml

使用者配置: ${user.home}/.m2/settings.xml note：使用者配置優先于全局配置。${user.home} 和和所有其他系統屬性隻能在3.0+版本上使用。請注意windows和Linux使用變量的差別。

配置優先級

需要注意的是：局部配置優先于全局配置。

配置優先級從高到低：pom.xml> user settings > global settings

如果這些檔案同時存在，在應用配置時，會合并它們的内容，如果有重複的配置，優先級高的配置會覆寫優先級低的。

settings.xml元素詳解

頂級元素概覽

下面列舉了

settings.xml

中的頂級元素

<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
                          https://maven.apache.org/xsd/settings-1.0.0.xsd">
  <localRepository/>
  <interactiveMode/>
  <usePluginRegistry/>
  <offline/>
  <pluginGroups/>
  <servers/>
  <mirrors/>
  <proxies/>
  <profiles/>
  <activeProfiles/>
</settings>

LocalRepository

作用：該值表示建構系統本地倉庫的路徑。

其預設值：~/.m2/repository。

<localRepository>${user.home}/.m2/repository</localRepository>

InteractiveMode

作用：表示maven是否需要和使用者互動以獲得輸入。

如果maven需要和使用者互動以獲得輸入，則設定成true，反之則應為false。預設為true。

<interactiveMode>true</interactiveMode>

UsePluginRegistry

作用：maven是否需要使用plugin-registry.xml檔案來管理插件版本。

如果需要讓maven使用檔案~/.m2/plugin-registry.xml來管理插件版本，則設為true。預設為false。

<usePluginRegistry>false</usePluginRegistry>

Offline

作用：表示maven是否需要在離線模式下運作。

如果建構系統需要在離線模式下運作，則為true，預設為false。

當由于網絡設定原因或者安全因素，建構伺服器不能連接配接遠端倉庫的時候，該配置就十分有用。

<offline>false</offline>

PluginGroups

作用：當插件的組織id（groupId）沒有顯式提供時，供搜尋插件組織Id（groupId）的清單。

該元素包含一個pluginGroup元素清單，每個子元素包含了一個組織Id（groupId）。

當我們使用某個插件，并且沒有在指令行為其提供組織Id（groupId）的時候，Maven就會使用該清單。預設情況下該清單包含了

org.apache.maven.plugins

和

org.codehaus.mojo

。

<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
                      https://maven.apache.org/xsd/settings-1.0.0.xsd">
  ...
  <pluginGroups>
    <!--plugin的組織Id（groupId） -->
    <pluginGroup>org.codehaus.mojo</pluginGroup>
  </pluginGroups>
  ...
</settings>

Servers

作用：一般，倉庫的下載下傳和部署是在pom.xml檔案中的

repositories

distributionManagement

元素中定義的。然而，一般類似使用者名、密碼（有些倉庫通路是需要安全認證的）等資訊不應該在pom.xml檔案中配置，這些資訊可以配置在

settings.xml

中。

<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
                      https://maven.apache.org/xsd/settings-1.0.0.xsd">
  ...
  <!--配置服務端的一些設定。一些設定如安全證書不應該和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>
  ...
</settings>

Mirrors

作用：為倉庫清單配置的下載下傳鏡像清單。

<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
                      https://maven.apache.org/xsd/settings-1.0.0.xsd">
  ...
  <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>
  ...
</settings>

Proxies

作用：用來配置不同的代理。

<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
                      https://maven.apache.org/xsd/settings-1.0.0.xsd">
  ...
  <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>
  ...
</settings>

Profiles

作用：根據環境參數來調整建構配置的清單。

settings.xml

中的

profile

元素是

pom.xml

中

profile

元素的裁剪版本。

它包含了

id

、

activation

repositories

pluginRepositories

properties

元素。這裡的profile元素隻包含這五個子元素是因為這裡隻關心建構系統這個整體（這正是settings.xml檔案的角色定位），而非單獨的項目對象模型設定。如果一個

settings.xml

profile

被激活，它的值會覆寫任何其它定義在

pom.xml

中帶有相同id的

profile

<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
                      https://maven.apache.org/xsd/settings-1.0.0.xsd">
  ...
  <profiles>
    <profile>
      <!-- profile的唯一辨別 -->
      <id>test</id>
      <!-- 自動觸發profile的條件邏輯 -->
      <activation />
      <!-- 擴充屬性清單 -->
      <properties />
      <!-- 遠端倉庫清單 -->
      <repositories />
      <!-- 插件倉庫清單 -->
      <pluginRepositories />
    </profile>
  </profiles>
  ...
</settings>

Activation

作用：自動觸發

profile

的條件邏輯。

如

pom.xml

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>

注：在maven工程的pom.xml所在目錄下執行

mvn help:active-profiles

指令可以檢視中央倉儲的profile是否在工程中生效。

properties

作用：對應

profile

的擴充屬性清單。

maven屬性和ant中的屬性一樣，可以用來存放一些值。這些值可以在

pom.xml

中的任何地方使用标記

${X}

來使用，這裡X是指屬性的名稱。屬性有五種不同的形式，并且都能在settings.xml檔案中通路。

<!-- 
  1. env.X: 在一個變量前加上"env."的字首，會傳回一個shell環境變量。例如,"env.PATH"指代了$path環境變量（在Windows上是%PATH%）。 
  2. project.x：指代了POM中對應的元素值。例如: <project><version>1.0</version></project>通過${project.version}獲得version的值。 
  3. settings.x: 指代了settings.xml中對應元素的值。例如：<settings><offline>false</offline></settings>通過 ${settings.offline}獲得offline的值。 
  4. Java System Properties: 所有可通過java.lang.System.getProperties()通路的屬性都能在POM中使用該形式通路，例如 ${java.home}。 
  5. x: 在<properties/>元素中，或者外部檔案中設定，以${someVar}的形式使用。
 -->
<properties>
  <user.install>${user.home}/our-project</user.install>
</properties>

注：如果該profile被激活，則可以在

pom.xml

中使用${user.install}。

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>

pluginRepositories

作用：發現插件的遠端倉庫清單。

repository

類似，隻是

repository

是管理jar包依賴的倉庫，

pluginRepositories

則是管理插件的倉庫。

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>

ActiveProfiles

作用：手動激活profiles的清單，按照

profile

被應用的順序定義

activeProfile

該元素包含了一組

activeProfile

元素，每個

activeProfile

都含有一個profile id。任何在

activeProfile

中定義的profile id，不論環境設定如何，其對應的

profile

都會被激活。如果沒有比對的

profile

，則什麼都不會發生。

例如，env-test是一個activeProfile，則在pom.xml（或者profile.xml）中對應id的profile會被激活。如果運作過程中找不到這樣一個profile，Maven則會像往常一樣運作。

<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
                      https://maven.apache.org/xsd/settings-1.0.0.xsd">
  ...
  <activeProfiles>
    <!-- 要激活的profile id -->
    <activeProfile>env-test</activeProfile>
  </activeProfiles>
  ...
</settings>

至此，maven settings.xml中的标簽都講解完畢，希望對大家有所幫助。

maven全局配置檔案settings.xml詳解概要settings.xml元素詳解更多閱讀

概要

settings.xml有什麼用？

settings.xml檔案位置

配置優先級

settings.xml元素詳解

頂級元素概覽

LocalRepository

InteractiveMode

UsePluginRegistry

Offline

PluginGroups

Servers

Mirrors

Proxies

Profiles

Activation

properties

Repositories

pluginRepositories

ActiveProfiles

更多閱讀

繼續閱讀

配置apache支援PHP（win7）

27 Best Free Eclipse Plug-ins for Java Developer to be ProductiveCode Quality PluginsText Editor PluginsDependency ManagementVersion Control Integration PluginsFramework Development Continuous Integration Related PluginsOther Utility Plugins

Java String.format方法的簡單使用

neo4j之cypher使用文檔

GitHub連夜封殺！這份阿裡 10W 字内部 Java 字面試手冊到底有多強？

spark/scala關于【資源檔案】加載方法概述外部檔案加載方案測試資源檔案打包入jar包中小結

mybatis_入門程式Mybatis入門

maven No compiler is provided in this environment. Perhaps you are running on a JRE rather than a J

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

Effective Java 8:通用程式設計

OOM三種類型

工廠模式-三種類型

【遞歸】高效率求2的n次幂

win10本地scala和spark安裝安裝scala安裝spark

scala (3) Function 和 Method

Opendaylight課堂之深度剖析toaster（一）