Maven setting.xml

時間 2019-11-17

標籤 maven setting.xml setting xml 欄目 Maven 简体版

原文原文鏈接

setting.xml配置文件 maven的配置文件settings.xml存在於兩個地方：html

1.安裝的地方：${M2_HOME}/conf/settings.xmljava

2.用戶的目錄：${user.home}/.m2/settings.xmllinux

前者又被叫作全局配置，對操做系統的全部使用者生效；後者被稱爲用戶配置，只對當前操做系統的使用者生效。若是二者都存在，它們的內容將被合併，而且用戶範圍的settings.xml會覆蓋全局的settings.xml。shell

Maven安裝後，用戶目錄下不會自動生成settings.xml，只有全局配置文件。若是須要建立用戶範圍的settings.xml，能夠將安裝路徑下的settings複製到目錄${user.home}/.m2/。Maven默認的settings.xml是一個包含了註釋和例子的模板，能夠快速的修改它來達到你的要求。apache

全局配置一旦更改，全部的用戶都會受到影響，並且若是maven進行升級，全部的配置都會被清除，因此要提早複製和備份${M2_HOME}/conf/settings.xml文件，通常狀況下不推薦配置全局的settings.xml。windows

<?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">
	  
	<!--本地倉庫。該值表示構建系統本地倉庫的路徑。其默認值爲${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是否須要在離線模式下運行。若是構建系統須要在離線模式下運行，則爲true，默認爲false。  -->
	<!--當因爲網絡設置緣由或者安全因素，構建服務器不能鏈接遠程倉庫的時候，該配置就十分有用。  -->
	<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能夠應對筆記本或移動設備的工做環境：經過簡單的設置profile id就能夠很容易的更換整個代理配置。  -->
	<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>
	  
	<!--配置服務端的一些設置。一些設置如安全證書不該該和pom.xml一塊兒分發。這種類型的信息應該存在於構建服務器上的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>
			  
			<!--文件被建立時的權限。若是在部署的時候會建立一個倉庫文件或者目錄，這時候就可使用權限（permission）。-->
			<!--這兩個元素合法的值是一個三位數字，其對應了unix文件系統的權限，如664，或者775。  -->
			<filePermissions>664</filePermissions>
			  
			<!--目錄被建立時的權限。  -->
			<directoryPermissions>775</directoryPermissions>
			  
			<!--傳輸層額外的配置項  -->
			<configuration></configuration>
			  
		</server>
		 
	</servers>
	  
	<!--爲倉庫列表配置的下載鏡像列表。  -->
	<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://repo1.maven.org/maven2）的鏡像，-->
			<!--就須要將該元素設置成central。這必須和中央倉庫的id central徹底一致。 -->
			<mirrorOf>central</mirrorOf>
			  
		</mirror>
		 
	</mirrors>
	  
	<!--根據環境參數來調整構建配置的列表。settings.xml中的profile元素是pom.xml中profile元素的裁剪版本。-->
	<!--它包含了id，activation, repositories, pluginRepositories和 properties元素。-->
	<!--這裏的profile元素只包含這五個子元素是由於這裏只關心構建系統這個總體（這正是settings.xml文件的角色定位），而非單獨的項目對象模型設置。-->
	<!--若是一個settings中的profile被激活，它的值會覆蓋任何其它定義在POM中或者profile.xml中的帶有相同id的profile。  -->
	<profiles>
		  
		<!--根據環境參數來調整的構件的配置 -->
		<profile>
			  
			<!--該配置的惟一標識符。  -->
			<id>test</id>
			  
			<!--自動觸發profile的條件邏輯。Activation是profile的開啓鑰匙。-->
			<!--如POM中的profile同樣，profile的力量來自於它可以在某些特定的環境中自動使用某些特定的值；這些環境經過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>
				  
				<!--當匹配的操做系統屬性被檢測到，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中經過${名稱}引用），其擁有對應的名稱和值，Profile就會被激活。-->
				<!--若是值字段是空的，那麼存在屬性名稱字段就會激活profile，不然按區分大小寫方式匹配屬性值字段 -->
				<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環境變量。例如,"env.PATH"指代了$path環境變量（在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用來填充構建系統本地倉庫所使用的一組遠程項目。  -->
			<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>
			  
			<!--發現插件的遠程倉庫列表。倉庫是兩種主要構件的家。第一種構件被用做其它構件的依賴。這是中央倉庫中存儲的大部分構件類型。另一種構件類型是插件。-->
			<!--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，不論環境設置如何，其對應的 profile都會被激活。-->
			<!--若是沒有匹配的profile，則什麼都不會發生。例如，env-test是一個activeProfile，則在pom.xml（或者profile.xml）中對應id的profile會被激活。-->
			<!--若是運行過程當中找不到這樣一個profile，Maven則會像往常同樣運行。  -->
			<activeProfiles>
				    
				<activeProfile>env-test</activeProfile>
				   
			</activeProfiles>
			  
		</profile>
		 
	</profiles>
	  
</settings>

複製代碼

上面的配置文件對各個節點的含義及做用都有註解。實際應用中，常用的是<localRepository>、<servers>、<mirrors>、<profiles>有限幾個節點，其餘節點使用默認值足夠應對大部分的應用場景。節點在倉庫的配置一節中，已經對setting.xml中的經常使用節點作了詳細的說明。在這裏須要特別介紹一下的是<profile>節點的配置，profile是maven的一個重要特性。安全

<profile>節點包含了激活activation，倉庫repositories，插件倉庫pluginRepositories和屬性properties共四個子元素元素。profile元素僅包含這四個元素是由於他們涉及到整個的構建系統，而不是個別的項目級別的POM配置。bash

profile可讓maven可以自動適應外部的環境變化，好比同一個項目，在linux下編譯linux的版本，在win下編譯win的版本等。一個項目能夠設置多個profile，也能夠在同一時間設置多個profile被激活（active）的。自動激活的 profile的條件能夠是各類各樣的設定條件，組合放置在activation節點中，也能夠經過命令行直接指定。若是認爲profile設置比較複雜，能夠將全部的profiles內容移動到專門的 profiles.xml 文件中，不過記得和pom.xml放在一塊兒。服務器

activation節點是設置該profile在什麼條件下會被激活，常見的條件有以下幾個：網絡

判斷操做系統相關的參數，它包含以下能夠自由組合的子節點元素

message - 規則失敗以後顯示的消息

arch - 匹配cpu結構，常見爲x86

family - 匹配操做系統家族，常見的取值爲：dos，mac，netware，os/2，unix，windows，win9x，os/400等

name - 匹配操做系統的名字

version - 匹配的操做系統版本號

display - 檢測到操做系統以後顯示的信息

檢查jdk版本，能夠用區間表示。

property

檢查屬性值，本節點能夠包含name和value兩個子節點。

file

檢查文件相關內容，包含兩個子節點：exists和missing，用於分別檢查文件存在和不存在兩種狀況。

若是settings中的profile被激活，那麼它的值將覆蓋POM或者profiles.xml中的任何相等ID的profiles。一個簡單的多環境profiles 配置

<profiles>
        <profile>
            <id>local</id>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
            <properties>
                <profile.name>local</profile.name>
            </properties>
        </profile>
        <profile>
            <id>dev</id>
            <properties>
                <profile.name>dev</profile.name>
            </properties>
        </profile>
        <profile>
            <id>test</id>
            <properties>
                <profile.name>test</profile.name>
            </properties>
        </profile>
        <profile>
            <id>prod</id>
            <properties>
                <profile.name>prod</profile.name>
            </properties>
        </profile>
    </profiles>
複製代碼

若是想要某個profile默認處於激活狀態，能夠在<activeProfiles>中將該profile的id放進去。這樣，不論環境設置如何，其對應的profile都會被激活。 更多激活配置，能夠參考官方的例子：maven.apache.org/guides/intr…

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。