1. 程式人生 > >maven全域性配置檔案settings.xml詳解

maven全域性配置檔案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
使用者配置: u

ser.home/.m2/settings.xmlnoteuser.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

作用:當外掛的組織id(groupId)沒有顯式提供時,供搜尋外掛組織Id(groupId)的列表。
該元素包含一個pluginGroup元素列表,每個子元素包含了一個組織Id(groupId)。
當我們使用某個外掛,並且沒有在命令列為其提供組織Id(groupId)的時候,Maven就會使用該列表。預設情況下該列表包含了org.apache.maven.pluginsorg.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檔案中的repositoriesdistributionManagement元素中定義的。然而,一般類似使用者名稱、密碼(有些倉庫訪問是需要安全認證的)等資訊不應該在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.xmlprofile元素的裁剪版本
它包含了idactivationrepositoriespluginRepositories和 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元素可以包含profileidprofile也可以通過在命令列,使用-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