本文轉載:https://www.cnblogs.com/jingmoxukong/p/6050172.html 概要 settings.xml有什麼用? 如果在Eclipse中使用過Maven插件,想必會有這個經驗:配置settings.xml文件的路徑。settings.xml文件是乾什麼的,為 ...
本文轉載:https://www.cnblogs.com/jingmoxukong/p/6050172.html
概要
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
作用:當插件的組織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中的標簽都講解完畢,希望對大家有所幫助。