1. 程式人生 > >maven中全域性配置檔案settings.xml及專案pom.xml的詳解完整版

maven中全域性配置檔案settings.xml及專案pom.xml的詳解完整版

maven中全域性配置檔案settings.xml及專案pom.xml的詳解
 

一、apache maven的簡介
 
  Apache Maven,是一個軟體(特別是Java軟體)專案管理及自動構建工具,由Apache軟體基金會所提供。基於專案物件模型(Project Object Model,POM)概念,Maven利用一箇中央資訊片斷能管理一個專案的構建、報告和文件等步驟。
  說得簡單點,maven功能很強大,在maven的專案會很小,但是也能進行和其它大專案一樣的編譯。這就依賴於maven專案在編譯過程中所需要的jar包不在maven專案中,而是在maven的本地倉庫中,maven專案中只指出所需要的jar包的座標,等到需要用時會自動去本地倉庫查詢。如果存在的話就可以直接呼叫,如果不存在,則只需到settings.xml或專案pom.xml配置的中央倉庫中下載到本地倉庫即可。所以不必每次編譯專案時都要準備好所需的jar包,因為本地倉庫中可能早就存在了。
  這樣第一可以減少maven具體專案的大小,只需在具體專案中pom.xml檔案中配置好所有的依賴關係與依賴包的座標即可。第二編譯時下載到本地倉庫的jar包可以下次其它專案編譯時需要相同依賴包時所用,節省了每次都要重新手動下載jar的麻煩。
 
 

二、maven中settings.xml和pom.xml的簡介
 
1、存放位置
  settings.xml是在maven的安裝目錄下的conf目錄中( ${M2_HOME}/conf/ )
  我的電腦上是在D:\apache-maven-3.5.4\conf上,如下圖:

  pom.xml是在每個你需要進行編譯等處理的原始檔

2、settings.xml和pom.xml的作用
  從settings.xml的檔名就可以看出,它是用來設定maven引數的配置檔案。並且,settings.xml是maven的全域性配置檔案。而pom.xml檔案是所在專案的區域性配置。
Settings.xml中包含類似本地倉儲位置、修改遠端倉儲伺服器、認證資訊等配置。
pom.xml包含專案所需的依賴關係及部分配置資訊,如果同時在settings.xml中和pom.xml中都存在的配置項,則以pom.xml為準
具體配置優先順序從高到低:pom.xml > user settings > global settings

三、settings.xml和pom.xml的配置
 
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> ... <localRepository/> <interactiveMode> ... </interactiveMode> <usePluginRegistry> ... </usePluginRegistry> <offline> ... </offline> <pluginGroups> ... </pluginGroups> <servers> ... </servers> <mirrors> ... </mirrors> <proxies> ... </proxies> <profiles> ... </profiles> <activeProfiles> ... </activeProfiles> </settings>

 
 
1、LocalRepository
作用:該值表示構建系統本地倉庫的路徑。
其預設值:
linux中在目錄    ~/.m2/repository,
windows中在目錄   C:\Users\目前使用者.m2\repository

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

 
 
2、InteractiveMode
作用:表示maven是否需要和使用者互動以獲得輸入。
如果maven需要和使用者互動以獲得輸入,則設定成true,反之則應為false。預設為**重點內容**true。

<interactiveMode>true</interactiveMode>

 
 
3、UsePluginRegistry
作用:maven是否需要使用plugin-registry.xml檔案來管理外掛版本。
如果需要讓maven使用檔案~/.m2/plugin-registry.xml來管理外掛版本,則設為true。預設為false。

<usePluginRegistry>false</usePluginRegistry>

 
 
4、Offline
作用:表示maven是否需要在離線模式下執行。
如果構建系統需要在離線模式下執行,則為true,預設為false。
當由於網路設定原因或者安全因素,構建伺服器不能連線遠端倉庫的時候,該配置就十分有用。

<offline>false</offline>

 
 
5、PluginGroups
作用:當外掛的組織id(groupId)沒有顯式提供時,供搜尋外掛組織Id(groupId)的列表。
該元素包含一個pluginGroup元素列表,每個子元素包含了一個組織Id(groupId)。
當我們使用某個外掛,並且沒有在命令列為其提供組織Id(groupId)的時候,Maven就會使用該列表。預設情況下該列表包含了org.apache.maven.plugins和org.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>
    <!--plugin的組織Id(groupId) -->
    <pluginGroup>org.codehaus.mojo</pluginGroup>
  </pluginGroups>
</settings>

 
 
6、Servers
作用:一般,倉庫的下載和部署是在pom.xml檔案中的repositories和distributionManagement元素中定義的。然而,一般類似使用者名稱、密碼(有些倉庫訪問是需要安全認證的)等資訊不應該在pom.xml檔案中配置,這些資訊可以配置在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">
  <!--配置服務端的一些設定。一些設定如安全證書不應該和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>
</settings>

 
 
7、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用來區分不同的mirror元素。 -->
      <id>planetmirror.com</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>central</mirrorOf>
    </mirror>
  </mirrors>
</settings>

 
 
8、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>
      <!--該代理是否是啟用的那個。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>
</settings>

 
 
9、Profiles (重點)
作用:根據環境引數來調整構建配置的列表。
settings.xml中的profile元素是pom.xml中profile元素的裁剪版本。
它包含了id、activation、repositories、pluginRepositories和 properties元素。這裡的profile元素只包含這五個子元素是因為這裡只關心構建系統這個整體(這正是settings.xml檔案的角色定位),而非單獨的專案物件模型設定。如果一個settings.xml中的profile被啟用,它的值會覆蓋任何其它定義在pom.xml中帶有相同id的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>
      <!-- profile的唯一標識 -->
      <id>test</id>
      <!-- 自動觸發profile的條件邏輯 -->
      <activation />
      <!-- 擴充套件屬性列表 -->
      <properties />
      <!-- 遠端倉庫列表 -->
      <repositories />
      <!-- 外掛倉庫列表 -->
      <pluginRepositories />
    </profile>
  </profiles>
</settings>

 
 
(1)   Activation
作用:自動觸發profile的條件邏輯。
如pom.xml中的profile一樣,profile的作用在於它能夠在某些特定的環境中自動使用某些特定的值;這些環境通過activation元素指定。
activation元素並不是啟用profile的唯一方式。settings.xml檔案中的activeProfile元素可以包含profile的id。profile也可以通過在命令列,使用-P標記和逗號分隔的列表來顯式的啟用(如,-P test)。

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

注:在maven工程的pom.xml所在目錄下執行mvn help:active-profiles命令可以檢視中央倉儲的profile是否在工程中生效。
 
 
(2)   properties
作用:對應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>

 
 
(3) Repositories(重點)
作用:遠端倉庫列表,它是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>

 
 
(4) pluginRepositories
作用:發現外掛的遠端倉庫列表。
和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>

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>

  到這裡settings.xml的配置方法己寫完,pom.xml中的配置方法和settings.xml差不多,這裡不做累贅。
 
 
  其中第9中的 profiles 配置詳細說明了profiles內部的具體配置,分成了4小項說明,請大家仔細參考。