【Java學習】maven settings.xml配置詳解
目錄
一、概要
1、settings.xml的作用
2、settings.xml檔案位置
3、配置的優先順序
二、settings.xml元素詳解
1、頂級元素概覽
1.1、LocalRepository
1.2、InteractiveMode
1.3、UsePluginRegistry
1.4、Offline
1.5、PluginGroups
1.6、Servers
1.7、Mirrors
1.8、Proxies
1.9、Profiles
1.10、ActiveProfiles
一、概要
1、settings.xml的作用
它是用來設定Maven引數的配置檔案。並且，settings.xml是Maven的全域性配置檔案。settings.xml中包含類似本地倉庫、遠端倉庫和聯網使用的代理資訊等配置。
2、settings.xml檔案位置
settings.xml檔案一般存在於Maven的安裝目錄的conf子目錄下面，或者是使用者目錄的.m2子目錄下面。
3、配置的優先順序
其實相對於多使用者的PC機而言，在Maven安裝目錄的conf子目錄下面的settings.xml才是真正的全域性的配置。而使用者目錄的.m2子目錄下面的settings.xml的配置只是針對當前使用者的。當這兩個檔案同時存在的時候，那麼對於相同的配置資訊使用者目錄下面的settings.xml中定義的會覆蓋Maven安裝目錄下面的settings.xml中的定義。使用者目錄下的settings.xml檔案一般是不存在的，但是Maven允許我們在這裡定義我們自己的settings.xml，如果需要在這裡定義我們自己的settings.xml的時候就可以把Maven安裝目錄下面的settings.xml檔案拷貝到使用者目錄的.m2目錄下，然後改成自己想要的樣子。
二、settings.xml元素詳解
1、頂級元素概覽
<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.1、LocalRepository
作用：該值表示構建系統本地倉庫的路徑。
其預設值：~/.m2/repository。
<localRepository>${user.home}/.m2/repository</localRepository>
1.2、InteractiveMode
作用：表示maven是否需要和使用者互動以獲得輸入。
如果maven需要和使用者互動以獲得輸入，則設定成true，反之則應為false。預設為true。
<interactiveMode>true</interactiveMode>
1.3、UsePluginRegistry
作用：maven是否需要使用plugin-registry.xml檔案來管理外掛版本。
如果需要讓maven使用檔案~/.m2/plugin-registry.xml來管理外掛版本，則設為true。預設為false。
<usePluginRegistry>false</usePluginRegistry>
1.4、Offline
作用：這個屬性表示在Maven進行專案編譯和部署等操作時是否允許Maven進行聯網來下載所需要的資訊。
如果構建系統需要在離線模式下執行，則為true，預設為false。
當由於網路設定原因或者安全因素，構建伺服器不能連線遠端倉庫的時候，該配置就十分有用。
<offline>false</offline>
1.5、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.6、Servers
作用：一般，倉庫的下載和部署是在pom.xml檔案中的repositories和distributionManagement元素中定義的。然而，一般類似使用者名稱、密碼（有些倉庫訪問是需要安全認證的）等資訊不應該在pom.xml檔案中配置，這些資訊可以配置在settings.xml中。
<!--配置服務端的一些設定。一些設定如安全證書不應該和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.7、Mirrors
作用：用於定義一系列的遠端倉庫的映象。我們可以在pom中定義一個下載工件的時候所使用的遠端倉庫。但是有時候這個遠端倉庫會比較忙，所以這個時候人們就想著給它建立映象以緩解遠端倉庫的壓力，也就是說會把對遠端倉庫的請求轉換到對其映象地址的請求。每個遠端倉庫都會有一個id，這樣我們就可以建立自己的mirror來關聯到該倉庫，那麼以後需要從遠端倉庫下載工件的時候Maven就可以從我們定義好的mirror站點來下載，這可以很好的緩解我們遠端倉庫的壓力。在我們定義的mirror中每個遠端倉庫都只能有一個mirror與它關聯，也就是說你不能同時配置多個mirror的mirrorOf指向同一個repositoryId。
<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.8、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.9、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.1、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.4、1.5和1.6滿足；
<jdk>[1.4,1.7]</jdk> 表示1.4、1.5、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.10、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>
<?xml version="1.0" encoding="UTF-8"?> <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 http://maven.apache.org/xsd/settings-1.0.0.xsd"> <!-- 本地倉庫的位置 --> <localRepository>F:\repository</localRepository> <!-- Apache Maven 配置 --> <pluginGroups/> <proxies/> <!-- 私服釋出的使用者名稱密碼 --> <servers> <server> <id>releases</id> <username>deployment</username> <password>He2019</password> </server> <server> <id>snapshots</id> <username>deployment</username> <password>He2019</password> </server> </servers> <!-- 阿里雲映象 --> <mirrors> <mirror> <id>alimaven</id> <name>aliyun maven</name> <!-- https://maven.aliyun.com/repository/public/ --> <url>http://maven.aliyun.com/nexus/content/groups/public/</url> <mirrorOf>central</mirrorOf> </mirror> </mirrors> <!-- 配置: java8, 先從阿里雲下載, 沒有再去私服下載 --> <!-- 20190929 hepengju 測試結果: 影響下載順序的是profiles標籤的配置順序(後面配置的ali倉庫先下載), 而不是activeProfiles的順序 --> <profiles> <!-- 全域性JDK1.8配置 --> <profile> <id>jdk1.8</id> <activation> <activeByDefault>true</activeByDefault> <jdk>1.8</jdk> </activation> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> <maven.compiler.compilerVersion>1.8</maven.compiler.compilerVersion> </properties> </profile> <!-- Nexus私服配置: 第三方jar包下載, 比如oracle的jdbc驅動等 --> <profile> <id>dev</id> <repositories> <repository> <id>nexus</id> <url>http://nexus.hepengju.cn:8081/nexus/content/groups/public/</url> <releases> <enabled>true</enabled> </releases> <snapshots> <enabled>true</enabled> </snapshots> </repository> </repositories> <pluginRepositories> <pluginRepository> <id>public</id> <name>Public Repositories</name> <url>http://nexus.hepengju.cn:8081/nexus/content/groups/public/</url> </pluginRepository> </pluginRepositories> </profile> <!-- 阿里雲配置: 提高國內的jar包下載速度 --> <profile> <id>ali</id> <repositories> <repository> <id>alimaven</id> <name>aliyun maven</name> <url>http://maven.aliyun.com/nexus/content/groups/public/</url> <releases> <enabled>true</enabled> </releases> <snapshots> <enabled>true</enabled> </snapshots> </repository> </repositories> <pluginRepositories> <pluginRepository> <id>alimaven</id> <name>aliyun maven</name> <url>http://maven.aliyun.com/nexus/content/groups/public/</url> </pluginRepository> </pluginRepositories> </profile> </profiles> <!-- 啟用配置 --> <activeProfiles> <activeProfile>jdk1.8</activeProfile> <activeProfile>dev</activeProfile> <activeProfile>ali</activeProfile> </activeProfiles> </settings>View Code