簡單介紹
maven的配置文件settings.xml
存在于兩個地方:
- 安裝的地方:
${M2_HOME}/conf/settings.xml
- 用戶的目錄:
${user.home}/.m2/settings.xml
前者又被叫做全局配置小染,對操作系統(tǒng)的所有使用者生效芋绸;后者被稱為用戶配置,只對當前操作系統(tǒng)的使用者生效。如果兩者都存在今穿,它們的內容將被合并久妆,并且用戶范圍的settings.xml會覆蓋全局的settings.xml卡乾。
Maven安裝后酣胀,用戶目錄下不會自動生成settings.xml,只有全局配置文件全度。如果需要創(chuàng)建用戶范圍的settings.xml煮剧,可以將安裝路徑下的settings復制到目錄${user.home}/.m2/
。Maven默認的settings.xml是一個包含了注釋和例子的模板将鸵,可以快速的修改它來達到你的要求勉盅。
全局配置一旦更改,所有的用戶都會受到影響咨堤,而且如果maven進行升級菇篡,所有的配置都會被清除,所以要提前復制和備份${M2_HOME}/conf/settings.xml
文件一喘,一般情況下不推薦配置全局的settings.xml驱还。
詳細介紹
<?xml version="1.0" encoding="UTF-8"?>
<settings xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
<!--本地倉庫嗜暴。該值表示構建系統(tǒng)本地倉庫的路徑。其默認值為${user.home}/.m2/repository议蟆。 -->
<localRepository>usr/local/maven</localRepository>
<!--Maven是否需要和用戶交互以獲得輸入闷沥。如果Maven需要和用戶交互以獲得輸入,則設置成true咐容,反之則應為false舆逃。默認為true。 -->
<interactiveMode>true</interactiveMode>
<!--Maven是否需要使用plugin-registry.xml文件來管理插件版本戳粒。 -->
<!--如果設置為true路狮,則在{user.home}/.m2下需要有一個plugin-registry.xml來對plugin的版本進行管理 -->
<!--默認為false。 -->
<usePluginRegistry>false</usePluginRegistry>
<!--表示Maven是否需要在離線模式下運行蔚约。如果構建系統(tǒng)需要在離線模式下運行奄妨,則為true,默認為false苹祟。 -->
<!--當由于網(wǎng)絡設置原因或者安全因素砸抛,構建服務器不能連接遠程倉庫的時候,該配置就十分有用树枫。 -->
<offline>false</offline>
<!--當插件的組織Id(groupId)沒有顯式提供時直焙,供搜尋插件組織Id(groupId)的列表。 -->
<!--該元素包含一個pluginGroup元素列表砂轻,每個子元素包含了一個組織Id(groupId)奔誓。 -->
<!--當我們使用某個插件,并且沒有在命令行為其提供組織Id(groupId)的時候舔清,Maven就會使用該列表丝里。 -->
<!--默認情況下該列表包含了org.apache.maven.plugins。 -->
<pluginGroups>
<!--plugin的組織Id(groupId) -->
<pluginGroup>org.codehaus.mojo</pluginGroup>
</pluginGroups>
<!--用來配置不同的代理体谒,多代理profiles可以應對筆記本或移動設備的工作環(huán)境:通過簡單的設置profile id就可以很容易的更換整個代理配置。 -->
<proxies>
<!--代理元素包含配置代理時需要的信息 -->
<proxy>
<!--代理的唯一定義符臼婆,用來區(qū)分不同的代理元素抒痒。 -->
<id>myproxy</id>
<!--該代理是否是激活的那個。true則激活代理颁褂。當我們聲明了一組代理故响,而某個時候只需要激活一個代理的時候,該元素就可以派上用處颁独。 -->
<active>true</active>
<!--代理的協(xié)議彩届。 協(xié)議://主機名:端口,分隔成離散的元素以方便配置誓酒。 -->
<protocol>http://…</protocol>
<!--代理的主機名樟蠕。協(xié)議://主機名:端口贮聂,分隔成離散的元素以方便配置。 -->
<host>proxy.somewhere.com</host>
<!--代理的端口寨辩。協(xié)議://主機名:端口吓懈,分隔成離散的元素以方便配置。 -->
<port>8080</port>
<!--代理的用戶名靡狞,用戶名和密碼表示代理服務器認證的登錄名和密碼耻警。 -->
<username>proxyuser</username>
<!--代理的密碼,用戶名和密碼表示代理服務器認證的登錄名和密碼甸怕。 -->
<password>somepassword</password>
<!--不該被代理的主機名列表甘穿。該列表的分隔符由代理服務器指定;例子中使用了豎線分隔符梢杭,使用逗號分隔也很常見温兼。 -->
<nonProxyHosts>*.google.com|ibiblio.org</nonProxyHosts>
</proxy>
</proxies>
<!--配置服務端的一些設置。一些設置如安全證書不應該和pom.xml一起分發(fā)式曲。這種類型的信息應該存在于構建服務器上的settings.xml文件中妨托。 -->
<servers>
<!--服務器元素包含配置服務器時需要的信息 -->
<server>
<!--這是server的id(注意不是用戶登陸的id),該id與distributionManagement中repository元素的id相匹配吝羞。 -->
<id>server001</id>
<!--鑒權用戶名兰伤。鑒權用戶名和鑒權密碼表示服務器認證所需要的登錄名和密碼。 -->
<username>my_login</username>
<!--鑒權密碼 钧排。鑒權用戶名和鑒權密碼表示服務器認證所需要的登錄名和密碼敦腔。 -->
<password>my_password</password>
<!--鑒權時使用的私鑰位置。和前兩個元素類似恨溜,私鑰位置和私鑰密碼指定了一個私鑰的路徑(默認是/home/hudson/.ssh/id_dsa)以及如果需要的話峡碉,一個密鑰 -->
<!--將來passphrase和password元素可能會被提取到外部,但目前它們必須在settings.xml文件以純文本的形式聲明罗售。 -->
<privateKey>${usr.home}/.ssh/id_dsa</privateKey>
<!--鑒權時使用的私鑰密碼伶棒。 -->
<passphrase>some_passphrase</passphrase>
<!--文件被創(chuàng)建時的權限。如果在部署的時候會創(chuàng)建一個倉庫文件或者目錄项戴,這時候就可以使用權限(permission)形帮。-->
<!--這兩個元素合法的值是一個三位數(shù)字,其對應了unix文件系統(tǒng)的權限周叮,如664辩撑,或者775。 -->
<filePermissions>664</filePermissions>
<!--目錄被創(chuàng)建時的權限仿耽。 -->
<directoryPermissions>775</directoryPermissions>
<!--傳輸層額外的配置項 -->
<configuration></configuration>
</server>
</servers>
<!--為倉庫列表配置的下載鏡像列表合冀。 -->
<mirrors>
<!--給定倉庫的下載鏡像。 -->
<mirror>
<!--該鏡像的唯一標識符项贺。id用來區(qū)分不同的mirror元素君躺。 -->
<id>planetmirror.com</id>
<!--鏡像名稱 -->
<name>PlanetMirror Australia</name>
<!--該鏡像的URL峭判。構建系統(tǒng)會優(yōu)先考慮使用該URL,而非使用默認的服務器URL晰洒。 -->
<url>http://downloads.planetmirror.com/pub/maven2</url>
<!--被鏡像的服務器的id朝抖。例如,如果我們要設置了一個Maven中央倉庫(http://repo1.maven.org/maven2)的鏡像谍珊,-->
<!--就需要將該元素設置成central治宣。這必須和中央倉庫的id central完全一致。 -->
<mirrorOf>central</mirrorOf>
</mirror>
</mirrors>
<!--根據(jù)環(huán)境參數(shù)來調整構建配置的列表砌滞。settings.xml中的profile元素是pom.xml中profile元素的裁剪版本侮邀。-->
<!--它包含了id,activation, repositories, pluginRepositories和 properties元素贝润。-->
<!--這里的profile元素只包含這五個子元素是因為這里只關心構建系統(tǒng)這個整體(這正是settings.xml文件的角色定位)绊茧,而非單獨的項目對象模型設置。-->
<!--如果一個settings中的profile被激活打掘,它的值會覆蓋任何其它定義在POM中或者profile.xml中的帶有相同id的profile华畏。 -->
<profiles>
<!--根據(jù)環(huán)境參數(shù)來調整的構件的配置 -->
<profile>
<!--該配置的唯一標識符。 -->
<id>test</id>
<!--自動觸發(fā)profile的條件邏輯尊蚁。Activation是profile的開啟鑰匙亡笑。-->
<!--如POM中的profile一樣,profile的力量來自于它能夠在某些特定的環(huán)境中自動使用某些特定的值横朋;這些環(huán)境通過activation元素指定仑乌。-->
<!--activation元素并不是激活profile的唯一方式。settings.xml文件中的activeProfile元素可以包含profile的id琴锭。-->
<!--profile也可以通過在命令行晰甚,使用-P標記和逗號分隔的列表來顯式的激活(如,-P test)决帖。 -->
<activation>
<!--profile默認是否激活的標識 -->
<activeByDefault>false</activeByDefault>
<!--activation有一個內建的java版本檢測厕九,如果檢測到jdk版本與期待的一樣,profile被激活地回。 -->
<jdk>1.7</jdk>
<!--當匹配的操作系統(tǒng)屬性被檢測到止剖,profile被激活。os元素可以定義一些操作系統(tǒng)相關的屬性落君。 -->
<os>
<!--激活profile的操作系統(tǒng)的名字 -->
<name>Windows XP</name>
<!--激活profile的操作系統(tǒng)所屬家族(如 'windows') -->
<family>Windows</family>
<!--激活profile的操作系統(tǒng)體系結構 -->
<arch>x86</arch>
<!--激活profile的操作系統(tǒng)版本 -->
<version>5.1.2600</version>
</os>
<!--如果Maven檢測到某一個屬性(其值可以在POM中通過${名稱}引用),其擁有對應的名稱和值亭引,Profile就會被激活绎速。-->
<!--如果值字段是空的,那么存在屬性名稱字段就會激活profile焙蚓,否則按區(qū)分大小寫方式匹配屬性值字段 -->
<property>
<!--激活profile的屬性的名稱 -->
<name>mavenVersion</name>
<!--激活profile的屬性的值 -->
<value>2.0.3</value>
</property>
<!--提供一個文件名纹冤,通過檢測該文件的存在或不存在來激活profile洒宝。missing檢查文件是否存在,如果不存在則激活profile萌京。-->
<!--另一方面雁歌,exists則會檢查文件是否存在,如果存在則激活profile知残。 -->
<file>
<!--如果指定的文件存在靠瞎,則激活profile。 -->
<exists>/usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/</exists>
<!--如果指定的文件不存在求妹,則激活profile乏盐。 -->
<missing>/usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/</missing>
</file>
</activation>
<!--對應profile的擴展屬性列表。Maven屬性和Ant中的屬性一樣制恍,可以用來存放一些值父能。這些值可以在POM中的任何地方使用標記${X}來使用,這里X是指屬性的名稱净神。-->
<!--屬性有五種不同的形式何吝,并且都能在settings.xml文件中訪問。 -->
<!--1. env.X: 在一個變量前加上"env."的前綴鹃唯,會返回一個shell環(huán)境變量爱榕。例如,"env.PATH"指代了$path環(huán)境變量(在Windows上是%PATH%)。 -->
<!--2. project.x:指代了POM中對應的元素值俯渤。 -->
<!--3. settings.x: 指代了settings.xml中對應元素的值呆细。 -->
<!--4. Java System Properties: 所有可通過java.lang.System.getProperties()訪問的屬性都能在POM中使用該形式訪問, -->
<!-- 如/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0/jre八匠。 -->
<!--5. x: 在<properties/>元素中絮爷,或者外部文件中設置,以${someVar}的形式使用梨树。 -->
<properties>
<!-- 如果這個profile被激活坑夯,那么屬性${user.install}就可以被訪問了 -->
<user.install>usr/local/winner/jobs/maven-guide</user.install>
</properties>
<!--遠程倉庫列表,它是Maven用來填充構建系統(tǒng)本地倉庫所使用的一組遠程項目抡四。 -->
<repositories>
<!--包含需要連接到遠程倉庫的信息 -->
<repository>
<!--遠程倉庫唯一標識 -->
<id>codehausSnapshots</id>
<!--遠程倉庫名稱 -->
<name>Codehaus Snapshots</name>
<!--如何處理遠程倉庫里發(fā)布版本的下載 -->
<releases>
<!--true或者false表示該倉庫是否為下載某種類型構件(發(fā)布版,快照版)開啟指巡。 -->
<enabled>false</enabled>
<!--該元素指定更新發(fā)生的頻率。Maven會比較本地POM和遠程POM的時間戳藻雪。這里的選項是:-->
<!--always(一直)秘噪,daily(默認,每日)勉耀,interval:X(這里X是以分鐘為單位的時間間隔)指煎,或者never(從不)蹋偏。 -->
<updatePolicy>always</updatePolicy>
<!--當Maven驗證構件校驗文件失敗時該怎么做:-->
<!--ignore(忽略),fail(失斨寥馈)威始,或者warn(警告)。 -->
<checksumPolicy>warn</checksumPolicy>
</releases>
<!--如何處理遠程倉庫里快照版本的下載像街。有了releases和snapshots這兩組配置黎棠,POM就可以在每個單獨的倉庫中,為每種類型的構件采取不同的策略宅广。-->
<!--例如葫掉,可能有人會決定只為開發(fā)目的開啟對快照版本下載的支持。參見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>
<!--發(fā)現(xiàn)插件的遠程倉庫列表关翎。倉庫是兩種主要構件的家扛门。第一種構件被用作其它構件的依賴。這是中央倉庫中存儲的大部分構件類型纵寝。另外一種構件類型是插件论寨。-->
<!--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>
<!--手動激活profiles的列表火焰,按照profile被應用的順序定義activeProfile。 該元素包含了一組activeProfile元素胧沫,每個activeProfile都含有一個profile id昌简。-->
<!--任何在activeProfile中定義的profile id,不論環(huán)境設置如何绒怨,其對應的 profile都會被激活纯赎。-->
<!--如果沒有匹配的profile,則什么都不會發(fā)生南蹂。例如址否,env-test是一個activeProfile,則在pom.xml(或者profile.xml)中對應id的profile會被激活。-->
<!--如果運行過程中找不到這樣一個profile佑附,Maven則會像往常一樣運行。 -->
<activeProfiles>
<activeProfile>env-test</activeProfile>
</activeProfiles>
</profile>
</profiles>
</settings>
上面的配置文件對各個節(jié)點的含義及作用都有注解仗考。實際應用中音同,經常使用的是
localRepository
、servers
秃嗜、mirrors
权均、profiles
有限幾個節(jié)點,其他節(jié)點使用默認值足夠應對大部分的應用場景锅锨。
profiles
節(jié)點
在倉庫的配置一節(jié)中叽赊,已經對setting.xml中的常用節(jié)點做了詳細的說明。在這里需要特別介紹一下的是<profile>節(jié)點的配置必搞,profile是maven的一個重要特性必指。
<profile>節(jié)點包含了激活(activation),倉庫(repositories)恕洲,插件倉庫(pluginRepositories)和屬性(properties)共四個子元素元素塔橡。profile元素僅包含這四個元素是因為他們涉及到整個的構建系統(tǒng),而不是個別的項目級別的POM配置霜第。
profile可以讓maven能夠自動適應外部的環(huán)境變化葛家,比如同一個項目,在Linux下編譯linux的版本泌类,在win下編譯win的版本等癞谒。一個項目可以設置多個profile,也可以在同一時間設置多個profile被激活(active)的刃榨。自動激活的 profile的條件可以是各種各樣的設定條件弹砚,組合放置在activation節(jié)點中,也可以通過命令行直接指定喇澡。如果認為profile設置比較復雜迅栅,可以將所有的profiles內容移動到專門的 profiles.xml
文件中,不過記得和pom.xml放在一起晴玖。
activation節(jié)點是設置該profile在什么條件下會被激活读存,常見的條件有如下幾個:
- os
判斷操作系統(tǒng)相關的參數(shù),它包含如下可以自由組合的子節(jié)點元素
message - 規(guī)則失敗之后顯示的消息
arch - 匹配cpu結構呕屎,常見為x86
family - 匹配操作系統(tǒng)家族让簿,常見的取值為:dos,mac秀睛,netware尔当,os/2,unix,windows椭迎,win9x锐帜,os/400等
name - 匹配操作系統(tǒng)的名字
version - 匹配的操作系統(tǒng)版本號
display - 檢測到操作系統(tǒng)之后顯示的信息 - jdk
檢查jdk版本,可以用區(qū)間表示畜号。 - property
檢查屬性值缴阎,本節(jié)點可以包含name和value兩個子節(jié)點。 - file
檢查文件相關內容简软,包含兩個子節(jié)點:exists和missing蛮拔,用于分別檢查文件存在和不存在兩種情況。
如果settings中的profile被激活痹升,那么它的值將覆蓋POM或者profiles.xml中的任何相等ID的profiles建炫。
如果想要某個profile默認處于激活狀態(tài),可以在<activeProfiles>中將該profile的id放進去疼蛾。這樣肛跌,不論環(huán)境設置如何,其對應的 profile都會被激活据过。