maven配置檔案setting.xml欄位註釋
阿新 • • 發佈:2019-02-02
maven的配置檔案為settings.xml,在下面路徑中可以找到這個檔案,分別為:
- $M2_HOME/conf/settings.xml:全域性設定,在maven的安裝目錄下;
- ${user.home}/.m2/settings.xml:使用者設定,需要使用者手動新增,可以將安裝目錄下的settings.xml檔案拷貝過來修改;
兩個檔案的關係為:如果兩個檔案同時存在,檔案內容將被融合,相同設定將以使用者設定的settings.xml為準。
settings.xml檔案一共有10個配置項,檔案結構為:
- <settingsxmlns="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/>
- <interactiveMode/>
- <usePluginRegistry/>
- <offline/>
- <pluginGroups/>
- <servers/>
- <mirrors/>
- <proxies/>
- <profiles/>
- <activeProfiles/>
- </settings>
簡單屬性
- <settingsxmlns="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>${user.home}/.m2/repository</localRepository>
- <interactiveMode>true</interactiveMode>
- <usePluginRegistry>false</usePluginRegistry>
- <offline>false</offline>
- ...
- </settings>
- localRepository:本地倉庫路徑,預設值 ${user.home}/.m2/repository;
- interactiveMode:值為true/false,true表示mave可以使用使用者輸入,預設true;
- usePluginRegistry:值為true/false,true表示maven使用${user.home}/.m2/plugin-registry.xml管理外掛版本,預設為false;
- offline:值為true/false,true表示構建系統在離線模式下執行,預設為false;
pluginGroups
每個pluginGroup元素都包含一個groupId,當你在命令列中沒有提供外掛的groupid時,將會使用該列表。這個列表自動包含org.apache.maven.plugins和org.codehaus.mojo。
- <pluginGroups>
- <pluginGroup>org.mortbay.jetty</pluginGroup>
- </pluginGroups>
servers
- <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>
- id:伺服器的id,和repository/mirror中配置的id項匹配;
- username,password:伺服器的認證資訊;
- privateKey,passphrase:指定一個路徑到一個私有key(預設為${user.home}/.ssh/id_dsa)和一個passphrase;
- filePermissions,directoryPermissions:設定檔案和資料夾訪問許可權,對應unix檔案許可權值,如:664,後者775.
Mirrors
- <mirrors>
- <mirror>
- <id>planetmirror.com</id>
- <name>PlanetMirror Australia</name>
- <url>http://downloads.planetmirror.com/pub/maven2</url>
- <mirrorOf>central</mirrorOf>
- </mirror>
- </mirrors>
- id,name:映象的唯一標識和使用者友好的名稱;
- url:映象的url,用於代替原始倉庫的url;
- mirrorof:使用映象的倉庫的id,可以使用下面匹配屬性:
------*:匹配所有倉庫id;
------external:*:匹配所有倉庫id,除了那些使用localhost或者基於倉庫的檔案的倉庫;
------多個倉庫id之間用逗號分隔;
------!repol:表示匹配所有倉庫,除了repol;
注意:如果配置了多個倉庫,首先匹配id精確匹配的映象,否則maven使用第一個匹配的映象。
proxies
代理伺服器設定
- <proxy>
- <id>optional</id>
- <active>true</active>
- <protocol>http</protocol>
- <username>proxyuser</username>
- <password>proxypass</password>
- <host>proxy.host.net</host>
- <port>80</port>
- <nonProxyHosts>local.net|some.host.com</nonProxyHosts>
- </proxy>
- id:可選,為代理伺服器設定一個名稱;
- active:true/false,預設true;
- protocol:代理伺服器使用的協議型別;
- username:使用者名稱;
- password:密碼;
- host:主機名,或者ip;
- port:埠號;
- nonProxyHosts:不使用代理伺服器的主機型別,多個主機之間用'|'分隔,可使用萬用字元,如:*.somewhere.com。
profiles
這裡的profile元素是pom.xml的profile元素的一個裁剪版本,它包含activation、repositories、pluginRepositories和properties元素。如果一個在settins中的profile是啟用的,它的值將覆蓋在一個POM或者profiles.xml檔案中的任何相同id的profiles。
- Activation
通過Activation來指定profile生效的環境,具體見下:- <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>
- activeByDefault:是否自動啟用;
- jdk:jdk版本,必須達到該版本後才能執行啟用;
- os:作業系統環境資訊;
- property:當maven探測到一個name=value值對時,profile才被啟用;
- file:檔案exists或者missing可以啟用該profile。
-
Properties
properties中的值可以在一個POM中通過${x}來使用,x比哦是一個property,以下形式在settiongs.xml檔案中都可以使用:- --env.X;表示使用一個環境變數,如:${env.PATH}表示使用PATH環境變數;
- --project.x:標識在POM中的對應元素的值,如:<project><version>1.0</version></project>可以通過${project.version}引用;
- --settings.x:在settins.xml中包含的對應元素的值,如:<settings><offline>false</offline></settings>可以通過${settings.offline}引用;
- --Java System Properties:所有java.lang.System.getProperties()獲取的屬性都是可用的,如:${java.home};
- --x:在<properties/> 中或者一個擴充套件檔案中設定的屬性,如:${someVar};
- <profiles>
- <profile>
- ...
- <properties>
- <user.install>${user.home}/our-project</user.install>
- </properties>
- ...
- </profile>
- </profiles>
- Repositories
倉庫。倉庫是Maven用來填充構建系統本地倉庫所使用的一組遠端專案。而Maven是從本地倉庫中使用其外掛和依賴。不同的遠端倉庫可能含有不同的專案,而在某個啟用的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>
- releases、snapshots:不同的版本策略,對應釋出版本和快照版本;
- enabled:true/false,對應型別是否啟用;
- updatePolicy:更新策略,maven將比較本地POM的時間戳(儲存在倉庫的maven-metadata檔案中)和遠端的,配置選項可以設定:always、daily(一天一次,預設),interval:x(x為一整數,單位分鐘),never;
- checksumPolicy:maven部署檔案到倉庫時,也會部署對應的校驗和檔案,你可以設定:ignore,fail或者warn用於當校驗和檔案不存在或者檢驗失敗時的處理策略;
- layout:上面提到的倉庫大部分都遵循共同的佈局,可以配置:default(預設)或者legacy(遺留);
- pluginRepositories
外掛倉庫。倉庫是兩種主要構件的家。第一種構件被用作其它構件的依賴。這是中央倉庫中儲存大部分構件型別。另外一種構件型別是外掛。Maven外掛是一種特殊型別的構件。由於這個原因,外掛倉庫獨立於其它倉庫。pluginRepositories元素的結構和repositories元素的結構類似。每個pluginRepository元素指定一個Maven可以用來尋找新外掛的遠端地址。 -
activeProfiles
- <activeProfiles>
- <activeProfile>env-test</activeProfile>
- </activeProfiles>