侧边栏壁纸
博主头像
Z同学博主等级

工作磨平激情前,坚持技术的热忱。 欢迎光临Z同学的技术小站。 分享最新的互联网知识。

  • 累计撰写 274 篇文章
  • 累计创建 55 个标签
  • 累计收到 74 条评论

Jenkins 配置maven中的settings.xml文件详解,并告诉大家如何创建setting.xml文件。

Z同学
2021-12-30 / 0 评论 / 2 点赞 / 779 阅读 / 7,444 字
温馨提示:
本文最后更新于 2022-01-06,若内容或图片失效,请留言反馈。部分素材来自网络,若不小心影响到您的利益,请联系我们删除。

介绍

我们在各种开发工具中,使用maven库。很少会需要我们配置setting.xml文件。例如AndroidStudio 我们要配置maven默认依赖库(也就是访问镜像仓库)很简单直接在project的build.gradle配置就可以了。

需要什么镜像直接添加就可以了。但是在Jenkins等自动化工具中,我们就没有这个配置了。

那么就会涉及到maven自身的setting.xml文件。而默认情况下很可能是没有setting.xml文件

下面就介绍一下如何自定义自己的jenkins的maven插件的settings.xml。

1./.m2/repository 文件存储setting.xml

我们如果查询网络,都会告诉我们Jenkins中在构建的时候mavne会默认访问用户/.m2/repository文件夹。

那么这个访问说明是在哪定义的呢?

manager jenkins -> Configure System 菜单里面

image-20211230110247718

如果你没有上面的配置项显示,那么说明你缺乏maven插件:在插件管理中搜索:Maven Integration 然后安装即可

安装后的插件如下:

image-20211230110455273

然后我们可以配置maven的编码,例如我是在windows电脑上的。所以我在全局MAVEN_OPTS 中添加了下面的配置

MAVEN_OPTS=-Xms256m -Xmx512m -Dfile.encoding=UTF-8 告诉Jenkins之后在编译的时候采用utf-8的格式避免乱码。

这个时候,我们如果访问本地的repository 文件夹,还是找不到setting.xml文件。

这个时候我们就需要第二个插件:Config File Provider 插件了。

2. 安装Config File Provider Plugin 插件

通过上面的插件名称进行搜索插件,并进行安装就可以了。安装成功后在Manager Jenkis就会有一个新的菜单了

image-20211230111753500

打开Managed files 我们点击左侧的:Add a new Config 创建Config配置文件。创建一个maven setting.xml文件。

image-20211230112030804

然后我们在 Content 中创建配置再执行Submit 保存就可以了。

image-20211230112119514

之后就是关于setting.xml文件的各种配置意义了。

3. setting.xml 标签讲解

首先,maven的安装目录下的conf文件夹下是有setting.xml文件的。但是我们如果在.m2文件夹下创建后。优先级会比安装目录的更高。

setting.xml文件能够干什么呢 ? 它是maven的全局配置文件,可以配置maven仓库的远程服务器,本地缓存仓库地址,网络请求的代理等。操作。

<?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">
  <!-- 表示构建系统本地仓库的路径。| Default: ~/.m2/repository  -->
  <localRepository>/path/to/local/repo</localRepository>
  <!--表示maven是否需要和用户交互以获得输入。
	如果maven需要和用户交互以获得输入,则设置成true,反之则应为false。默认为true。
  -->
  <interactiveMode>true</interactiveMode>

  <!-- 表示在Maven进行项目编译和部署等操作时是否允许Maven进行联网来下载所需要的信息。
如果构建系统需要在离线模式下运行,则为true,默认为false。
当由于网络设置原因或者安全因素,构建服务器不能连接远程仓库的时候,该配置就十分有用。
   -->
  <offline>false</offline>

  <!-- 在元素下面可以定义一系列的pluginGroup元素。表示当通过plugin的前缀来解析plugin的时候到哪里寻找。pluginGroup元素指定的是plugin的groupId。默认情况下,Maven会自动把org.apache.maven.plugins 和 org.codehaus.mojo 添加到pluginGroups下。-->
  <pluginGroups>
    <!-- plugin的组织Id(groupId)-->
    <pluginGroup>com.your.plugins</pluginGroup>
  </pluginGroups>

  <!-- 表示这是可在此机器上用于连接到网络的代理列表。-->
  <proxies>
    <!-- proxy代理元素包含配置代理时需要的信息-->
    <proxy>
        <!--代理的唯一ID,用来区分不同的代理元素。 可以随意定义-->
      <id>optional</id>
        <!--该代理是否是激活的。true则激活代理。如果有多个代理激活,那么排第一个的生效-->
      <active>true</active>
        <!--代理的协议 例如下面的就是http协议 -->
      <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>
  </proxies>

  <!--配置服务端的一些设置。一些设置如安全证书不应该和pom.xml一起分发的配置信息 -->
  <servers>
    <!--例如,链接到服务器上需要的账户密码等数据 -->
    <server>
      <!--这是server的id(注意不是用户登陆的id) -->
      <id>deploymentRepo</id>
        <!--服务器认证所需要的登录名 -->
      <username>repouser</username>
         <!--服务器认证所需要的密码 -->
      <password>repopwd</password>
    </server>
    <!--还有一种情况是使用密钥认证登录而不是密码的。示例如下-->
    <server>
      <id>siteServer</id>
      <privateKey>/path/to/private/key</privateKey>
      <passphrase>optional; leave empty if not used.</passphrase>
    </server>
  </servers>

  <!-- 这是从远程存储库下载依赖库时使用的镜像列表。但是要注意哦,每个id对应一个仓库, 不能重复-->
  <mirrors>
    <!--远程仓库镜像信息 -->
    <mirror>
        <!-- 该镜像的唯一标识符。id用来区分不同的mirror元素。 -->
      <id>mirrorId</id>
        <!-- 被镜像的服务器的id。例如,如果我们要设置了一个Maven中央仓库(http://repo.maven.apache.org/maven2/)的镜像,就需要将该元素设置成central。这必须和中央仓库的id central完全一致。 -->
      <mirrorOf>repositoryId</mirrorOf>
        <!-- 镜像地址的名称 -->
      <name>Human Readable Name for this Mirror.</name>
        <!-- 该镜像的URL路径。构建系统会优先考虑使用该URL,而非使用默认的服务器URL。 -->
      <url>http://my.repository.com/repo/path</url>
    </mirror>
  </mirrors>
  
  <!-- 根据环境参数来调整构建配置的列表。
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不能重复哦-->
      <id>jdk-1.4</id>
        <!-- 自动触发profile的条件逻辑 -->
      <activation>
        <jdk>1.4</jdk>
      </activation>
	  <!-- 远程仓库列表 -->
      <repositories>
        <repository>
             <!-- 远程仓库信息 配置被激活后,远程仓库的地址就会被这个替换 -->
          <id>jdk14</id>
          <name>Repository for JDK 1.4 builds</name>
          <url>http://www.myhost.com/maven/jdk14</url>
          <layout>default</layout>
          <snapshotPolicy>always</snapshotPolicy>
        </repository>
      </repositories>
    </profile>
   

  <!--第二个profile示例-->
 
    <profile>
      <id>env-dev</id>
         <!-- 自动触发profile的条件逻辑 -->
      <activation>
        <property>
            <!--property是键值对的形式,表示当Maven检测到了这样一个键值对的时候就激活该profile。 -->
          <name>target-env</name>
          <value>dev</value>
        </property>
      </activation>
	 <!-- 扩展属性列表 -->
      <properties>
        <tomcatPath>/path/to/tomcat/instance</tomcatPath>
      </properties>
         <!-- 插件仓库列表 -->
     <plugin>
       <groupId>org.myco.myplugins</groupId>
      <artifactId>myplugin</artifactId>
       <configuration>
          <tomcatLocation>${tomcatPath}</tomcatLocation>
       </configuration>
      </plugin>
    </profile>
    -->
  </profiles>

  <!--手动激活profiles的列表,按照profile被应用的顺序定义activeProfile。 -->
  <activeProfiles>
       <!--要激活的ProfileID 手动触发的机制是,不管该配置是否满足激活条件。我都可以手动启动。如果id没有匹配上,没有任何反应 -->
    <activeProfile>alwaysActiveProfile</activeProfile>
    <activeProfile>anotherAlwaysActiveProfile</activeProfile>
  </activeProfiles>

</settings>

3.1 mirrors 配置实例

上面详细介绍了setting.xml的标签后。我们其实更多的是使用mirrors标签配置实例。

例如将默认的国外的镜像地址替换为国内的例如阿里云的仓库等等。

<mirror>
	<id>aliCentral</id>
	<mirrorOf>central</mirrorOf>
	<name>aliyunCentral</name>
	<url>https://maven.aliyun.com/repository/central</url>
</mirror>
<mirror>
	<id>alijcenter</id>
	<mirrorOf>jcenter</mirrorOf>
	<name>aliyunJcenter</name>
	<url>https://maven.aliyun.com/repository/public</url>
</mirror>
<mirror>
	<id>alipublic</id>
	<mirrorOf>public</mirrorOf>
	<name>aliyunJcenter</name>
	<url>https://maven.aliyun.com/repository/public</url>
</mirror>
<mirror>
	<id>aligoogle</id>
	<mirrorOf>google</mirrorOf>
	<name>aliyungoogle</name>
	<url>https://maven.aliyun.com/repository/google</url>
</mirror>      

阿里云镜像仓库:仓库服务 (aliyun.com)

3.2 mirrorOf参数介绍

在我们配置mirror中比较挠头的就是mirrorOf了。我们在网上百度的很多都是使用*号就可以了。但那并不是最好的选择。

mirrorOf 的参数的意义是起到过滤条件的,表达的意思是满足mirrorOf条件的就会使用该mirror的地址去访问远程仓库。

而*号,就代表全部匹配。匹配所有的存储库id。

  • *:匹配一切的库
  • external:*:所有内容不在本地主机上,并且不基于文件。
  • repo,repo1: 存储库或存储库1
  • *,!repo1: 除存储库 1 之外的所有内容

请注意,不要在逗号分隔的列表中在标识符或通配符周围包含额外的空格。

附上官方链接:Maven – 镜像设置指南 (apache.org)

4.配置setting.xml 到jenkins中

使用Config File Provider 插件配置完毕setting之后我们要将该文件配置到jenkins中去。

因为它创建后的setting.xml文件并不是存储在~/m2文件夹里面。

配置方法如下:打开 Global Tool Configuration 文件:Manage Jenkins -> Global Tool Configuration

image-20211230145111075

然后在Maven配置中选择我们创建的配置文档

image-20211230145137952

这种是全局配置,而我们只想给指定的任务使用的话

那么在构造配置界面中,选择 :Provide Configuration files 然后选择文件即可。

image-20211230145311050

内容到这里就结束了。

希望能够给大家带来帮助。

2

评论区