# MAVEN簡介之——settings.xml

概述

Maven的settings.xml配置了Maven執(zhí)行的方式首昔,像pom.xml一樣,但是它是一個通用的配置,
不能綁定到任何特殊的項目绎签。它通常包括本地倉庫地址,遠程倉庫服務酝锅,認證信息等诡必。

settings.xml存在于兩個位置:

  • maven目錄下的/conf/settings.xml
  • 用戶目錄下的/.m2/settings.xml

maven目錄下的稱為全局配置,用戶目錄下的稱為用戶配置搔扁。如果兩個配置都存在爸舒,它們的內(nèi)容將合并,有沖突的以用戶配置優(yōu)先稿蹲。
通常情況下扭勉,用戶目錄下的/.m2/settings.xml是不存在的,如果你需要苛聘,可以從maven目錄下的/conf/settings.xml復制過來涂炎。
maven的默認settings模板中,包含了所有的配置的例子设哗,它們都被注釋掉了唱捣,如果你需要,可以打開注釋网梢,配置你自己的信息震缭。

下面是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.0
                          https://maven.apache.org/xsd/settings-1.0.0.xsd">
      <localRepository/>
      <interactiveMode/>
      <usePluginRegistry/>
      <offline/>
      <pluginGroups/>
      <servers/>
      <mirrors/>
      <proxies/>
      <profiles/>
      <activeProfiles/>
    </settings>

settings文件中的內(nèi)容可以使用插值替換,例如:

  1. ${user.home}或者其他的系統(tǒng)屬性(3.0以上)
  2. ${env.HOME}等環(huán)境變量

注意:profile中定義的properties不能使用插值

詳細設置

簡單值(simple value)

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.0
                      https://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:本地倉庫路徑活烙,默認值為:${user.home}/.m2/repository徐裸。它允許所有的用戶從這個公共的本地倉庫構建系統(tǒng)。
  • interactiveMode:默認為true啸盏,代表maven是否可以和用戶通過輸入進行交互重贺。
  • usePluginRegistry:默認為false,maven是否可以使用${user.home}/.m2/plugin-registry.xml管理插件版本回懦。從2.0以后气笙,我們是不需要使用這個屬性的,可以認為它廢棄了怯晕。
  • offline:默認false潜圃,構建系統(tǒng)是否可以使用離線模式。在不能連接遠程倉庫的情況下舟茶,這個屬性是非常有用的谭期。

插件組(Plugin Groups)

pluginGroups包含了一組pluginGroup元素堵第,每一個都包含一個groupId。當你在命令行使用插件隧出,沒有提供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>
    <pluginGroup>org.mortbay.jetty</pluginGroup>
  </pluginGroups>
  ...
</settings>

例如:我們執(zhí)行org.mortbay.jetty:jetty-maven-plugin:run時针余,可以使用短命令:mvn jetty:run

服務(Servers)

下載和部署的倉庫通常在pom.xml中的repositoriesdistributionManagement元素中定義凄诞,但是像usernamepassword時不應該在
單獨的pom文件中定義圆雁,這種配置信息應該在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.0
                      https://maven.apache.org/xsd/settings-1.0.0.xsd">
  ...
  <servers>
    <server>
      <id>server001</id>
      <username>my_login</username>
      <password>my_password</password>
      <privateKey>${user.home}/.ssh/id_dsa</privateKey>
      <passphrase>some_passphrase</passphrase>
      <filePermissions>664</filePermissions>
      <directoryPermissions>775</directoryPermissions>
      <configuration></configuration>
    </server>
  </servers>
  ...
</settings>
  • id:server的id帆谍,它和maven連接的repository或mirror的id匹配伪朽。
  • username, password:用戶名和密碼,這兩個元素成對出現(xiàn)汛蝙。
  • privateKey, passphrase:私鑰文件和私鑰密碼驱负,也是成對出現(xiàn)。
  • filePermissions, directoryPermissions:當通過maven部署到遠程倉庫的時候患雇,文件和目錄的權限通過這兩個元素指定跃脊。

當使用私鑰文件的時候,不要使用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.0
                      https://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的唯一標識和用戶設置的別名。當連接鏡像需要用戶名密碼或私鑰時翠储,id要和<servers>中配置的id一致绘雁。
  • url:鏡像的url。構建系統(tǒng)時將使用這個地址援所,而不是原始的倉庫地址庐舟。
  • mirrorOf:倉庫鏡像的id。例如:指向maven的中央倉庫(https://repo.maven.apache.org/maven2/)住拭,設置為center挪略。也可以使用一些高級的語法:
    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.0
                      https://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的唯一標識滔岳。
  • active:代理是否有效杠娱。多個代理的情況下,只能有一個代理有效谱煤。
  • protocol, host, port:代理的protocol://host:port摊求,分隔成了多個元素。
  • username, password:代理的用戶名和密碼刘离,成對出現(xiàn)室叉。
  • nonProxyHosts:不使用代理的主機睹栖。使用逗號“,”分隔也可以。

鏡像和代理的區(qū)別:鏡像:改變原始的倉庫地址茧痕;代理:有些公司是不能上網(wǎng)的磨淌,他們需要配置代理才能訪問外網(wǎng)。

用戶配置(Profiles)

settings.xml文件中的profilepom.xml中的刪減版凿渊。它由activation, repositories, pluginRepositoriesproperties組成。
而且只包含這4個元素缚柳,因為settings中的是全局配置埃脏,不是單個項目的配置。

如果settings中的profile是有效的秋忙,它將覆蓋掉pom中的相同id的profile彩掐。

激活(Activation)

它是profile中的一個元素,會在滿足activation的條件時灰追,激活狀態(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.0
                      https://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>

activation的條件滿足時,該profile將激活弹澎。

  • jdk:activation有一個內(nèi)嵌的朴下,在jdk元素中已java為中心的檢查。當jdk的版本與配置的版本前綴匹配時苦蒿,這個profile將被激活殴胧。
    上面的例子中牙躺,jdk的版本1.5.0_06將匹配氏涩。范圍配置也是可以的,這里不做詳細介紹了枫虏。
  • os:os可以定義一些運行系統(tǒng)的特殊屬性报强。由于比較少用灸姊,不做過多介紹,有興趣的可以查閱官方文檔秉溉。
  • property:如果maven探測到一個屬性(這個屬性的值可以在pom.xml中配置)力惯,它的值與配置的值匹配,這個profile將被激活召嘶。上面的例子中夯膀,
    mavenVersion=2.0.3時,profile將激活苍蔬。
  • file:existence的文件存在诱建,或者missing的文件不存在,條件將激活碟绑。

activation不是profile激活的唯一方式俺猿,settings.xml文件中的activeProfile元素包含了一個profile的id茎匠,可以同過命令行指定這個id來
激活profile。例如:-P test押袍,將激活id為test的profile诵冒。

屬性(Properties)

maven的屬性是一個占位符,它可以在pom文件中谊惭,通過${X}進行訪問汽馋,X是屬性的名稱。它們有5中不同的形式:

  1. env.X:前綴是一個env圈盔,它將返回系統(tǒng)的環(huán)境變量豹芯。例如:${env.PATH}將返回系統(tǒng)的環(huán)境變量$path。
  2. project.x:訪問pom嗯我那件驱敲,點(.)在pom中代表層級的分隔铁蹈。例如:<project><version>1.0</version></project>可以通過${project.version}訪問。
  3. settings.x:同上众眨,只是訪問的是settings文件握牧。例如:<settings><offline>false</offline></settings>可以通過${settings.offline}訪問。
  4. Java System Properties:java系統(tǒng)屬性娩梨,所有通過java.lang.System.getProperties()可以訪問到的屬性沿腰,在pom文件中都可以訪問。
    例如:${java.home}狈定。
  5. x<properties>元素里配置的屬性矫俺。通過${someVal}訪問。
<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>
      ...
      <properties>
        <user.install>${user.home}/our-project</user.install>
      </properties>
      ...
    </profile>
  </profiles>
  ...
</settings>

上面的例子中掸冤,如果profile被激活厘托,在pom中可以訪問${user.install}

倉庫(Repositories)

Repositories在這里不是本地倉庫的意思稿湿,而是遠程倉庫的集合铅匹。它在本地倉庫配置,maven通過它從遠程下載插件或者依賴饺藤。
不同的倉庫包含不同的項目包斑,在激活的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>
      ...
      <repositories>
        <repository>
          <id>codehausSnapshots</id>
          <name>Codehaus Snapshots</name>
          <releases>
            <enabled>false</enabled>
            <updatePolicy>always</updatePolicy>
            <checksumPolicy>warn</checksumPolicy>
          </releases>
          <snapshots>
            <enabled>true</enabled>
            <updatePolicy>never</updatePolicy>
            <checksumPolicy>fail</checksumPolicy>
          </snapshots>
          <url>http://snapshots.maven.codehaus.org/maven2</url>
          <layout>default</layout>
        </repository>
      </repositories>
      <pluginRepositories>
        ...
      </pluginRepositories>
      ...
    </profile>
  </profiles>
  ...
</settings>
  • releases, snapshots:穩(wěn)定版本或快照版本對應的配置罗丰。
  • enabled:true或者false。對應版本的倉庫是否可用再姑。
  • updatePolicy:更新策略萌抵。它指定了多長時間更新一次,maven經(jīng)常比較本地pom和遠程pom的時間戳。它的選項有:always绍填、daily(默認)霎桅、
    interval:X(X是分鐘)、never讨永。
  • checksumPolicy:當maven部署文件到倉庫時滔驶,它還會部署相對應的checksum文件。選項有:ignore, fail, 或 warn卿闹,在checksum丟失或不正確的情況下執(zhí)行揭糕。
  • layout:在上面的配置中,它們都跟隨一個公共的布局锻霎。這在大多數(shù)情況下是正確的著角。Maven 2有一個倉庫的默認布局,但是maven 1.x有一個不同的布局量窘。
    使用這個元素可以選擇使用哪個版本的布局,defaultlegacy氢拥。

插件倉庫(Plugin Repositories)

倉庫有兩種主要的類型蚌铜。第一種是工件作為依賴,常說的jar包依賴嫩海。第二種是插件冬殃,maven的插件是一種特殊類型的工件,正因如此叁怪,maven把插件類型的倉庫
單獨提了出來审葬。pluginRepositories的元素和repositories的元素非常的相似,它指定一個遠程插件倉庫的地址奕谭,可以在那里找到相應的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.0
                      https://maven.apache.org/xsd/settings-1.0.0.xsd">
  ...
  <activeProfiles>
    <activeProfile>env-test</activeProfile>
  </activeProfiles>
</settings>

activeProfiles元素包含了activeProfile元素的集合,activeProfile有一個profile的id值血柳。在activeProfile里定義的id都將被激活官册。
如果沒有找到匹配的profile,什么都不會生效难捌。

好了膝宁,maven的settings.xml就為大家介紹的這里,有疑問可以隨時評論根吁、留言员淫。接下來還會介紹maven的pom.xml。

?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末击敌,一起剝皮案震驚了整個濱河市介返,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖映皆,帶你破解...
    沈念sama閱讀 211,194評論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件挤聘,死亡現(xiàn)場離奇詭異,居然都是意外死亡捅彻,警方通過查閱死者的電腦和手機组去,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,058評論 2 385
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來步淹,“玉大人从隆,你說我怎么就攤上這事$择桑” “怎么了键闺?”我有些...
    開封第一講書人閱讀 156,780評論 0 346
  • 文/不壞的土叔 我叫張陵,是天一觀的道長澈驼。 經(jīng)常有香客問我辛燥,道長,這世上最難降的妖魔是什么缝其? 我笑而不...
    開封第一講書人閱讀 56,388評論 1 283
  • 正文 為了忘掉前任挎塌,我火速辦了婚禮,結果婚禮上内边,老公的妹妹穿的比我還像新娘榴都。我一直安慰自己,他們只是感情好漠其,可當我...
    茶點故事閱讀 65,430評論 5 384
  • 文/花漫 我一把揭開白布嘴高。 她就那樣靜靜地躺著,像睡著了一般和屎。 火紅的嫁衣襯著肌膚如雪拴驮。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,764評論 1 290
  • 那天柴信,我揣著相機與錄音莹汤,去河邊找鬼。 笑死颠印,一個胖子當著我的面吹牛纲岭,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播线罕,決...
    沈念sama閱讀 38,907評論 3 406
  • 文/蒼蘭香墨 我猛地睜開眼止潮,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了钞楼?” 一聲冷哼從身側響起喇闸,我...
    開封第一講書人閱讀 37,679評論 0 266
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后燃乍,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體唆樊,經(jīng)...
    沈念sama閱讀 44,122評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,459評論 2 325
  • 正文 我和宋清朗相戀三年刻蟹,在試婚紗的時候發(fā)現(xiàn)自己被綠了逗旁。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,605評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡舆瘪,死狀恐怖片效,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情英古,我是刑警寧澤淀衣,帶...
    沈念sama閱讀 34,270評論 4 329
  • 正文 年R本政府宣布,位于F島的核電站召调,受9級特大地震影響膨桥,放射性物質發(fā)生泄漏。R本人自食惡果不足惜唠叛,卻給世界環(huán)境...
    茶點故事閱讀 39,867評論 3 312
  • 文/蒙蒙 一只嚣、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧玻墅,春花似錦介牙、人聲如沸壮虫。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,734評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽囚似。三九已至剩拢,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間饶唤,已是汗流浹背徐伐。 一陣腳步聲響...
    開封第一講書人閱讀 31,961評論 1 265
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留募狂,地道東北人办素。 一個月前我還...
    沈念sama閱讀 46,297評論 2 360
  • 正文 我出身青樓,卻偏偏與公主長得像祸穷,于是被迫代替她去往敵國和親性穿。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 43,472評論 2 348

推薦閱讀更多精彩內(nèi)容

  • 簡介 概述 Maven 是一個項目管理和整合工具 Maven 為開發(fā)者提供了一套完整的構建生命周期框架 Maven...
    閩越布衣閱讀 4,277評論 6 39
  • Spring Cloud為開發(fā)人員提供了快速構建分布式系統(tǒng)中一些常見模式的工具(例如配置管理雷滚,服務發(fā)現(xiàn)需曾,斷路器,智...
    卡卡羅2017閱讀 134,628評論 18 139
  • Spring Boot 參考指南 介紹 轉載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 46,773評論 6 342
  • 概要 settings.xml有什么用? 如果在Eclipse中使用過Maven插件呆万,想必會有這個經(jīng)驗:配置set...
    靜默虛空閱讀 19,376評論 2 32
  • 建立良好的人際關系商源,給孩子創(chuàng)造各種最好的機會,帶孩子參觀博物館谋减,讓孩子上音樂課牡彻,給學校打電話確認孩子是否有個好老師...
    藍石頭的天空閱讀 623評論 0 0