MAVEN简介之——settings.xml
概述
Maven的settings.xml配置了Maven執(zhí)行的方式,像pom.xml一樣,但是它是一個(gè)通用的配置,
不能綁定到任何特殊的項(xiàng)目。它通常包括本地倉(cāng)庫(kù)地址,遠(yuǎn)程倉(cāng)庫(kù)服務(wù),認(rèn)證信息等。
settings.xml存在于兩個(gè)位置:
- maven目錄下的/conf/settings.xml
- 用戶目錄下的/.m2/settings.xml
maven目錄下的稱為全局配置,用戶目錄下的稱為用戶配置。如果兩個(gè)配置都存在,它們的內(nèi)容將合并,有沖突的以用戶配置優(yōu)先。
通常情況下,用戶目錄下的/.m2/settings.xml是不存在的,如果你需要,可以從maven目錄下的/conf/settings.xml復(fù)制過(guò)來(lái)。
maven的默認(rèn)settings模板中,包含了所有的配置的例子,它們都被注釋掉了,如果你需要,可以打開(kāi)注釋,配置你自己的信息。
下面是settings文件的頂層元素:
<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.0https://maven.apache.org/xsd/settings-1.0.0.xsd"><localRepository/><interactiveMode/><usePluginRegistry/><offline/><pluginGroups/><servers/><mirrors/><proxies/><profiles/><activeProfiles/></settings>settings文件中的內(nèi)容可以使用插值替換,例如:
注意:profile中定義的properties不能使用插值
詳細(xì)設(shè)置
簡(jiǎn)單值(simple value)
settings文件中,頂層元素中的一半以上都是簡(jiǎn)單值。接下來(lái)讓我們看一看吧。
<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.0https://maven.apache.org/xsd/settings-1.0.0.xsd"><localRepository>${user.home}/.m2/repository</localRepository><interactiveMode>true</interactiveMode><usePluginRegistry>false</usePluginRegistry><offline>false</offline>... </settings>- localRepository:本地倉(cāng)庫(kù)路徑,默認(rèn)值為:${user.home}/.m2/repository。它允許所有的用戶從這個(gè)公共的本地倉(cāng)庫(kù)構(gòu)建系統(tǒng)。
- interactiveMode:默認(rèn)為true,代表maven是否可以和用戶通過(guò)輸入進(jìn)行交互。
- usePluginRegistry:默認(rèn)為false,maven是否可以使用${user.home}/.m2/plugin-registry.xml管理插件版本。從2.0以后,我們是不需要使用這個(gè)屬性的,可以認(rèn)為它廢棄了。
- offline:默認(rèn)false,構(gòu)建系統(tǒng)是否可以使用離線模式。在不能連接遠(yuǎn)程倉(cāng)庫(kù)的情況下,這個(gè)屬性是非常有用的。
插件組(Plugin Groups)
pluginGroups包含了一組pluginGroup元素,每一個(gè)都包含一個(gè)groupId。當(dāng)你在命令行使用插件,沒(méi)有提供groupId時(shí),maven將搜索這個(gè)列表。
列表默認(rèn)包含org.apache.maven.plugins和org.codehaus.mojo。
例如:我們執(zhí)行org.mortbay.jetty:jetty-maven-plugin:run時(shí),可以使用短命令:mvn jetty:run。
服務(wù)(Servers)
下載和部署的倉(cāng)庫(kù)通常在pom.xml中的repositories和distributionManagement元素中定義,但是像username和password時(shí)不應(yīng)該在
單獨(dú)的pom文件中定義,這種配置信息應(yīng)該在settings中定義。
- id:server的id,它和maven連接的repository或mirror的id匹配。
- username, password:用戶名和密碼,這兩個(gè)元素成對(duì)出現(xiàn)。
- privateKey, passphrase:私鑰文件和私鑰密碼,也是成對(duì)出現(xiàn)。
- filePermissions, directoryPermissions:當(dāng)通過(guò)maven部署到遠(yuǎn)程倉(cāng)庫(kù)的時(shí)候,文件和目錄的權(quán)限通過(guò)這兩個(gè)元素指定。
當(dāng)使用私鑰文件的時(shí)候,不要使用password,要使用passphrase。
鏡像(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.0https://maven.apache.org/xsd/settings-1.0.0.xsd">...<mirrors><mirror><id>planetmirror.com</id><name>PlanetMirror Australia</name><url>http://downloads.planetmirror.com/pub/maven2</url><mirrorOf>central</mirrorOf></mirror></mirrors>... </settings>- id, name:mirror的唯一標(biāo)識(shí)和用戶設(shè)置的別名。當(dāng)連接鏡像需要用戶名密碼或私鑰時(shí),id要和<servers>中配置的id一致。
- url:鏡像的url。構(gòu)建系統(tǒng)時(shí)將使用這個(gè)地址,而不是原始的倉(cāng)庫(kù)地址。
- mirrorOf:倉(cāng)庫(kù)鏡像的id。例如:指向maven的中央倉(cāng)庫(kù)(https://repo.maven.apache.org/maven2/),設(shè)置為center。也可以使用一些高級(jí)的語(yǔ)法:
repo1,repo2 或 *,!inhouse。
代理(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.0https://maven.apache.org/xsd/settings-1.0.0.xsd">...<proxies><proxy><id>myproxy</id><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>- id:proxy的唯一標(biāo)識(shí)。
- active:代理是否有效。多個(gè)代理的情況下,只能有一個(gè)代理有效。
- protocol, host, port:代理的protocol://host:port,分隔成了多個(gè)元素。
- username, password:代理的用戶名和密碼,成對(duì)出現(xiàn)。
- nonProxyHosts:不使用代理的主機(jī)。使用逗號(hào)“,”分隔也可以。
鏡像和代理的區(qū)別:鏡像:改變?cè)嫉膫}(cāng)庫(kù)地址;代理:有些公司是不能上網(wǎng)的,他們需要配置代理才能訪問(wèn)外網(wǎng)。
用戶配置(Profiles)
settings.xml文件中的profile是pom.xml中的刪減版。它由activation, repositories, pluginRepositories 和 properties組成。
而且只包含這4個(gè)元素,因?yàn)閟ettings中的是全局配置,不是單個(gè)項(xiàng)目的配置。
如果settings中的profile是有效的,它將覆蓋掉pom中的相同id的profile。
激活(Activation)
它是profile中的一個(gè)元素,會(huì)在滿足activation的條件時(shí),激活狀態(tài)。
<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.0https://maven.apache.org/xsd/settings-1.0.0.xsd">...<profiles><profile><id>test</id><activation><activeByDefault>false</activeByDefault><jdk>1.5</jdk><os><name>Windows XP</name><family>Windows</family><arch>x86</arch><version>5.1.2600</version></os><property><name>mavenVersion</name><value>2.0.3</value></property><file><exists>${basedir}/file2.properties</exists><missing>${basedir}/file1.properties</missing></file></activation>...</profile></profiles>... </settings>當(dāng)activation的條件滿足時(shí),該profile將激活。
- jdk:activation有一個(gè)內(nèi)嵌的,在jdk元素中已java為中心的檢查。當(dāng)jdk的版本與配置的版本前綴匹配時(shí),這個(gè)profile將被激活。
上面的例子中,jdk的版本1.5.0_06將匹配。范圍配置也是可以的,這里不做詳細(xì)介紹了。 - os:os可以定義一些運(yùn)行系統(tǒng)的特殊屬性。由于比較少用,不做過(guò)多介紹,有興趣的可以查閱官方文檔。
- property:如果maven探測(cè)到一個(gè)屬性(這個(gè)屬性的值可以在pom.xml中配置),它的值與配置的值匹配,這個(gè)profile將被激活。上面的例子中,
mavenVersion=2.0.3時(shí),profile將激活。 - file:existence的文件存在,或者missing的文件不存在,條件將激活。
activation不是profile激活的唯一方式,settings.xml文件中的activeProfile元素包含了一個(gè)profile的id,可以同過(guò)命令行指定這個(gè)id來(lái)
激活profile。例如:-P test,將激活id為test的profile。
屬性(Properties)
maven的屬性是一個(gè)占位符,它可以在pom文件中,通過(guò)${X}進(jìn)行訪問(wèn),X是屬性的名稱。它們有5中不同的形式:
例如:${java.home}。
上面的例子中,如果profile被激活,在pom中可以訪問(wèn)${user.install}。
倉(cāng)庫(kù)(Repositories)
Repositories在這里不是本地倉(cāng)庫(kù)的意思,而是遠(yuǎn)程倉(cāng)庫(kù)的集合。它在本地倉(cāng)庫(kù)配置,maven通過(guò)它從遠(yuǎn)程下載插件或者依賴。
不同的倉(cāng)庫(kù)包含不同的項(xiàng)目,在激活的profile下,它們能被搜索到。
- releases, snapshots:穩(wěn)定版本或快照版本對(duì)應(yīng)的配置。
- enabled:true或者false。對(duì)應(yīng)版本的倉(cāng)庫(kù)是否可用。
- updatePolicy:更新策略。它指定了多長(zhǎng)時(shí)間更新一次,maven經(jīng)常比較本地pom和遠(yuǎn)程pom的時(shí)間戳。它的選項(xiàng)有:always、daily(默認(rèn))、
interval:X(X是分鐘)、never。 - checksumPolicy:當(dāng)maven部署文件到倉(cāng)庫(kù)時(shí),它還會(huì)部署相對(duì)應(yīng)的checksum文件。選項(xiàng)有:ignore, fail, 或 warn,在checksum丟失或不正確的情況下執(zhí)行。
- layout:在上面的配置中,它們都跟隨一個(gè)公共的布局。這在大多數(shù)情況下是正確的。Maven 2有一個(gè)倉(cāng)庫(kù)的默認(rèn)布局,但是maven 1.x有一個(gè)不同的布局。
使用這個(gè)元素可以選擇使用哪個(gè)版本的布局,default 或 legacy。
插件倉(cāng)庫(kù)(Plugin Repositories)
倉(cāng)庫(kù)有兩種主要的類型。第一種是工件作為依賴,常說(shuō)的jar包依賴。第二種是插件,maven的插件是一種特殊類型的工件,正因如此,maven把插件類型的倉(cāng)庫(kù)
單獨(dú)提了出來(lái)。pluginRepositories的元素和repositories的元素非常的相似,它指定一個(gè)遠(yuǎn)程插件倉(cāng)庫(kù)的地址,可以在那里找到相應(yīng)的maven插件。
激活profile(Active Profiles)
<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.0https://maven.apache.org/xsd/settings-1.0.0.xsd">...<activeProfiles><activeProfile>env-test</activeProfile></activeProfiles> </settings>activeProfiles元素包含了activeProfile元素的集合,activeProfile有一個(gè)profile的id值。在activeProfile里定義的id都將被激活。
如果沒(méi)有找到匹配的profile,什么都不會(huì)生效。
好了,maven的settings.xml就為大家介紹的這里,有疑問(wèn)可以隨時(shí)評(píng)論、留言。接下來(lái)還會(huì)介紹maven的pom.xml。
總結(jié)
以上是生活随笔為你收集整理的MAVEN简介之——settings.xml的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: JAVA语言基础-面向对象(IO:IO字
- 下一篇: 12C RAC for ASM添加磁盘步