Maven配置文件

踏雪者
315 阅读2分钟

~~本文已参与「新人创作礼」活动，一起开启掘金创作之路。~~

一、自带的settings文件

我们下载一个maven，在其config目录下，都会有一个settings.xml文件，里面很多英文注释，大家伙能看懂得最好去看那个，否则看这篇就够了。

二、元素说明

一共包含以下几个元素：

  • localRepository：设置本地仓库路径
  • interactiveMode：当Maven需要输入值时，是否由用户输入
  • usePluginRegistry：Maven是否使用plugin-registry.xml文件来管理插件版本，默认为false。3.6.3版本已移除此项。
  • offline：执行构建时，Maven是否处于脱机状态，默认为false
  • pluginGroups：当插件没有提供groupId时，则使用此处配置的groupId，默认包含 org.apache.maven.plugins、org.codehaus.mojo
  • proxies：配置代理，用于多工作环境
  • servers：配置访问远程服务器所需的用户信息，此处多为个人或公司私服的账号信息
  • mirrors：配置镜像仓库
  • profiles：配置远程仓库和其它属性
  • activeProfiles：显示激活profile

详解如下所示：

 <?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">
 ​
     <!-- 设置本地仓库路径，默认值：${user.home}/.m2/repository -->
     <localRepository>D:\IDEA\Maven\repository</localRepository>
 ​
     <!-- 当maven需要输入值时，是否由用户输入，默认为true，当为false时，maven将根据配置信息进行填充 -->
     <interactiveMode>true</interactiveMode>
 ​
     <!-- 执行构建时，Maven是否连接网络进行artifact下载、部署等操作，
          默认为false，即默认联网
          当需要处于离线状态(offline)时，将此值改为true。
      -->
     <offline>false</offline>
 ​
     <!-- 当插件没有提供groupId时，则使用此处配置的groupId，相当于导入了配置此处配置的groupId的所有组件（使用时下载）
           默认包含两个groupId：org.apache.maven.plugins、org.codehaus.mojo
      -->
     <pluginGroups>
         <!-- 默认包含这两个groupId -->
         <!--<pluginGroup>org.apache.maven.plugins</pluginGroup>
         <pluginGroup>org.codehaus.mojo</pluginGroup>-->
     </pluginGroups>
 ​
     <!-- 配置代理，用于多工作环境，通过proxy id即可实现环境切换 -->
     <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>
           <!-- 不被代理服务器代理的主机名/IP,可以使用'|'或','分隔 -->
           <nonProxyHosts>local.net|some.host.com</nonProxyHosts>
         </proxy>
     </proxies>
 ​
     <!-- 配置访问远程服务器所需的用户信息，此处多为个人或公司私服的账号信息 -->
     <servers>
         <server>
             <-- 唯一标识一个server，该id必须与后面的仓库id一致，否则仓库连接不上 -->
             <id>nexus-maven-mirror</id>
             <-- 远程仓库用户名 -->
             <username>admin</username>
             <-- 远程仓库密码 -->
             <password>admin</password>
         </server>
     </servers>
 ​
     <mirrors>
         <!-- 配置多个mirror，当mirrorOf的值相同时，当且仅当上一个远程仓库连接失败才会访问下一个远程仓库，
              连接成功后，即使没有获取想要的jar包，也不会访问下一个远程仓库，故一般配置一个就好，若担心配置的这个镜像会连接失败，可以在加一个
           -->
         <mirror>
           <!-- 唯一标识一个mirror -->
           <id>aliyun-maven-mirror</id>
           <!-- 指定该镜像代替的时那个仓库，例如central就表示代替官方的中央库，*表示所有仓库都是用该镜像，！表示该仓库除外
                <mirrorOf>*, ! central</mirrorOf> 表示所有的远程仓库 central除外，都使用该阿里云镜像
            -->
           <mirrorOf>central</mirrorOf>
           <-- 该镜像库的名称，并无特殊用处 -->
           <name>aliyun Maven</name>
           <-- 代理镜像库的地址 -->
           <url>https://maven.aliyun.com/repository/public</url>
         </mirror>
     </mirrors>
 ​
     <profiles>
 ​
         <!-- settings文件种的profile一共包含5各元素，起作用分别如下：
                 1. id：唯一标识一个profile
                 2. activation：profile激活条件配置
                     另外两种激活方式:settings文件种的activeProfile元素（最后一个元素）指定porfile激活
                                   命令行通过-P和逗号分隔的列表来激活，如mvn clean package -P profile-id
                 3. properties：全局变量设置，一个常见用法就是在此设置jdk版本和编码方式，如下面id为jdk-1.8的profile
                 4. repositories：构件远程仓库列表
                 5. pluginRepositories：插件的远程仓库配置
          -->
 ​
         <!-- 配置maven的jdk版本 -->
         <profile>
             <id>jdk-1.8</id>
             <!-- 下面两个激活项任意一个满足都可激活 -->
             <activation>
                 <!-- 该profile是否默认激活 -->
                 <activeByDefault>true</activeByDefault>
                 <!-- 通过jdk版本前缀来激活当前profile。
                      此处当检测到使用的jdk版本是1.8.xxx，则当前profile被激活，!1.8表示激活所有不是以1.8开头的jdk版本
                   -->
                 <jdk>1.8</jdk>
             </activation>
             <properties>
                 <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>
 ​
         <!-- 配置阿里云Maven -->
         <profile>
             <id>maven-aliyun</id>
             <repositories>
                 <repository>
                     <!-- 唯一标识远程仓库 -->
                     <id>aliyun</id>
                     <name>aliyun maven</name>
                     <url>https://maven.aliyun.com/repository/public</url>
                     <!-- 远程仓库里的发布版本设置 -->
                     <releases>
                         <!-- 是否使用远程仓库的发布版本 -->
                         <enabled>true</enabled>
                         <!-- 更新远程仓库发布版本的频率:always-一直,daily-每日（默认）,interval:X-X分钟,never-从不 -->
                         <updatePolicy>daily</updatePolicy>
                         <!-- maven验证构件检验文件失败时的处理方式:ignore-忽略,fail-失败,warn-警告 -->
                         <checksumPolicy>warn</checksumPolicy>
                     </releases>
                     <!-- 远程仓库里的快照版本设置 -->
                     <snapshots>
                         <enabled>false</enabled>
                         <updatePolicy>always</updatePolicy>
                     </snapshots>
                 </repository>
             </repositories>
         </profile>
 ​
         <!-- 配置私服Maven -->
         <profile>
             <id>maven-nexus</id>
             <repositories>
                 <repository>
                     <!-- 对于私服,需要配置用户密码,故此id必须与上面servers中声明的id一样 -->
                     <id>maven-releases</id>
                     <name>releases</name>
                     <url>http://localhost:8081/repository/maven-releases/</url>
                     <releases><enabled>true</enabled></releases>
                     <snapshots><enabled>true</enabled></snapshots>
                 </repository>
                 <repository>
                     <id>maven-snapshots</id>
                     <name>snapshots</name>
                     <url>http://localhost:8081/repository/maven-snapshots/</url>
                     <releases><enabled>true</enabled></releases>
                     <snapshots><enabled>true</enabled></snapshots>
                 </repository>
             </repositories>
         </profile>
     </profiles>
 ​
     <!-- 手动激活profile -->
     <activeProfiles>
         <!-- activeProfile的属性值就是上面profiles列表种profile的id，若不存在则忽视 -->
         
         <!-- jdk-1.8已经自动激活，故此处无需显示指定激活 -->
         <!--<activeProfile>jdk-1.8</activeProfile>-->
         <activeProfile>maven-aliyun</activeProfile>
         <activeProfile>maven-nexus</activeProfile>
     </activeProfiles>
 </settings>
 ​

三、两种完整的settings文件

这两种的具体区别请走传送门：Maven远程仓库的优先级 里面第四部分总结里的第二点详细说明了两种的区别。

这里的两种方式都是配置一个central的代理镜像和一个私服仓库。

第一种

只配置两种镜像仓库，一个是central的代理镜像，另一个是私服仓库，

 <?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">
 ​
     <!-- 设置本地仓库路径，默认值：${user.home}/.m2/repository -->
     <localRepository>D:\IDEA\Maven\repository</localRepository>
 ​
     <!-- 当maven需要输入值时，是否由用户输入，默认为true，当为false时，maven将根据配置信息进行填充 -->
     <interactiveMode>true</interactiveMode>
 ​
     <!-- 执行构建时，Maven是否连接网络进行artifact下载、部署等操作，
          默认为false，即默认联网
          当需要处于离线状态(offline)时，将此值改为true。
      -->
     <offline>false</offline>
 ​
     <!-- 当插件没有提供groupId时，则使用此处配置的groupId，相当于导入了配置此处配置的groupId的所有组件（使用时下载）
           默认包含两个groupId：org.apache.maven.plugins、org.codehaus.mojo
      -->
     <pluginGroups>
     </pluginGroups>
 ​
     <!-- 配置代理，用于多工作环境，通过proxy id即可实现环境切换 -->
     <proxies>
     </proxies>
 ​
     <!-- 配置访问远程服务器所需的用户信息，此处多为个人或公司私服的账号信息 -->
     <servers>
         <server>
             <id>nexus-maven</id>
             <username>admin</username>
             <password>admin</password>
         </server>
     </servers>
 ​
     <mirrors>
         <!-- 配置多个mirror，当mirrorOf的值相同时，当且仅当上一个远程仓库连接失败才会访问下一个远程仓库，
              连接成功，即使没有获取想要的jar包，也不会访问下一个远程仓库
           -->
         <mirror>
             <!-- 唯一标识一个mirror -->
             <id>aliyun-maven</id>
             <!-- 指定该镜像代替的时那个仓库，例如central就表示代替官方的中央库，*表示所有仓库都是用该镜像，！表示该仓库除外
                 <mirrorOf>*, ! central</mirrorOf> 表示所有的远程仓库 central除外，都使用该阿里云镜像
             -->
             <mirrorOf>central</mirrorOf>
             <name>aliyun Maven</name>
             <url>https://maven.aliyun.com/repository/public</url>
         </mirror>
 ​
         <!-- 个人私服，包含个人上传的一些jar包，当从上面镜像仓库获取不到时从此仓库获取
              注意：此处mirrorOf的值不能与上面相同，上面为central，则此处一般为*
                 mirrors一般这样配置两个就好，若还有其它镜像库，最好在下面的profiles中配置
          -->
         <mirror>
             <id>nexus-maven</id>
             <mirrorOf>*</mirrorOf>
             <name>private maven</name>
             <url>http://localhost:8081/repository/maven-public/</url>
         </mirror>
     </mirrors>
 ​
     <profiles>
         <!-- 配置maven的jdk版本，默认为1.5 -->
         <profile>
             <id>jdk-1.8</id>
             <!-- 下面两个激活项任意一个满足都可激活 -->
             <activation>
                 <!-- 该profile是否默认激活 -->
                 <activeByDefault>true</activeByDefault>
                 <!-- 通过jdk版本前缀来激活当前profile。
                      此处当检测到使用的jdk版本是1.8.xxx，则当前profile被激活，!1.8表示激活所有不是以1.8开头的jdk版本
                   -->
                 <jdk>1.8</jdk>
             </activation>
             <properties>
                 <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>
     </profiles>
 ​
 </settings>
 ​

第二种

mirror仅仅配置central的代理镜像，其它仓库通过settings文件的profile或pom文件来配置。

这种配置就比较灵活，不想第一种，直接配死了，而这种可以通过profile将新仓库地址加进去，然后通过activeProfile灵活激活使用，可扩展性好。

 <?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">
 ​
     <!-- 设置本地仓库路径，默认值：${user.home}/.m2/repository -->
     <localRepository>D:\IDEA\Maven\repository</localRepository>
 ​
     <!-- 当maven需要输入值时，是否由用户输入，默认为true，当为false时，maven将根据配置信息进行填充 -->
     <interactiveMode>true</interactiveMode>
 ​
     <!-- 执行构建时，Maven是否连接网络进行artifact下载、部署等操作，
          默认为false，即默认联网
          当需要处于离线状态(offline)时，将此值改为true。
      -->
     <offline>false</offline>
 ​
     <!-- 当插件没有提供groupId时，则使用此处配置的groupId，相当于导入了配置此处配置的groupId的所有组件（使用时下载）
           默认包含两个groupId：org.apache.maven.plugins、org.codehaus.mojo
      -->
     <pluginGroups>
     </pluginGroups>
 ​
     <!-- 配置代理，用于多工作环境，通过proxy id即可实现环境切换 -->
     <proxies>
     </proxies>
 ​
     <!-- 配置访问远程服务器所需的用户信息，此处多为个人或公司私服的账号信息 -->
     <servers>
 ​
         <server>
             <id>maven-releases</id>
             <username>admin</username>
             <password>admin</password>
         </server>
 ​
         <server>
             <id>maven-snapshots</id>
             <username>admin</username>
             <password>admin</password>
         </server>
     </servers>
 ​
     <mirrors>
         <!-- 配置多个mirror，当mirrorOf的值相同时，当且仅当上一个远程仓库连接失败才会访问下一个远程仓库，
              连接成功后，即使没有获取想要的jar包，也不会访问下一个远程仓库
           -->
         <mirror>
           <!-- 唯一标识一个mirror -->
           <id>aliyun-maven-mirror</id>
           <!-- 指定该镜像代替的时那个仓库，例如central就表示代替官方的中央库，*表示所有仓库都是用该镜像，！表示该仓库除外
                <mirrorOf>*, ! central</mirrorOf> 表示所有的远程仓库 central除外，都使用该阿里云镜像
            -->
           <mirrorOf>central</mirrorOf>
           <name>aliyun Maven</name>
           <url>https://maven.aliyun.com/repository/public</url>
         </mirror>
 ​
     </mirrors>
 ​
     <profiles>
 ​
         <!-- settings文件种的profile一共包含5各元素，起作用分别如下：
                 1. id：唯一标识一个profile
                 2. activation：profile激活条件配置
                     另外两种激活方式:settings文件种的activeProfile元素（最后一个元素）指定porfile激活
                                   命令行通过-P和逗号分隔的列表来激活，如mvn clean package -P profile-id
                 3. properties：全局变量设置，一个常见用法就是在此设置jdk版本和编码方式，如下面id为jdk-1.8的profile
                 4. repositories：构件远程仓库列表
                 5. pluginRepositories：插件的远程仓库配置
          -->
 ​
         <!-- 配置maven的jdk版本 -->
         <profile>
             <id>jdk-1.8</id>
             <!-- 下面两个激活项任意一个满足都可激活 -->
             <activation>
                 <!-- 该profile是否默认激活 -->
                 <activeByDefault>true</activeByDefault>
                 <!-- 通过jdk版本前缀来激活当前profile。
                      此处当检测到使用的jdk版本是1.8.xxx，则当前profile被激活，!1.8表示激活所有不是以1.8开头的jdk版本
                   -->
                 <jdk>1.8</jdk>
             </activation>
             <properties>
                 <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>
 ​
         <!-- 配置阿里云Maven -->
         <profile>
             <id>maven-aliyun</id>
             <repositories>
                 <repository>
                     <!-- 唯一标识远程仓库 -->
                     <id>aliyun</id>
                     <name>aliyun maven</name>
                     <url>https://maven.aliyun.com/repository/public</url>
                     <!-- 远程仓库里的发布版本设置 -->
                     <releases>
                         <!-- 是否使用远程仓库的发布版本 -->
                         <enabled>true</enabled>
                         <!-- 更新远程仓库发布版本的频率:always-一直,daily-每日（默认）,interval:X-X分钟,never-从不 -->
                         <updatePolicy>daily</updatePolicy>
                         <!-- maven验证构件检验文件失败时的处理方式:ignore-忽略,fail-失败,warn-警告 -->
                         <checksumPolicy>warn</checksumPolicy>
                     </releases>
                     <!-- 远程仓库里的快照版本设置 -->
                     <snapshots>
                         <enabled>false</enabled>
                         <updatePolicy>always</updatePolicy>
                     </snapshots>
                 </repository>
             </repositories>
         </profile>
 ​
         <!-- 配置私服Maven -->
         <profile>
             <id>maven-nexus</id>
             <repositories>
                 <repository>
                     <!-- 对于私服,需要配置用户密码,故此id必须与上面servers中声明的id一样 -->
                     <id>maven-releases</id>
                     <name>releases</name>
                     <url>http://localhost:8081/repository/maven-releases/</url>
                     <releases><enabled>true</enabled></releases>
                     <snapshots><enabled>true</enabled></snapshots>
                 </repository>
                 <repository>
                     <id>maven-snapshots</id>
                     <name>snapshots</name>
                     <url>http://localhost:8081/repository/maven-snapshots/</url>
                     <releases><enabled>true</enabled></releases>
                     <snapshots><enabled>true</enabled></snapshots>
                 </repository>
             </repositories>
         </profile>
     </profiles>
 ​
     <!-- 手动激活profile -->
     <activeProfiles>
         <!-- activeProfile的属性值就是上面profiles列表种profile的id，若不存在则忽视 -->
         
         <!-- jdk-1.8已经自动激活，故此处无需显示指定激活 -->
         <!--<activeProfile>jdk-1.8</activeProfile>-->
         <activeProfile>maven-aliyun</activeProfile>
         <activeProfile>maven-nexus</activeProfile>
     </activeProfiles>
 </settings>
 ​
avatar
文章
阅读
粉丝