maven的settings.xml配置檔案詳解
阿新 • • 發佈：2018-12-04
一、Settings.xml基本資訊
Settings.xml是maven全域性引數的配置檔案，其中包含本地倉儲位置、遠端倉儲伺服器、認證資訊等等。
settings.xml檔案一般存在於兩個位置：
全域性配置（global settings）: maven安裝目錄/conf/settings.xml
用戶配置（user settings）：C:\Users\使用者名稱\.m2
配置優先順序從高到低：pom.xml> user settings > global settings
二、Settings.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
<!-- 本地倉庫的路徑。預設值為${user.home}/.m2/repository-->
<localRepository>usr/local/maven</localRepository>3、interactiveMode
<!-- Maven是否需要和使用者互動以獲得輸入 如果Maven需要和使用者互動以獲得輸入，則設定成true，反之則應為false 預設為true --> <interactiveMode>true</interactiveMode>
4、usePluginRegistry
<!-- Maven是否需要使用plugin-registry.xml檔案來管理外掛版本
如果需要讓Maven使用檔案${user.home}/.m2/plugin-registry.xml來管理外掛版本
則設為true,否則false
預設為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>
<!--鑑權密碼，鑑權使用者名稱和鑑權密碼錶示伺服器認證所需要的登入名和密碼 -->
<password>my_password</password>
<!--鑑權時使用的私鑰位置，和前兩個元素類似，私鑰位置和私鑰密碼指定了一個私鑰的路徑
（預設是${user.home}/.ssh/id_dsa）-->
<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中的profile被啟用
它的值會覆蓋任何其它定義在POM中或者profile.xml中的帶有相同id的profile -->
<profiles>
<profile>
<!-- profile的唯一標識 -->
<id>test</id>
<!-- 自動觸發profile的條件邏輯 -->
<activation />
<!-- 擴充套件屬性列表 -->
<properties />
<!-- 遠端倉庫列表 -->
<repositories />
<!-- 外掛倉庫列表 -->
<pluginRepositories />
</profile>
</profiles>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、properties
<!-- 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>13、Repositories
<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（遺留）-->
<layout>default</layout>
</repository>
</repositories>
14、pluginRepositories
<!--發現外掛的遠端倉庫列表和repository類似
repository是管理jar包依賴倉庫，pluginRepositories是管理外掛倉庫
maven外掛是一種特殊型別的構件，由於這個原因，外掛倉庫獨立於其它倉庫
每個pluginRepository元素指定一個Maven可以用來尋找新外掛的遠端地址 -->
<pluginRepositories>
<pluginRepository>
<releases>
<enabled />
<updatePolicy />
<checksumPolicy />
</releases>
<snapshots>
<enabled />
<updatePolicy />
<checksumPolicy />
</snapshots>
<id />
<name />
<url />
<layout />
</pluginRepository>
</pluginRepositories>15、ActiveProfiles
<!--手動啟用profiles的列表，按照profile被應用的順序定義activeProfile
該元素包含了一組activeProfile元素，每個activeProfile都含有一個profile id
任何在activeProfile中定義的profile id，不論環境設定如何，其對應的 profile都會被啟用
如果沒有匹配的profile，則什麼都不會發生 -->
<activeProfiles>
<!-- 要啟用的profile id -->
<activeProfile>env-test</activeProfile>
</activeProfiles>16、檢視settings配置是否啟用
dos命令：mvn help:effective-setting