maven全局配置文件settings.xml詳解

目錄

• 概要

•     settings.xml有什麼用

•     settings.xml文件位置

•     配置優先級

• settings.xml元素詳解

•     頂級元素概覽

•     LocalRepository

•     InteractiveMode

•     UsePluginRegistry

•     Offline

•     PluginGroups

•     Servers

•     Mirrors

•     Proxies

•     Profiles

•         Activation

•         properties

•         Repositories

•         pluginRepositories

•     ActiveProfiles

回到頂部

概要

settings.xml有什麼用

若是在Eclipse中使用過Maven插件想必會有這個經驗配置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.xmlnote用戶配置優先於全局配置。user.home/.m2/settings.xmlnote用戶配置優先於全局配置。{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

做用當插件的組織idgroupId沒有顯式提供時供搜尋插件組織IdgroupId的列表。
該元素包含一個pluginGroup元素列表每一個子元素包含了一個組織IdgroupId。
當咱們使用某個插件而且沒有在命令行爲其提供組織IdgroupId的時候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的組織IdgroupId -->
    <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.41.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默認每日intervalX這裏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會被激活。若是運行過程當中找不到這樣一個profileMaven則會像往常同樣運行。

<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中的標籤都講解完畢但願對你們有所幫助。

做者靜默虛空出處http://www.cnblogs.com/jingmoxukong/