Maven全局配置文件settings.xml詳解

時間  2019-11-07
標籤 maven 全局 配置文件 settings.xml settings xml 詳解 欄目 Maven 简体版
原文   原文鏈接

1、概要

一、settings.xml的做用

它是用來設置Maven參數的配置文件。而且，settings.xml是Maven的全局配置文件。settings.xml中包含相似本地倉庫、遠程倉庫和聯網使用的代理信息等配置。html

二、settings.xml文件位置

settings.xml文件通常存在於Maven的安裝目錄的conf子目錄下面，或者是用戶目錄的.m2子目錄下面。java

三、配置的優先級

其實相對於多用戶的PC機而言，在Maven安裝目錄的conf子目錄下面的settings.xml纔是真正的全局的配置。而用戶目錄的.m2子目錄下面的settings.xml的配置只是針對當前用戶的。當這兩個文件同時存在的時候，那麼對於相同的配置信息用戶目錄下面的settings.xml中定義的會覆蓋Maven安裝目錄下面的settings.xml中的定義。用戶目錄下的settings.xml文件通常是不存在的，可是Maven容許咱們在這裏定義咱們本身的settings.xml，若是須要在這裏定義咱們本身的settings.xml的時候就能夠把Maven安裝目錄下面的settings.xml文件拷貝到用戶目錄的.m2目錄下，而後改爲本身想要的樣子。shell

2、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>

1.一、LocalRepository

做用：該值表示構建系統本地倉庫的路徑。
其默認值：~/.m2/repository。apache

<localRepository>${user.home}/.m2/repository</localRepository>

1.二、InteractiveMode

做用：表示maven是否須要和用戶交互以得到輸入。
若是maven須要和用戶交互以得到輸入，則設置成true，反之則應爲false。默認爲true。windows

<interactiveMode>true</interactiveMode>

1.三、UsePluginRegistry

做用：maven是否須要使用plugin-registry.xml文件來管理插件版本。
若是須要讓maven使用文件~/.m2/plugin-registry.xml來管理插件版本，則設爲true。默認爲false。安全

<usePluginRegistry>false</usePluginRegistry>

1.四、Offline

做用：這個屬性表示在Maven進行項目編譯和部署等操做時是否容許Maven進行聯網來下載所須要的信息。
若是構建系統須要在離線模式下運行，則爲true，默認爲false。
當因爲網絡設置緣由或者安全因素，構建服務器不能鏈接遠程倉庫的時候，該配置就十分有用。服務器

<offline>false</offline>

1.五、PluginGroups

 做用：在pluginGroups元素下面能夠定義一系列的pluginGroup元素。表示當經過plugin的前綴來解析plugin的時候到哪裏尋找。pluginGroup元素指定的是plugin的groupId。默認狀況下，Maven會自動把 org.apache.maven.plugins 和 org.codehaus.mojo 添加到pluginGroups下。網絡

<pluginGroups>
  <!--plugin的組織Id（groupId） -->
  <pluginGroup>org.codehaus.mojo</pluginGroup>
</pluginGroups>

1.六、Servers

做用：通常，倉庫的下載和部署是在pom.xml文件中的 repositories 和 distributionManagement 元素中定義的。然而，通常相似用戶名、密碼（有些倉庫訪問是須要安全認證的）等信息不該該在pom.xml文件中配置，這些信息能夠配置在 settings.xml 中。ssh

  <!--配置服務端的一些設置。一些設置如安全證書不該該和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>

1.七、Mirrors

做用：用於定義一系列的遠程倉庫的鏡像。咱們能夠在pom中定義一個下載工件的時候所使用的遠程倉庫。可是有時候這個遠程倉庫會比較忙，因此這個時候人們就想着給它建立鏡像以緩解遠程倉庫的壓力，也就是說會把對遠程倉庫的請求轉換到對其鏡像地址的請求。每一個遠程倉庫都會有一個id，這樣咱們就能夠建立本身的mirror來關聯到該倉庫，那麼之後須要從遠程倉庫下載工件的時候Maven就能夠從咱們定義好的mirror站點來下載，這能夠很好的緩解咱們遠程倉庫的壓力。在咱們定義的mirror中每一個遠程倉庫都只能有一個mirror與它關聯，也就是說你不能同時配置多個mirror的mirrorOf指向同一個repositoryId。maven

  <mirrors>
    <!-- 給定倉庫的下載鏡像。 -->
    <mirror>
      <!-- 該鏡像的惟一標識符。id用來區分不一樣的mirror元素。 -->
      <id>mirrorId</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>repositoryId</mirrorOf>
    </mirror>
  </mirrors>

1.八、Proxies

做用：用來配置不一樣的代理。

  <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>

1.九、Profiles

做用：根據環境參數來調整構建配置的列表。
settings.xml中的profile元素是pom.xml中profile元素的裁剪版本。它包含了id、activation、repositories、pluginRepositories和 properties元素。這裏的profile元素只包含這五個子元素是由於這裏只關心構建系統這個總體（這正是settings.xml文件的角色定位），而非單獨的項目對象模型設置。若是一個settings.xml中的profile被激活，它的值會覆蓋任何其它定義在pom.xml中帶有相同id的profile。當全部的約束條件都知足的時候就會激活這個profile。

<profiles>
	<profile>
　　<!-- profile的惟一標識 -->
		<id>test</id>      
		<!-- 自動觸發profile的條件邏輯 -->
		<activation>
			<activeByDefault>false</activeByDefault>
			<jdk>1.6</jdk>
			<os>
				<name>Windows 7</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>
		<!-- 擴展屬性列表 -->
		<properties />
		<!-- 遠程倉庫列表 -->
		<repositories />
		<!-- 插件倉庫列表 -->
		<pluginRepositories />
      ...
	</profile>
</profiles>

1.9.一、Activation

做用：自動觸發profile的條件邏輯。這是profile中最重要的元素。跟pom.xml中的profile同樣，settings.xml中的profile也能夠在特定環境下改變一些值，而這些環境是經過activation元素來指定的。activation元素並非激活profile的惟一方式。settings.xml文件中的activeProfile元素能夠包含profile的id。profile也能夠經過在命令行，使用-P標記和逗號分隔的列表來顯式的激活（如，-P test）。
jdk：表示當jdk的版本知足條件的時候激活，在這裏是1.6。這裏的版本還能夠用一個範圍來表示，如　
 <jdk>[1.4,1.7)</jdk>  表示1.四、1.5和1.6知足；
 <jdk>[1.4,1.7]</jdk> 表示1.四、1.五、1.6和1.7知足；
os：表示當操做系統知足條件的時候激活。
property：property是鍵值對的形式，表示當Maven檢測到了這樣一個鍵值對的時候就激活該profile。
(1)下面的示例表示當存在屬性hello的時候激活該profile。

<property>
	<name>hello</name>
</property>

(2)下面的示例表示當屬性hello的值爲world的時候激活該profile。

<property>
	<name>hello</name>
	<value>world</value>
</property>

這個時候若是要激活該profile的話，能夠在調用Maven指令的時候加上參數hello並指定其值爲world，如： mvn compile –Dhello=world 
file：表示當文件存在或不存在的時候激活，exists表示存在，missing表示不存在。以下面例子表示當文件hello/world不存在的時候激活該profile。

<profile>
	<activation>
		<file>
			<missing>hello/world</missing>
		</file>
	</activation>
</profile>

activeByDefault：當其值爲true的時候表示若是沒有其餘的profile處於激活狀態的時候，該profile將自動被激活。
properties：用於定義屬性鍵值對的。當該profile是激活狀態的時候，properties下面指定的屬性均可以在pom.xml中使用。對應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：用於定義遠程倉庫的，當該profile是激活狀態的時候，這裏面定義的遠程倉庫將做爲當前pom的遠程倉庫。它是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>

(1) releases、snapshots：這是對於工件的類型的限制。
(2) enabled：表示這個倉庫是否容許這種類型的工件
(3) updatePolicy：表示多久嘗試更新一次。可選值有always、daily、interval:minutes（表示每多久更新一次）和never。
(4) checksumPolicy：當Maven在部署項目到倉庫的時候會連同校驗文件一塊兒提交，checksumPolicy表示當這個校驗文件缺失或不正確的時候該如何處理，可選項有ignore、fail和warn。
pluginRepositories：在Maven中有兩種類型的倉庫，一種是存儲工件的倉庫，另外一種就是存儲plugin插件的倉庫。pluginRepositories的定義和repositories的定義相似，它表示Maven在哪些地方能夠找到所須要的插件。和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>

 示例：

<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>

1.十、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詳解

二、Angel擠一擠 ---- 【maven】 maven的setting.xml文件的詳解

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程